Class PaginatedArrangementSectionsClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ArrangementSections collection resources.

public class PaginatedArrangementSectionsClient : PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>

Inheritance

object

ResourceClient<ArrangementSections>

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>

PaginatedArrangementSectionsClient

Inherited Members

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.PerPage(int)

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.Offset(int)

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.Filter(string)

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.PostAsync(ArrangementSections, CancellationToken)

PaginatedResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsCollectionResponse, ArrangementSectionsResponse>.PostAsync(JsonApiDocument<ArrangementSectionsResource>, CancellationToken)

ResourceClient<ArrangementSections>.AddQueryParameter(string, string)

ResourceClient<ArrangementSections>.ReplaceQueryParameter(string, string)

ResourceClient<ArrangementSections>.AddCustomParameter(string, string)

ResourceClient<ArrangementSections>.ClearParameters()

ResourceClient<ArrangementSections>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ArrangementSections>.Uri

ResourceClient<ArrangementSections>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedArrangementSectionsClient(HttpClient, Uri)

Client for interacting with ArrangementSections collection resources.

public PaginatedArrangementSectionsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ArrangementSections resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ArrangementSectionsCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ArrangementSectionsClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ArrangementSectionsClient

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