Class TeamPositionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the TeamPosition resource.

public class TeamPositionClient : SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>

Inheritance

object

ResourceClient<TeamPosition>

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>

TeamPositionClient

Inherited Members

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>.PatchAsync(TeamPosition, CancellationToken)

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>.PatchAsync(JsonApiDocument<TeamPositionResource>, CancellationToken)

SingletonResourceClient<TeamPosition, TeamPositionResource, TeamPositionResponse>.DeleteAsync(CancellationToken)

ResourceClient<TeamPosition>.AddQueryParameter(string, string)

ResourceClient<TeamPosition>.ReplaceQueryParameter(string, string)

ResourceClient<TeamPosition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TeamPosition>.Uri

ResourceClient<TeamPosition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TeamPositionClient(HttpClient, Uri)

Client for interacting with the TeamPosition resource.

public TeamPositionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

PersonTeamPositionAssignments

Associated PersonTeamPositionAssignments.

public PaginatedPersonTeamPositionAssignmentClient PersonTeamPositionAssignments { get; }

Property Value

PaginatedPersonTeamPositionAssignmentClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Team

Associated Team.

public TeamClient Team { get; }

Property Value

TeamClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TeamPositionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TeamPositionClient

The current TeamPositionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TeamPositionClient ClearParameters()

Returns

TeamPositionClient

The current TeamPositionClient instance.

GetAsync(CancellationToken)

Fetches the TeamPosition resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TeamPositionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeTags()

Include related Tags resources in the response.

public TeamPositionClient IncludeTags()

Returns

TeamPositionClient

IncludeTeam()

Include related Team resources in the response.

public TeamPositionClient IncludeTeam()

Returns

TeamPositionClient