getSpaceProperties method

Future<MultiEntityResult<SpaceProperty>> getSpaceProperties({
  1. required int spaceId,
  2. String? key,
  3. String? cursor,
  4. int? limit,
})

Returns all properties for the given space. Space properties are a key-value storage associated with a space. The limit parameter specifies the maximum number of results returned in a single response. Use the link response header to paginate through additional results.

Permissions required: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space.

Implementation

Future<MultiEntityResult<SpaceProperty>> getSpaceProperties(
    {required int spaceId, String? key, String? cursor, int? limit}) async {
  return MultiEntityResult.fromJson(
    await _client.send(
      'get',
      'spaces/{space-id}/properties',
      pathParameters: {
        'space-id': '$spaceId',
      },
      queryParameters: {
        if (key != null) 'key': key,
        if (cursor != null) 'cursor': cursor,
        if (limit != null) 'limit': '$limit',
      },
    ),
    reviver: (v) => SpaceProperty.fromJson(v as Map<String, Object?>),
  );
}