list method

Future<CommentList> list(
  1. String blogId,
  2. String postId, {
  3. String? endDate,
  4. bool? fetchBodies,
  5. int? maxResults,
  6. String? pageToken,
  7. String? startDate,
  8. String? status,
  9. String? view,
  10. String? $fields,
})

Lists comments.

Request parameters:

blogId - null

postId - null

endDate - null

fetchBodies - null

maxResults - null

pageToken - null

startDate - null

status - null Possible string values are:

  • "LIVE"
  • "EMPTIED"
  • "PENDING"
  • "SPAM"

view - null Possible string values are:

  • "VIEW_TYPE_UNSPECIFIED"
  • "READER"
  • "AUTHOR"
  • "ADMIN"

$fields - Selector specifying which fields to include in a partial response.

Completes with a CommentList.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<CommentList> list(
  core.String blogId,
  core.String postId, {
  core.String? endDate,
  core.bool? fetchBodies,
  core.int? maxResults,
  core.String? pageToken,
  core.String? startDate,
  core.String? status,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (endDate != null) 'endDate': [endDate],
    if (fetchBodies != null) 'fetchBodies': ['${fetchBodies}'],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (startDate != null) 'startDate': [startDate],
    if (status != null) 'status': [status],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v3/blogs/' +
      commons.escapeVariable('$blogId') +
      '/posts/' +
      commons.escapeVariable('$postId') +
      '/comments';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return CommentList.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}