Class ItemClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Item resource.

public class ItemClient : SingletonResourceClient<Item, ItemResource, ItemResponse>

Inheritance

object

ResourceClient<Item>

SingletonResourceClient<Item, ItemResource, ItemResponse>

ItemClient

Inherited Members

SingletonResourceClient<Item, ItemResource, ItemResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Item, ItemResource, ItemResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Item, ItemResource, ItemResponse>.PatchAsync(Item, CancellationToken)

SingletonResourceClient<Item, ItemResource, ItemResponse>.PatchAsync(JsonApiDocument<ItemResource>, CancellationToken)

SingletonResourceClient<Item, ItemResource, ItemResponse>.DeleteAsync(CancellationToken)

ResourceClient<Item>.AddQueryParameter(string, string)

ResourceClient<Item>.ReplaceQueryParameter(string, string)

ResourceClient<Item>.AddCustomParameter(string, string)

ResourceClient<Item>.ClearParameters()

ResourceClient<Item>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Item>.Uri

ResourceClient<Item>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ItemClient(HttpClient, Uri)

Client for interacting with the Item resource.

public ItemClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Arrangement

Associated Arrangement.

public ArrangementClient Arrangement { get; }

Property Value

ArrangementClient

Attachments

Associated Attachments.

public PaginatedAttachmentClient Attachments { get; }

Property Value

PaginatedAttachmentClient

CustomSlides

Associated CustomSlides.

public PaginatedCustomSlideClient CustomSlides { get; }

Property Value

PaginatedCustomSlideClient

ItemNotes

Associated ItemNotes.

public PaginatedItemNoteClient ItemNotes { get; }

Property Value

PaginatedItemNoteClient

ItemTimes

Associated ItemTimes.

public PaginatedItemTimeClient ItemTimes { get; }

Property Value

PaginatedItemTimeClient

Key

Associated Key.

public KeyClient Key { get; }

Property Value

KeyClient

Media

Associated Media.

public PaginatedMediaClient Media { get; }

Property Value

PaginatedMediaClient

SelectedAttachment

Associated SelectedAttachment.

public AttachmentClient SelectedAttachment { get; }

Property Value

AttachmentClient

SelectedBackground

Associated SelectedBackground.

public AttachmentClient SelectedBackground { get; }

Property Value

AttachmentClient

Song

Associated Song.

public SongClient Song { get; }

Property Value

SongClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeArrangement()

Include related Arrangement resources in the response.

public ItemClient IncludeArrangement()

Returns

ItemClient

IncludeItemNotes()

Include related ItemNotes resources in the response.

public ItemClient IncludeItemNotes()

Returns

ItemClient

IncludeItemTimes()

Include related ItemTimes resources in the response.

public ItemClient IncludeItemTimes()

Returns

ItemClient

IncludeKey()

Include related Key resources in the response.

public ItemClient IncludeKey()

Returns

ItemClient

IncludeMedia()

Include related Media resources in the response.

public ItemClient IncludeMedia()

Returns

ItemClient

IncludeSelectedAttachment()

Include related SelectedAttachment resources in the response.

public ItemClient IncludeSelectedAttachment()

Returns

ItemClient

IncludeSong()

Include related Song resources in the response.

public ItemClient IncludeSong()

Returns

ItemClient

PatchAsync(Item, CancellationToken)

Updates an existing Item resource asynchronously.

public Task<ItemResponse> PatchAsync(Item resource, CancellationToken cancellationToken = default)

Parameters

resource Item

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ItemResource>, CancellationToken)

Updates an existing Item resource asynchronously.

public Task<ItemResponse> PatchAsync(JsonApiDocument<ItemResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ItemResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.