Class SchemaPermissionSetClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class SchemaPermissionSetClient : ClientBase
Constructors
SchemaPermissionSetClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public SchemaPermissionSetClient(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(SchemaPermissionSetCreateRequest, CancellationToken)
Create schema permission set
Declaration
public virtual async Task<SchemaPermissionSetDetail> CreateAsync(SchemaPermissionSetCreateRequest permissionSet, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaPermissionSetCreateRequest
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<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Creates new schema permission set based on supplied request.
CreateManyAsync(SchemaPermissionSetCreateManyRequest, CancellationToken)
Create multiple schema permission sets
Declaration
public virtual async Task<BulkResponse> CreateManyAsync(SchemaPermissionSetCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaPermissionSetCreateManyRequest
request
Request to update multiple schema 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 schema permission sets based on supplied requests.
DeleteAsync(String, CancellationToken)
Delete schema permission set
Declaration
public virtual async Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Schema 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 schema permission set specified by the ID.
DeleteManyAsync(PermissionSetDeleteManyRequest, CancellationToken)
Delete multiple schema 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 schema permission sets specified by the IDs.
GetAsync(String, CancellationToken)
Get schema permission set
Declaration
public virtual async Task<SchemaPermissionSetDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Schema 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<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Gets the schema permission set detail information by the schema permission set ID.
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple schema permission sets
Declaration
public virtual async Task<ICollection<SchemaPermissionSetDetail>> 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<SchemaPermissionSetDetail>>
Array of Detail of a schema permission set |
Remarks
Gets multiple schema permission set details by the schema permission set IDs.
GetPermissionsAsync(String, CancellationToken)
Get permissions for schema permission set
Declaration
public virtual async Task<ICollection<PermissionSetRight>> GetPermissionsAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Schema 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 schema permission set for the current user.
GetPermissionsManyAsync(IEnumerable<String>, CancellationToken)
Get permissions for multiple schema 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 schema permission sets for the current user.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<SchemaPermissionSetClient.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<SchemaPermissionSetClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
SearchAsync(PermissionSetSearchRequest, CancellationToken)
Search schema 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 schema permission sets as specified in the search request.
TransferOwnershipAsync(String, PermissionSetOwnershipTransferRequest, CancellationToken)
Transfer ownership of schema permission set
Declaration
public virtual async Task TransferOwnershipAsync(string id, PermissionSetOwnershipTransferRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Schema 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 schema permission set to supplied user.
TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest, CancellationToken)
Transfer ownership of multiple schema 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 schema permission sets to respective supplied users.
UpdateAsync(String, SchemaPermissionSetUpdateRequest, CancellationToken)
Update schema permission set
Declaration
public virtual async Task<SchemaPermissionSetDetail> UpdateAsync(string id, SchemaPermissionSetUpdateRequest permissionSet, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Schema permission set ID. |
SchemaPermissionSetUpdateRequest
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<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Updates the schema permission set specified by the ID and based on supplied request.
UpdateManyAsync(SchemaPermissionSetUpdateManyRequest, CancellationToken)
Update multiple schema permission sets
Declaration
public virtual async Task<BulkResponse> UpdateManyAsync(SchemaPermissionSetUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaPermissionSetUpdateManyRequest
request
Request to update multiple schema permissions 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 schema permission sets specified by the IDs and based on supplied request.