ContentRestrictionsApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

ContentRestrictionsApi(ApiClient _client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addGroupToContentRestriction({required String id, required String operationKey, required String groupName}) → Future<void>
Deprecated, use Add group to content restriction via groupId. Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.
addGroupToContentRestrictionByGroupId({required String id, required String operationKey, required String groupId}) → Future<void>
Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content.
addRestrictions({required String id, List<String>? expand, required ContentRestrictionAddOrUpdateArray body}) → Future<ContentRestrictionArray>
Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content.
addUserToContentRestriction({required String id, required String operationKey, String? key, String? username, String? accountId}) → Future<void>
Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content.
deleteRestrictions({required String id, List<String>? expand}) → Future<ContentRestrictionArray>
Removes all restrictions (read and update) on a piece of content.
getContentRestrictionStatusForGroup({required String id, required String operationKey, required String groupName}) → Future<void>
Deprecated, use Get content restriction status for group via groupId. Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the admins group, the following request will return true:
getContentRestrictionStatusForUser({required String id, required String operationKey, String? key, String? username, String? accountId}) → Future<void>
Returns whether the specified content restriction applies to a user. For example, if a page with id=123 has a read restriction for a user with an account ID of 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192, the following request will return true:
getIndividualGroupRestrictionStatusByGroupId({required String id, required String operationKey, required String groupId}) → Future<void>
Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the 123456 group id, the following request will return true:
getRestrictions({required String id, List<String>? expand, int? start, int? limit}) → Future<ContentRestrictionArray>
Returns the restrictions on a piece of content.
getRestrictionsByOperation({required String id, List<String>? expand}) → Future<Map<String, dynamic>>
Returns restrictions on a piece of content by operation. This method is similar to Get restrictions except that the operations are properties of the return object, rather than items in a results array.
getRestrictionsForOperation({required String id, required String operationKey, List<String>? expand, int? start, int? limit}) → Future<ContentRestriction>
Returns the restictions on a piece of content for a given operation (read or update).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeGroupFromContentRestriction({required String id, required String operationKey, required String groupId}) → Future<void>
Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
removeGroupFromContentRestrictionById({required String id, required String operationKey, required String groupName}) → Future<void>
Deprecated, use Remove group from content restriction by groupId. Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
removeUserFromContentRestriction({required String id, required String operationKey, String? key, String? username, String? accountId}) → Future<void>
Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
toString() → String
A string representation of this object.
inherited
updateRestrictions({required String id, List<String>? expand, required ContentRestrictionAddOrUpdateArray body}) → Future<ContentRestrictionArray>
Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request.

Operators

operator ==(Object other) → bool
The equality operator.
inherited