getFooterComments method

Future<MultiEntityResult<InlineCommentModel>> getFooterComments({
  1. String? bodyFormat,
  2. String? sort,
  3. String? cursor,
  4. int? limit,
  5. bool? serializeIdsAsStrings,
})

Returns all footer comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to view the content of the page and its corresponding space.

Implementation

Future<MultiEntityResult<InlineCommentModel>> getFooterComments(
    {String? bodyFormat,
    String? sort,
    String? cursor,
    int? limit,
    bool? serializeIdsAsStrings}) async {
  return MultiEntityResult.fromJson(
    await _client.send(
      'get',
      'footer-comments',
      queryParameters: {
        if (bodyFormat != null) 'body-format': bodyFormat,
        if (sort != null) 'sort': sort,
        if (cursor != null) 'cursor': cursor,
        if (limit != null) 'limit': '$limit',
        if (serializeIdsAsStrings != null)
          'serialize-ids-as-strings': '$serializeIdsAsStrings',
      },
    ),
    reviver: (v) => InlineCommentModel.fromJson(v as Map<String, Object?>),
  );
}