Class GroupTypeClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the GroupType resource.

public class GroupTypeClient : SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>

Inheritance

object

ResourceClient<GroupType>

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>

GroupTypeClient

Inherited Members

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>.PatchAsync(GroupType, CancellationToken)

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>.PatchAsync(JsonApiDocument<GroupTypeResource>, CancellationToken)

SingletonResourceClient<GroupType, GroupTypeResource, GroupTypeResponse>.DeleteAsync(CancellationToken)

ResourceClient<GroupType>.AddQueryParameter(string, string)

ResourceClient<GroupType>.ReplaceQueryParameter(string, string)

ResourceClient<GroupType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<GroupType>.Uri

ResourceClient<GroupType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GroupTypeClient(HttpClient, Uri)

Client for interacting with the GroupType resource.

public GroupTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

Groups

Associated Groups.

public PaginatedGroupClient Groups { get; }

Property Value

PaginatedGroupClient

Resources

Associated Resources.

public PaginatedResourceClient Resources { get; }

Property Value

PaginatedResourceClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public GroupTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

GroupTypeClient

The current GroupTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public GroupTypeClient ClearParameters()

Returns

GroupTypeClient

The current GroupTypeClient instance.

GetAsync(CancellationToken)

Fetches the GroupType resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GroupTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.