Class GroupApplicationClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the GroupApplication resource.

public class GroupApplicationClient : SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>

Inheritance

object

ResourceClient<GroupApplication>

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>

GroupApplicationClient

Inherited Members

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>.PatchAsync(GroupApplication, CancellationToken)

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>.PatchAsync(JsonApiDocument<GroupApplicationResource>, CancellationToken)

SingletonResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationResponse>.DeleteAsync(CancellationToken)

ResourceClient<GroupApplication>.AddQueryParameter(string, string)

ResourceClient<GroupApplication>.ReplaceQueryParameter(string, string)

ResourceClient<GroupApplication>.AddCustomParameter(string, string)

ResourceClient<GroupApplication>.ClearParameters()

ResourceClient<GroupApplication>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<GroupApplication>.Uri

ResourceClient<GroupApplication>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GroupApplicationClient(HttpClient, Uri)

Client for interacting with the GroupApplication resource.

public GroupApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Group

Associated Group.

public GroupClient Group { get; }

Property Value

GroupClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

ApproveAsync(CancellationToken)

Planning Center does not provide a description for this action.
This action can be used to approve a group application and immediately
add the person to the group. You can optionally provide a role attribute
as member (default) or leader. Only administrators or managers can
create leaders.

public Task ApproveAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

GetAsync(CancellationToken)

Fetches the GroupApplication resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GroupApplicationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeGroup()

Include related Group resources in the response.

public GroupApplicationClient IncludeGroup()

Returns

GroupApplicationClient

IncludePerson()

Include related Person resources in the response.

public GroupApplicationClient IncludePerson()

Returns

GroupApplicationClient

RejectAsync(CancellationToken)

Planning Center does not provide a description for this action.
This action can be used to reject a group application. The person will not
be added to the group.

public Task RejectAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task