Class ContentPermissionSetClient

Inheritance

object

ClientBase

ContentPermissionSetClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CustomerAlias

ClientBase.CreateHttpRequestMessageAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ContentPermissionSetClient : ClientBase, IContentPermissionSetClient

Constructors

ContentPermissionSetClient(IPictureparkServiceSettings, HttpClient)

Declaration

public ContentPermissionSetClient(IPictureparkServiceSettings configuration, HttpClient httpClient)

Parameters

IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

CreateAsync(ContentPermissionSetCreateRequest, CancellationToken)

Create content permission set

Declaration

public virtual 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

Implements

IContentPermissionSetClient.CreateAsync(ContentPermissionSetCreateRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.CreateManyAsync(ContentPermissionSetCreateManyRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.DeleteAsync(string, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.DeleteManyAsync(PermissionSetDeleteManyRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.GetAsync(string, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.GetManyAsync(IEnumerable<string>, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.GetPermissionsAsync(string, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.GetPermissionsManyAsync(IEnumerable<string>, CancellationToken)

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

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<ContentPermissionSetClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

HttpResponseMessage response

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns

Task<ContentPermissionSetClient.ObjectResponseResult<T>>

Type Parameters

T

SearchAsync(PermissionSetSearchRequest, CancellationToken)

Search content permission set

Declaration

public virtual 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

Implements

IContentPermissionSetClient.SearchAsync(PermissionSetSearchRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.TransferOwnershipAsync(string, PermissionSetOwnershipTransferRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.UpdateAsync(string, ContentPermissionSetUpdateRequest, CancellationToken)

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

public virtual 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

Implements

IContentPermissionSetClient.UpdateManyAsync(ContentPermissionSetUpdateManyRequest, CancellationToken)

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