Class TeamLeaderClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the TeamLeader resource.

public class TeamLeaderClient : SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>

Inheritance

object

ResourceClient<TeamLeader>

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>

TeamLeaderClient

Inherited Members

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>.GetAsync(CancellationToken)

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>.PatchAsync(TeamLeader, CancellationToken)

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>.PatchAsync(JsonApiDocument<TeamLeaderResource>, CancellationToken)

SingletonResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderResponse>.DeleteAsync(CancellationToken)

ResourceClient<TeamLeader>.AddQueryParameter(string, string)

ResourceClient<TeamLeader>.ReplaceQueryParameter(string, string)

ResourceClient<TeamLeader>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TeamLeader>.Uri

ResourceClient<TeamLeader>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TeamLeaderClient(HttpClient, Uri)

Client for interacting with the TeamLeader resource.

public TeamLeaderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

Team

Associated Team.

public TeamClient Team { get; }

Property Value

TeamClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TeamLeaderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TeamLeaderClient

The current TeamLeaderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TeamLeaderClient ClearParameters()

Returns

TeamLeaderClient

The current TeamLeaderClient instance.

GetAsync(CancellationToken)

Fetches the TeamLeader resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TeamLeaderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePeople()

Include related People resources in the response.

public TeamLeaderClient IncludePeople()

Returns

TeamLeaderClient

IncludeTeam()

Include related Team resources in the response.

public TeamLeaderClient IncludeTeam()

Returns

TeamLeaderClient