Class PaginatedGroupApplicationClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with GroupApplication collection resources.

public class PaginatedGroupApplicationClient : PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>

Inheritance

object

ResourceClient<GroupApplication>

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>

PaginatedGroupApplicationClient

Inherited Members

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.PerPage(int)

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.Offset(int)

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.Filter(string)

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.PostAsync(GroupApplication, CancellationToken)

PaginatedResourceClient<GroupApplication, GroupApplicationResource, GroupApplicationCollectionResponse, GroupApplicationResponse>.PostAsync(JsonApiDocument<GroupApplicationResource>, CancellationToken)

ResourceClient<GroupApplication>.AddQueryParameter(string, string)

ResourceClient<GroupApplication>.ReplaceQueryParameter(string, string)

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

PaginatedGroupApplicationClient(HttpClient, Uri)

Client for interacting with GroupApplication collection resources.

public PaginatedGroupApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedGroupApplicationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedGroupApplicationClient

The current PaginatedGroupApplicationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedGroupApplicationClient ClearParameters()

Returns

PaginatedGroupApplicationClient

The current PaginatedGroupApplicationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedGroupApplicationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedGroupApplicationClient

The current PaginatedGroupApplicationClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of GroupApplication resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GroupApplicationCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of GroupApplication resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedGroupApplicationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedGroupApplicationClient

The current PaginatedGroupApplicationClient instance.

OrderByAppliedAt()

Sort response items by the AppliedAt attribute.

public GroupApplicationClient OrderByAppliedAt()

Returns

GroupApplicationClient

OrderByAppliedAtDescending()

Sort response items by the AppliedAt attribute. Use reverse order.

public GroupApplicationClient OrderByAppliedAtDescending()

Returns

GroupApplicationClient

OrderByStatus()

Sort response items by the Status attribute.

public GroupApplicationClient OrderByStatus()

Returns

GroupApplicationClient

OrderByStatusDescending()

Sort response items by the Status attribute. Use reverse order.

public GroupApplicationClient OrderByStatusDescending()

Returns

GroupApplicationClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedGroupApplicationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedGroupApplicationClient

The current PaginatedGroupApplicationClient instance.

WhereAppliedAt(DateTime)

Query response items by the AppliedAt attribute.

public GroupApplicationClient WhereAppliedAt(DateTime value)

Parameters

value DateTime

Returns

GroupApplicationClient

WhereStatus(string)

Query response items by the Status attribute.

public GroupApplicationClient WhereStatus(string value)

Parameters

value string

Returns

GroupApplicationClient

WithId(string)

Creates a new instance of a GroupApplication client for a specific resource ID.

public GroupApplicationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

GroupApplicationClient

A new instance of the resource client for the specified resource ID.