Class ItemAssignmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ItemAssignment resource.

public class ItemAssignmentClient : SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>

Inheritance

object

ResourceClient<ItemAssignment>

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>

ItemAssignmentClient

Inherited Members

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>.PatchAsync(ItemAssignment, CancellationToken)

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>.PatchAsync(JsonApiDocument<ItemAssignmentResource>, CancellationToken)

SingletonResourceClient<ItemAssignment, ItemAssignmentResource, ItemAssignmentResponse>.DeleteAsync(CancellationToken)

ResourceClient<ItemAssignment>.AddQueryParameter(string, string)

ResourceClient<ItemAssignment>.ReplaceQueryParameter(string, string)

ResourceClient<ItemAssignment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemAssignment>.Uri

ResourceClient<ItemAssignment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ItemAssignmentClient(HttpClient, Uri)

Client for interacting with the ItemAssignment resource.

public ItemAssignmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ItemAssignmentClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ItemAssignmentClient

The current ItemAssignmentClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ItemAssignmentClient ClearParameters()

Returns

ItemAssignmentClient

The current ItemAssignmentClient instance.

DeleteAsync(CancellationToken)

Deletes the ItemAssignment resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the ItemAssignment resource asynchronously.

public Task<ItemAssignmentResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemAssignmentResponse>

A task representing the asynchronous operation, containing the ItemAssignment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.