Class ContentPermissionSetClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class ContentPermissionSetClient : ClientBase
Constructors
ContentPermissionSetClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public ContentPermissionSetClient(Contract.IPictureparkServiceSettings configuration, Http.HttpClient httpClient)
Parameters
Picturepark.SDK.V1.Contract.IPictureparkServiceSettings
configuration
|
System.Net.Http.HttpClient
httpClient
|
Properties
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Newtonsoft.Json.JsonSerializerSettings
|
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
System.Boolean
|
Methods
CreateAsync(ContentPermissionSetCreateRequest, CancellationToken)
Create content permission set
Declaration
public virtual async Task<ContentPermissionSetDetail> CreateAsync(ContentPermissionSetCreateRequest permissionSet, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentPermissionSetCreateRequest
permissionSet
Permission set |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Creates new content permission set based on supplied request.
CreateManyAsync(ContentPermissionSetCreateManyRequest, CancellationToken)
Create multiple content permission sets
Declaration
public virtual async Task<BulkResponse> CreateManyAsync(ContentPermissionSetCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentPermissionSetCreateManyRequest
request
Request to create multiple content permission sets. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BulkResponse>
Response to a bulk operation |
Remarks
Creates new content permission sets based on supplied requests.
DeleteAsync(String, CancellationToken)
Delete content permission set
Declaration
public virtual async Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content permission set ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
|
Remarks
Deletes the content permission set specified by the ID.
DeleteManyAsync(PermissionSetDeleteManyRequest, CancellationToken)
Delete multiple content permission sets
Declaration
public virtual async Task<BulkResponse> DeleteManyAsync(PermissionSetDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
PermissionSetDeleteManyRequest
request
Request to delete multiple permission sets. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BulkResponse>
Response to a bulk operation |
Remarks
Deletes the content permission sets specified by the IDs.
GetAsync(String, CancellationToken)
Get content permission set
Declaration
public virtual async Task<ContentPermissionSetDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content permission set ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Gets the content permission set detail information by the content permission set ID.
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple content permission sets
Declaration
public virtual async Task<ICollection<ContentPermissionSetDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Ids |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<ContentPermissionSetDetail>>
Array of Detail of a content permission set |
Remarks
Gets multiple content permission set details by the content permission set IDs.
GetPermissionsAsync(String, CancellationToken)
Get permissions for content permission set
Declaration
public virtual async Task<ICollection<PermissionSetRight>> GetPermissionsAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content permission set ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PermissionSetRight>>
Array of Permission set rights |
Remarks
Returns permissions for the content permission set for the current user.
GetPermissionsManyAsync(IEnumerable<String>, CancellationToken)
Get permissions for multiple content permission sets
Declaration
public virtual async Task<ICollection<PermissionSetUserPermissionRights>> GetPermissionsManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Ids |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.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.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<ContentPermissionSetClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(Http.HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
System.Net.Http.HttpResponseMessage
response
|
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>
headers
|
System.Threading.CancellationToken
cancellationToken
|
Returns
System.Threading.Tasks.Task<ContentPermissionSetClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
SearchAsync(PermissionSetSearchRequest, CancellationToken)
Search content permission set
Declaration
public virtual async Task<PermissionSetSearchResult> SearchAsync(PermissionSetSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
PermissionSetSearchRequest
request
Request to search permission sets. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<PermissionSetSearchResult>
Result of a permission set search operation |
Remarks
Searches content permission sets as specified in the search request.
TransferOwnershipAsync(String, PermissionSetOwnershipTransferRequest, CancellationToken)
Transfer ownership of content permission set
Declaration
public virtual async Task TransferOwnershipAsync(string id, PermissionSetOwnershipTransferRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content permission set ID. |
PermissionSetOwnershipTransferRequest
request
Request to transfer the ownership of a permission set. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
|
Remarks
Transfers ownership of content permission set to supplied user.
TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest, CancellationToken)
Transfer ownership of multiple content permission sets
Declaration
public virtual async Task TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
PermissionSetOwnershipTransferManyRequest
request
Request to transfer the ownership of multiple permission sets. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
|
Remarks
Transfers ownership of multiple content permission sets to respective supplied users.
UpdateAsync(String, ContentPermissionSetUpdateRequest, CancellationToken)
Update content permission set
Declaration
public virtual async Task<ContentPermissionSetDetail> UpdateAsync(string id, ContentPermissionSetUpdateRequest permissionSet, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content permission set ID. |
ContentPermissionSetUpdateRequest
permissionSet
Permission set |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentPermissionSetDetail>
Detail of a content permission set |
Remarks
Updates the content permission set specified by the ID and based on supplied request.
UpdateManyAsync(ContentPermissionSetUpdateManyRequest, CancellationToken)
Update multiple content permission sets
Declaration
public virtual async Task<BulkResponse> UpdateManyAsync(ContentPermissionSetUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentPermissionSetUpdateManyRequest
request
Request to update multiple content permission sets. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BulkResponse>
Response to a bulk operation |
Remarks
Updates the content permission sets specified by the IDs and based on supplied request.