Class ArrangementClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Arrangement resource.

public class ArrangementClient : SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>

Inheritance

object

ResourceClient<Arrangement>

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>

ArrangementClient

Inherited Members

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>.PatchAsync(Arrangement, CancellationToken)

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>.PatchAsync(JsonApiDocument<ArrangementResource>, CancellationToken)

SingletonResourceClient<Arrangement, ArrangementResource, ArrangementResponse>.DeleteAsync(CancellationToken)

ResourceClient<Arrangement>.AddQueryParameter(string, string)

ResourceClient<Arrangement>.ReplaceQueryParameter(string, string)

ResourceClient<Arrangement>.AddCustomParameter(string, string)

ResourceClient<Arrangement>.ClearParameters()

ResourceClient<Arrangement>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Arrangement>.Uri

ResourceClient<Arrangement>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ArrangementClient(HttpClient, Uri)

Client for interacting with the Arrangement resource.

public ArrangementClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Attachments

Associated Attachments.

public PaginatedAttachmentClient Attachments { get; }

Property Value

PaginatedAttachmentClient

Keys

Associated Keys.

public PaginatedKeyClient Keys { get; }

Property Value

PaginatedKeyClient

Sections

Associated Sections.

public ArrangementSectionsClient Sections { get; }

Property Value

ArrangementSectionsClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Methods

AssignTagsAsync(CancellationToken)

Used to assign tags to an arrangement.
All tags will be replaced so the full data set must be sent.

It expects a body that looks like:

``json
{
"data": {
"type": "TagAssignment",
"attributes": {},
"relationships": {
"tags": {
"data": [
{
"type": "Tag",
"id": "5"
}
]
}
}
}
}
<code><br /><br />On success you will get back a </code>204 No Content.

public Task AssignTagsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

DeleteAsync(CancellationToken)

Deletes the Arrangement 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 Arrangement resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ArrangementResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeKeys()

Include related Keys resources in the response.

public ArrangementClient IncludeKeys()

Returns

ArrangementClient

IncludeSections()

Include related Sections resources in the response.

public ArrangementClient IncludeSections()

Returns

ArrangementClient

PatchAsync(Arrangement, CancellationToken)

Updates an existing Arrangement resource asynchronously.

public Task<ArrangementResponse> PatchAsync(Arrangement resource, CancellationToken cancellationToken = default)

Parameters

resource Arrangement

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ArrangementResponse>

A task representing the asynchronous operation, containing the updated Arrangement resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ArrangementResource>, CancellationToken)

Updates an existing Arrangement resource asynchronously.

public Task<ArrangementResponse> PatchAsync(JsonApiDocument<ArrangementResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ArrangementResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ArrangementResponse>

A task representing the asynchronous operation, containing the updated Arrangement resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.