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
-
GroupApplicationClient
- Inherited Members
Constructors
GroupApplicationClient(HttpClient, Uri)
Client for interacting with the GroupApplication resource.
public GroupApplicationClient(HttpClient httpClient, Uri uri)Parameters
httpClientHttpClienturiUri
Properties
Group
Associated Group.
public GroupClient Group { get; }Property Value
Person
Associated Person.
public PersonClient Person { get; }Property Value
Methods
AddCustomParameter(string, string)
Adds a custom query parameter to the request URI.
public GroupApplicationClient AddCustomParameter(string parameter, string value)Parameters
Returns
- GroupApplicationClient
The current GroupApplicationClient instance.
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
cancellationTokenCancellationToken
Returns
ClearParameters()
Removes the entire query string from the request URI.
public GroupApplicationClient ClearParameters()Returns
- GroupApplicationClient
The current GroupApplicationClient instance.
GetAsync(CancellationToken)
Fetches the GroupApplication resource asynchronously.
public Task<GroupApplicationResponse> GetAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA 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
IncludePerson()
Include related Person resources in the response.
public GroupApplicationClient IncludePerson()Returns
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
cancellationTokenCancellationToken