Class PaginatedListShareClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ListShare collection resources.

public class PaginatedListShareClient : PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>

Inheritance

object

ResourceClient<ListShare>

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>

PaginatedListShareClient

Inherited Members

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.PerPage(int)

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.Offset(int)

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.Filter(string)

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.PostAsync(ListShare, CancellationToken)

PaginatedResourceClient<ListShare, ListShareResource, ListShareCollectionResponse, ListShareResponse>.PostAsync(JsonApiDocument<ListShareResource>, CancellationToken)

ResourceClient<ListShare>.AddQueryParameter(string, string)

ResourceClient<ListShare>.ReplaceQueryParameter(string, string)

ResourceClient<ListShare>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListShare>.Uri

ResourceClient<ListShare>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedListShareClient(HttpClient, Uri)

Client for interacting with ListShare collection resources.

public PaginatedListShareClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedListShareClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedListShareClient

The current PaginatedListShareClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedListShareClient ClearParameters()

Returns

PaginatedListShareClient

The current PaginatedListShareClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedListShareClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedListShareClient

The current PaginatedListShareClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ListShare resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public ListShareClient IncludePerson()

Returns

ListShareClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedListShareClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedListShareClient

The current PaginatedListShareClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ListShareClient OrderByCreatedAt()

Returns

ListShareClient

OrderByCreatedAtDescending()

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

public ListShareClient OrderByCreatedAtDescending()

Returns

ListShareClient

OrderByGroup()

Sort response items by the Group attribute.

public ListShareClient OrderByGroup()

Returns

ListShareClient

OrderByGroupDescending()

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

public ListShareClient OrderByGroupDescending()

Returns

ListShareClient

PerPage(int)

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

public PaginatedListShareClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedListShareClient

The current PaginatedListShareClient instance.

PostAsync(ListShare, CancellationToken)

Creates a new ListShare resource asynchronously.

public Task<ListShareResponse> PostAsync(ListShare resource, CancellationToken cancellationToken = default)

Parameters

resource ListShare

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareResponse>

A task representing the asynchronous operation, containing the created ListShare resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ListShareResource>, CancellationToken)

Creates a new ListShare resource asynchronously.

public Task<ListShareResponse> PostAsync(JsonApiDocument<ListShareResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ListShareResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareResponse>

A task representing the asynchronous operation, containing the created ListShare resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ListShareClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ListShareClient

WhereGroup(string)

Query response items by the Group attribute.

public ListShareClient WhereGroup(string value)

Parameters

value string

Returns

ListShareClient

WhereName(string)

Query response items by the Name attribute.

public ListShareClient WhereName(string value)

Parameters

value string

Returns

ListShareClient

WherePermission(string)

Query response items by the Permission attribute.

public ListShareClient WherePermission(string value)

Parameters

value string

Returns

ListShareClient

WithId(string)

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

public ListShareClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ListShareClient

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