Class TeamClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Team resource.

public class TeamClient : SingletonResourceClient<Team, TeamResource, TeamResponse>

Inheritance

object

ResourceClient<Team>

SingletonResourceClient<Team, TeamResource, TeamResponse>

TeamClient

Inherited Members

SingletonResourceClient<Team, TeamResource, TeamResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Team, TeamResource, TeamResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Team, TeamResource, TeamResponse>.PatchAsync(Team, CancellationToken)

SingletonResourceClient<Team, TeamResource, TeamResponse>.PatchAsync(JsonApiDocument<TeamResource>, CancellationToken)

SingletonResourceClient<Team, TeamResource, TeamResponse>.DeleteAsync(CancellationToken)

ResourceClient<Team>.AddQueryParameter(string, string)

ResourceClient<Team>.ReplaceQueryParameter(string, string)

ResourceClient<Team>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Team>.Uri

ResourceClient<Team>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TeamClient(HttpClient, Uri)

Client for interacting with the Team resource.

public TeamClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

PersonTeamPositionAssignments

Associated PersonTeamPositionAssignments.

public PaginatedPersonTeamPositionAssignmentClient PersonTeamPositionAssignments { get; }

Property Value

PaginatedPersonTeamPositionAssignmentClient

ServiceTypes

Associated ServiceTypes.

public PaginatedServiceTypeClient ServiceTypes { get; }

Property Value

PaginatedServiceTypeClient

TeamLeaders

Associated TeamLeaders.

public PaginatedTeamLeaderClient TeamLeaders { get; }

Property Value

PaginatedTeamLeaderClient

TeamPositions

Associated TeamPositions.

public PaginatedTeamPositionClient TeamPositions { get; }

Property Value

PaginatedTeamPositionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TeamClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TeamClient

The current TeamClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TeamClient ClearParameters()

Returns

TeamClient

The current TeamClient instance.

GetAsync(CancellationToken)

Fetches the Team resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TeamResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePeople()

Include related People resources in the response.

public TeamClient IncludePeople()

Returns

TeamClient

IncludePersonTeamPositionAssignments()

Include related PersonTeamPositionAssignments resources in the response.

public TeamClient IncludePersonTeamPositionAssignments()

Returns

TeamClient

IncludeServiceTypes()

Include related ServiceTypes resources in the response.

public TeamClient IncludeServiceTypes()

Returns

TeamClient

IncludeTeamLeaders()

Include related TeamLeaders resources in the response.

public TeamClient IncludeTeamLeaders()

Returns

TeamClient

IncludeTeamPositions()

Include related TeamPositions resources in the response.

public TeamClient IncludeTeamPositions()

Returns

TeamClient