Class SplitTeamRehearsalAssignmentClient
- Namespace
- Crews.PlanningCenter.Api.Services.V2018_11_01
- Assembly
- Crews.PlanningCenter.Api.dll
Client for interacting with the SplitTeamRehearsalAssignment resource.
public class SplitTeamRehearsalAssignmentClient : SingletonResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentResponse>
- Inheritance
-
SingletonResourceClient<SplitTeamRehearsalAssignment, SplitTeamRehearsalAssignmentResource, SplitTeamRehearsalAssignmentResponse>SplitTeamRehearsalAssignmentClient
- Inherited Members
Constructors
SplitTeamRehearsalAssignmentClient(HttpClient, Uri)
Client for interacting with the SplitTeamRehearsalAssignment resource.
public SplitTeamRehearsalAssignmentClient(HttpClient httpClient, Uri uri)
Parameters
httpClientHttpClienturiUri
Properties
Team
Associated Team.
public TeamClient Team { get; }
Property Value
Methods
DeleteAsync(CancellationToken)
Deletes the SplitTeamRehearsalAssignment resource asynchronously.
public Task DeleteAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenA 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 SplitTeamRehearsalAssignment resource asynchronously.
public Task<SplitTeamRehearsalAssignmentResponse> GetAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<SplitTeamRehearsalAssignmentResponse>
A task representing the asynchronous operation, containing the SplitTeamRehearsalAssignment resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.
PatchAsync(SplitTeamRehearsalAssignment, CancellationToken)
Updates an existing SplitTeamRehearsalAssignment resource asynchronously.
public Task<SplitTeamRehearsalAssignmentResponse> PatchAsync(SplitTeamRehearsalAssignment resource, CancellationToken cancellationToken = default)
Parameters
resourceSplitTeamRehearsalAssignmentThe resource data to be sent in the patch request.
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<SplitTeamRehearsalAssignmentResponse>
A task representing the asynchronous operation, containing the updated SplitTeamRehearsalAssignment resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.
PatchAsync(JsonApiDocument<SplitTeamRehearsalAssignmentResource>, CancellationToken)
Updates an existing SplitTeamRehearsalAssignment resource asynchronously.
public Task<SplitTeamRehearsalAssignmentResponse> PatchAsync(JsonApiDocument<SplitTeamRehearsalAssignmentResource> document, CancellationToken cancellationToken = default)
Parameters
documentJsonApiDocument<SplitTeamRehearsalAssignmentResource>The JSON:API document to be sent in the patch request.
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<SplitTeamRehearsalAssignmentResponse>
A task representing the asynchronous operation, containing the updated SplitTeamRehearsalAssignment resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.