Class PaginatedGroupClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Group collection resources.

public class PaginatedGroupClient : PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>

Inheritance

object

ResourceClient<Group>

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>

PaginatedGroupClient

Inherited Members

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.PerPage(int)

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.Offset(int)

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.Filter(string)

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.PostAsync(Group, CancellationToken)

PaginatedResourceClient<Group, GroupResource, GroupCollectionResponse, GroupResponse>.PostAsync(JsonApiDocument<GroupResource>, CancellationToken)

ResourceClient<Group>.AddQueryParameter(string, string)

ResourceClient<Group>.ReplaceQueryParameter(string, string)

ResourceClient<Group>.AddCustomParameter(string, string)

ResourceClient<Group>.ClearParameters()

ResourceClient<Group>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Group>.Uri

ResourceClient<Group>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedGroupClient(HttpClient, Uri)

Client for interacting with Group collection resources.

public PaginatedGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Group resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEnrollment()

Include related Enrollment resources in the response.

public GroupClient IncludeEnrollment()

Returns

GroupClient

IncludeGroupType()

Include related GroupType resources in the response.

public GroupClient IncludeGroupType()

Returns

GroupClient

IncludeLocation()

Include related Location resources in the response.

public GroupClient IncludeLocation()

Returns

GroupClient

OrderByChatEnabled()

Sort response items by the ChatEnabled attribute.

public GroupClient OrderByChatEnabled()

Returns

GroupClient

OrderByChatEnabledDescending()

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

public GroupClient OrderByChatEnabledDescending()

Returns

GroupClient

OrderByContactEmail()

Sort response items by the ContactEmail attribute.

public GroupClient OrderByContactEmail()

Returns

GroupClient

OrderByContactEmailDescending()

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

public GroupClient OrderByContactEmailDescending()

Returns

GroupClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public GroupClient OrderByCreatedAt()

Returns

GroupClient

OrderByCreatedAtDescending()

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

public GroupClient OrderByCreatedAtDescending()

Returns

GroupClient

OrderByEnrollmentLimit()

Sort response items by the EnrollmentLimit attribute.

public GroupClient OrderByEnrollmentLimit()

Returns

GroupClient

OrderByEnrollmentLimitDescending()

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

public GroupClient OrderByEnrollmentLimitDescending()

Returns

GroupClient

OrderByListed()

Sort response items by the Listed attribute.

public GroupClient OrderByListed()

Returns

GroupClient

OrderByListedDescending()

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

public GroupClient OrderByListedDescending()

Returns

GroupClient

OrderByMembersAreConfidential()

Sort response items by the MembersAreConfidential attribute.

public GroupClient OrderByMembersAreConfidential()

Returns

GroupClient

OrderByMembersAreConfidentialDescending()

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

public GroupClient OrderByMembersAreConfidentialDescending()

Returns

GroupClient

OrderByMembershipsCount()

Sort response items by the MembershipsCount attribute.

public GroupClient OrderByMembershipsCount()

Returns

GroupClient

OrderByMembershipsCountDescending()

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

public GroupClient OrderByMembershipsCountDescending()

Returns

GroupClient

OrderByName()

Sort response items by the Name attribute.

public GroupClient OrderByName()

Returns

GroupClient

OrderByNameDescending()

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

public GroupClient OrderByNameDescending()

Returns

GroupClient

WhereArchiveStatus(string)

Query response items by the ArchiveStatus attribute.

public GroupClient WhereArchiveStatus(string value)

Parameters

value string

Returns

GroupClient

WhereName(string)

Query response items by the Name attribute.

public GroupClient WhereName(string value)

Parameters

value string

Returns

GroupClient

WithId(string)

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

public GroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

GroupClient

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