Class PaginatedPlanTemplateClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanTemplate collection resources.

public class PaginatedPlanTemplateClient : PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>

Inheritance

object

ResourceClient<PlanTemplate>

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>

PaginatedPlanTemplateClient

Inherited Members

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.PerPage(int)

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.Offset(int)

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.Filter(string)

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.PostAsync(PlanTemplate, CancellationToken)

PaginatedResourceClient<PlanTemplate, PlanTemplateResource, PlanTemplateCollectionResponse, PlanTemplateResponse>.PostAsync(JsonApiDocument<PlanTemplateResource>, CancellationToken)

ResourceClient<PlanTemplate>.AddQueryParameter(string, string)

ResourceClient<PlanTemplate>.ReplaceQueryParameter(string, string)

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

PaginatedPlanTemplateClient(HttpClient, Uri)

Client for interacting with PlanTemplate collection resources.

public PaginatedPlanTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanTemplateClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanTemplateClient

The current PaginatedPlanTemplateClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanTemplateClient ClearParameters()

Returns

PaginatedPlanTemplateClient

The current PaginatedPlanTemplateClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanTemplateClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanTemplateClient

The current PaginatedPlanTemplateClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of PlanTemplate resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTemplateCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of PlanTemplate resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanTemplateClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanTemplateClient

The current PaginatedPlanTemplateClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public PlanTemplateClient OrderByCreatedAt()

Returns

PlanTemplateClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public PlanTemplateClient OrderByCreatedAtDescending()

Returns

PlanTemplateClient

OrderByItemCount()

Sort response items by the ItemCount attribute.

public PlanTemplateClient OrderByItemCount()

Returns

PlanTemplateClient

OrderByItemCountDescending()

Sort response items by the ItemCount attribute. Use reverse order.

public PlanTemplateClient OrderByItemCountDescending()

Returns

PlanTemplateClient

OrderByName()

Sort response items by the Name attribute.

public PlanTemplateClient OrderByName()

Returns

PlanTemplateClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public PlanTemplateClient OrderByNameDescending()

Returns

PlanTemplateClient

OrderByNoteCount()

Sort response items by the NoteCount attribute.

public PlanTemplateClient OrderByNoteCount()

Returns

PlanTemplateClient

OrderByNoteCountDescending()

Sort response items by the NoteCount attribute. Use reverse order.

public PlanTemplateClient OrderByNoteCountDescending()

Returns

PlanTemplateClient

OrderByTeamCount()

Sort response items by the TeamCount attribute.

public PlanTemplateClient OrderByTeamCount()

Returns

PlanTemplateClient

OrderByTeamCountDescending()

Sort response items by the TeamCount attribute. Use reverse order.

public PlanTemplateClient OrderByTeamCountDescending()

Returns

PlanTemplateClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public PlanTemplateClient OrderByUpdatedAt()

Returns

PlanTemplateClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public PlanTemplateClient OrderByUpdatedAtDescending()

Returns

PlanTemplateClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedPlanTemplateClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanTemplateClient

The current PaginatedPlanTemplateClient instance.

WithId(string)

Creates a new instance of a PlanTemplate client for a specific resource ID.

public PlanTemplateClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanTemplateClient

A new instance of the resource client for the specified resource ID.