Interface IUserRoleClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IUserRoleClient
Methods
CreateAsync(UserRoleCreateRequest, CancellationToken)
Create user role
Declaration
Task<UserRoleDetail> CreateAsync(UserRoleCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleCreateRequest
request
Request containing information needed to create new user role. |
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<UserRoleDetail>
Represents a user role, which associates users with user rights. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateManyAsync(UserRoleCreateManyRequest, CancellationToken)
Create multiple user roles
Declaration
Task<BulkResponse> CreateManyAsync(UserRoleCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleCreateManyRequest
request
Request containing information needed to create new user role. |
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteAsync(String, CancellationToken)
Delete user role
Declaration
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User role 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
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteManyAsync(UserRoleDeleteManyRequest, CancellationToken)
Delete multiple user roles
Declaration
Task<BulkResponse> DeleteManyAsync(UserRoleDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleDeleteManyRequest
request
The request with user role IDs to delete. |
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAsync(String, CancellationToken)
Get user role
Declaration
Task<UserRoleDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User role 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<UserRoleDetail>
Represents a user role, which associates users with user rights. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple user roles
Declaration
Task<ICollection<UserRoleDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
User role IDs to get information about. |
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<UserRoleDetail>>
Array of Represents a user role, which associates users with user rights. |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
RequestSizeLimitExceededException
List of IDs exceeded maximum size |
SearchAsync(UserRoleSearchRequest, CancellationToken)
Search user roles
Declaration
Task<UserRoleSearchResult> SearchAsync(UserRoleSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleSearchRequest
request
User role search request. |
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<UserRoleSearchResult>
Result of the user role search |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateAsync(String, UserRoleEditable, CancellationToken)
Update user role
Declaration
Task<UserRoleDetail> UpdateAsync(string id, UserRoleEditable request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User role ID. |
UserRoleEditable
request
Request containing information needed to update the user role. |
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<UserRoleDetail>
Represents a user role, which associates users with user rights. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateManyAsync(UserRoleUpdateManyRequest, CancellationToken)
Update multiple user roles
Declaration
Task<BulkResponse> UpdateManyAsync(UserRoleUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleUpdateManyRequest
request
Request containing information needed to update the user role. |
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |