Interface IContentPermissionSetClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IContentPermissionSetClientMethods
CreateAsync(ContentPermissionSetCreateRequest, CancellationToken)
Create content permission set
Declaration
Task<ContentPermissionSetDetail> CreateAsync(ContentPermissionSetCreateRequest permissionSet, CancellationToken cancellationToken = default)Parameters
|
ContentPermissionSetCreateRequest
permissionSet
Permission set |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Creates new content permission set based on supplied request.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
CreateManyAsync(ContentPermissionSetCreateManyRequest, CancellationToken)
Create multiple content permission sets
Declaration
Task<BulkResponse> CreateManyAsync(ContentPermissionSetCreateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ContentPermissionSetCreateManyRequest
request
Request to create multiple content permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Creates new content permission sets based on supplied requests.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DeleteAsync(string, CancellationToken)
Delete content permission set
Declaration
Task DeleteAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Content permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Deletes the content permission set specified by the ID.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DeleteManyAsync(PermissionSetDeleteManyRequest, CancellationToken)
Delete multiple content permission sets
Declaration
Task<BulkResponse> DeleteManyAsync(PermissionSetDeleteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetDeleteManyRequest
request
Request to delete multiple permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Deletes the content permission sets specified by the IDs.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetAsync(string, CancellationToken)
Get content permission set
Declaration
Task<ContentPermissionSetDetail> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Content permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Gets the content permission set detail information by the content permission set ID.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetManyAsync(IEnumerable<string>, CancellationToken)
Get multiple content permission sets
Declaration
Task<ICollection<ContentPermissionSetDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Ids |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<ContentPermissionSetDetail>>
Array of Detail of a content permission set |
Remarks
Gets multiple content permission set details by the content permission set IDs.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetPermissionsAsync(string, CancellationToken)
Get permissions for content permission set
Declaration
Task<ICollection<PermissionSetRight>> GetPermissionsAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Content permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<PermissionSetRight>>
Array of Permission set rights |
Remarks
Returns permissions for the content permission set for the current user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetPermissionsManyAsync(IEnumerable<string>, CancellationToken)
Get permissions for multiple content permission sets
Declaration
Task<ICollection<PermissionSetUserPermissionRights>> GetPermissionsManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Ids |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<PermissionSetUserPermissionRights>>
Array of Rights that the current user has on a permission set |
Remarks
Returns permissions for multiple content permission sets for the current user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
SearchAsync(PermissionSetSearchRequest, CancellationToken)
Search content permission set
Declaration
Task<PermissionSetSearchResult> SearchAsync(PermissionSetSearchRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetSearchRequest
request
Request to search permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<PermissionSetSearchResult>
Result of a permission set search operation |
Remarks
Searches content permission sets as specified in the search request.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
TransferOwnershipAsync(string, PermissionSetOwnershipTransferRequest, CancellationToken)
Transfer ownership of content permission set
Declaration
Task TransferOwnershipAsync(string id, PermissionSetOwnershipTransferRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
Content permission set ID. |
|
PermissionSetOwnershipTransferRequest
request
Request to transfer the ownership of a permission set. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Transfers ownership of content permission set to supplied user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest, CancellationToken)
Transfer ownership of multiple content permission sets
Declaration
Task TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetOwnershipTransferManyRequest
request
Request to transfer the ownership of multiple permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Transfers ownership of multiple content permission sets to respective supplied users.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
UpdateAsync(string, ContentPermissionSetUpdateRequest, CancellationToken)
Update content permission set
Declaration
Task<ContentPermissionSetDetail> UpdateAsync(string id, ContentPermissionSetUpdateRequest permissionSet, CancellationToken cancellationToken = default)Parameters
|
string
id
Content permission set ID. |
|
ContentPermissionSetUpdateRequest
permissionSet
Permission set |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Updates the content permission set specified by the ID and based on supplied request.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
UpdateManyAsync(ContentPermissionSetUpdateManyRequest, CancellationToken)
Update multiple content permission sets
Declaration
Task<BulkResponse> UpdateManyAsync(ContentPermissionSetUpdateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ContentPermissionSetUpdateManyRequest
request
Request to update multiple content permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Updates the content permission sets specified by the IDs and based on supplied request.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |