Class PaginatedGroupTypeClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with GroupType collection resources.

public class PaginatedGroupTypeClient : PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>

Inheritance

object

ResourceClient<GroupType>

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>

PaginatedGroupTypeClient

Inherited Members

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.PerPage(int)

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.Offset(int)

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.Filter(string)

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.PostAsync(GroupType, CancellationToken)

PaginatedResourceClient<GroupType, GroupTypeResource, GroupTypeCollectionResponse, GroupTypeResponse>.PostAsync(JsonApiDocument<GroupTypeResource>, 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

PaginatedGroupTypeClient(HttpClient, Uri)

Client for interacting with GroupType collection resources.

public PaginatedGroupTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedGroupTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedGroupTypeClient

The current PaginatedGroupTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedGroupTypeClient ClearParameters()

Returns

PaginatedGroupTypeClient

The current PaginatedGroupTypeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedGroupTypeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedGroupTypeClient

The current PaginatedGroupTypeClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of GroupType resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GroupTypeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedGroupTypeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedGroupTypeClient

The current PaginatedGroupTypeClient instance.

OrderByName()

Sort response items by the Name attribute.

public GroupTypeClient OrderByName()

Returns

GroupTypeClient

OrderByNameDescending()

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

public GroupTypeClient OrderByNameDescending()

Returns

GroupTypeClient

OrderByPosition()

Sort response items by the Position attribute.

public GroupTypeClient OrderByPosition()

Returns

GroupTypeClient

OrderByPositionDescending()

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

public GroupTypeClient OrderByPositionDescending()

Returns

GroupTypeClient

PerPage(int)

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

public PaginatedGroupTypeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedGroupTypeClient

The current PaginatedGroupTypeClient instance.

WhereId(string)

Query response items by the Id attribute.

public GroupTypeClient WhereId(string value)

Parameters

value string

Returns

GroupTypeClient

WithId(string)

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

public GroupTypeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

GroupTypeClient

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