Class PlanTemplateClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanTemplate resource.

public class PlanTemplateClient : SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>

Inheritance

object

ResourceClient<PlanTemplate>

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>

PlanTemplateClient

Inherited Members

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>.PatchAsync(PlanTemplate, CancellationToken)

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>.PatchAsync(JsonApiDocument<PlanTemplateResource>, CancellationToken)

SingletonResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanTemplate>.AddQueryParameter(string, string)

ResourceClient<PlanTemplate>.ReplaceQueryParameter(string, string)

ResourceClient<PlanTemplate>.AddCustomParameter(string, string)

ResourceClient<PlanTemplate>.ClearParameters()

ResourceClient<PlanTemplate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanTemplate>.Uri

ResourceClient<PlanTemplate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanTemplateClient(HttpClient, Uri)

Client for interacting with the PlanTemplate resource.

public PlanTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Items

Associated Items.

public PaginatedItemClient Items { get; }

Property Value

PaginatedItemClient

Notes

Associated Notes.

public PaginatedPlanNoteClient Notes { get; }

Property Value

PaginatedPlanNoteClient

TeamMembers

Associated TeamMembers.

public PaginatedPlanPersonClient TeamMembers { get; }

Property Value

PaginatedPlanPersonClient

Methods

GetAsync(CancellationToken)

Fetches the PlanTemplate resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

ItemReorderAsync(CancellationToken)

Reorder plan template items in one request.
This can be used to reorder all items in a plan template in one request.

It expects a POST body with a sequence of Item ids in order. E.G.

``json
{
"data": {
"type": "PlanItemReorder",
"attributes": {
"sequence": [
"5",
"1",
"3"
]
}
}
}
<code><br /><br />On success you will get back a </code>204 No Content.

public Task ItemReorderAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task