Class PaginatedResourceApprovalGroupClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ResourceApprovalGroup collection resources.

public class PaginatedResourceApprovalGroupClient : PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>

Inheritance

object

ResourceClient<ResourceApprovalGroup>

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>

PaginatedResourceApprovalGroupClient

Inherited Members

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.PerPage(int)

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.Offset(int)

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.Filter(string)

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.PostAsync(ResourceApprovalGroup, CancellationToken)

PaginatedResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupCollectionResponse, ResourceApprovalGroupResponse>.PostAsync(JsonApiDocument<ResourceApprovalGroupResource>, CancellationToken)

ResourceClient<ResourceApprovalGroup>.AddQueryParameter(string, string)

ResourceClient<ResourceApprovalGroup>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceApprovalGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceApprovalGroup>.Uri

ResourceClient<ResourceApprovalGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedResourceApprovalGroupClient(HttpClient, Uri)

Client for interacting with ResourceApprovalGroup collection resources.

public PaginatedResourceApprovalGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedResourceApprovalGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedResourceApprovalGroupClient

The current PaginatedResourceApprovalGroupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedResourceApprovalGroupClient ClearParameters()

Returns

PaginatedResourceApprovalGroupClient

The current PaginatedResourceApprovalGroupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedResourceApprovalGroupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedResourceApprovalGroupClient

The current PaginatedResourceApprovalGroupClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ResourceApprovalGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceApprovalGroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePeople()

Include related People resources in the response.

public ResourceApprovalGroupClient IncludePeople()

Returns

ResourceApprovalGroupClient

IncludeResources()

Include related Resources resources in the response.

public ResourceApprovalGroupClient IncludeResources()

Returns

ResourceApprovalGroupClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedResourceApprovalGroupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedResourceApprovalGroupClient

The current PaginatedResourceApprovalGroupClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ResourceApprovalGroupClient OrderByCreatedAt()

Returns

ResourceApprovalGroupClient

OrderByCreatedAtDescending()

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

public ResourceApprovalGroupClient OrderByCreatedAtDescending()

Returns

ResourceApprovalGroupClient

OrderByName()

Sort response items by the Name attribute.

public ResourceApprovalGroupClient OrderByName()

Returns

ResourceApprovalGroupClient

OrderByNameDescending()

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

public ResourceApprovalGroupClient OrderByNameDescending()

Returns

ResourceApprovalGroupClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ResourceApprovalGroupClient OrderByUpdatedAt()

Returns

ResourceApprovalGroupClient

OrderByUpdatedAtDescending()

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

public ResourceApprovalGroupClient OrderByUpdatedAtDescending()

Returns

ResourceApprovalGroupClient

PerPage(int)

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

public PaginatedResourceApprovalGroupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedResourceApprovalGroupClient

The current PaginatedResourceApprovalGroupClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ResourceApprovalGroupClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceApprovalGroupClient

WhereId(string)

Query response items by the Id attribute.

public ResourceApprovalGroupClient WhereId(string value)

Parameters

value string

Returns

ResourceApprovalGroupClient

WhereName(string)

Query response items by the Name attribute.

public ResourceApprovalGroupClient WhereName(string value)

Parameters

value string

Returns

ResourceApprovalGroupClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ResourceApprovalGroupClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceApprovalGroupClient

WithId(string)

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

public ResourceApprovalGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceApprovalGroupClient

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