Class PaginatedSplitTeamRehearsalAssignmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SplitTeamRehearsalAssignment collection resources.

public class PaginatedSplitTeamRehearsalAssignmentClient : PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>

Inheritance

object

ResourceClient<SplitTeamRehearsalAssignment>

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>

PaginatedSplitTeamRehearsalAssignmentClient

Inherited Members

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.PerPage(int)

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.Offset(int)

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.Filter(string)

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.PostAsync(SplitTeamRehearsalAssignment, CancellationToken)

PaginatedResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentCollectionResponse, SplitTeamRehearsalAssignmentResponse>.PostAsync(JsonApiDocument<SplitTeamRehearsalAssignmentResource>, CancellationToken)

ResourceClient<SplitTeamRehearsalAssignment>.AddQueryParameter(string, string)

ResourceClient<SplitTeamRehearsalAssignment>.ReplaceQueryParameter(string, string)

ResourceClient<SplitTeamRehearsalAssignment>.AddCustomParameter(string, string)

ResourceClient<SplitTeamRehearsalAssignment>.ClearParameters()

ResourceClient<SplitTeamRehearsalAssignment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SplitTeamRehearsalAssignment>.Uri

ResourceClient<SplitTeamRehearsalAssignment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSplitTeamRehearsalAssignmentClient(HttpClient, Uri)

Client for interacting with SplitTeamRehearsalAssignment collection resources.

public PaginatedSplitTeamRehearsalAssignmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of SplitTeamRehearsalAssignment resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SplitTeamRehearsalAssignmentCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(SplitTeamRehearsalAssignment, CancellationToken)

Creates a new SplitTeamRehearsalAssignment resource asynchronously.

public Task<SplitTeamRehearsalAssignmentResponse> PostAsync(SplitTeamRehearsalAssignment resource, CancellationToken cancellationToken = default)

Parameters

resource SplitTeamRehearsalAssignment

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SplitTeamRehearsalAssignmentResponse>

A task representing the asynchronous operation, containing the created SplitTeamRehearsalAssignment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SplitTeamRehearsalAssignmentResource>, CancellationToken)

Creates a new SplitTeamRehearsalAssignment resource asynchronously.

public Task<SplitTeamRehearsalAssignmentResponse> PostAsync(JsonApiDocument<SplitTeamRehearsalAssignmentResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SplitTeamRehearsalAssignmentResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SplitTeamRehearsalAssignmentResponse>

A task representing the asynchronous operation, containing the created SplitTeamRehearsalAssignment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public SplitTeamRehearsalAssignmentClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SplitTeamRehearsalAssignmentClient

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