Class PaginatedCustomSenderClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with CustomSender collection resources.

public class PaginatedCustomSenderClient : PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>

Inheritance

object

ResourceClient<CustomSender>

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>

PaginatedCustomSenderClient

Inherited Members

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.PerPage(int)

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.Offset(int)

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.Filter(string)

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.PostAsync(CustomSender, CancellationToken)

PaginatedResourceClient<CustomSender, CustomSenderResource, CustomSenderCollectionResponse, CustomSenderResponse>.PostAsync(JsonApiDocument<CustomSenderResource>, CancellationToken)

ResourceClient<CustomSender>.AddQueryParameter(string, string)

ResourceClient<CustomSender>.ReplaceQueryParameter(string, string)

ResourceClient<CustomSender>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CustomSender>.Uri

ResourceClient<CustomSender>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCustomSenderClient(HttpClient, Uri)

Client for interacting with CustomSender collection resources.

public PaginatedCustomSenderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCustomSenderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCustomSenderClient

The current PaginatedCustomSenderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCustomSenderClient ClearParameters()

Returns

PaginatedCustomSenderClient

The current PaginatedCustomSenderClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCustomSenderClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCustomSenderClient

The current PaginatedCustomSenderClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of CustomSender resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSenderCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCustomSenderClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCustomSenderClient

The current PaginatedCustomSenderClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public CustomSenderClient OrderByCreatedAt()

Returns

CustomSenderClient

OrderByCreatedAtDescending()

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

public CustomSenderClient OrderByCreatedAtDescending()

Returns

CustomSenderClient

OrderByName()

Sort response items by the Name attribute.

public CustomSenderClient OrderByName()

Returns

CustomSenderClient

OrderByNameDescending()

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

public CustomSenderClient OrderByNameDescending()

Returns

CustomSenderClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public CustomSenderClient OrderByUpdatedAt()

Returns

CustomSenderClient

OrderByUpdatedAtDescending()

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

public CustomSenderClient OrderByUpdatedAtDescending()

Returns

CustomSenderClient

OrderByVerificationRequestedAt()

Sort response items by the VerificationRequestedAt attribute.

public CustomSenderClient OrderByVerificationRequestedAt()

Returns

CustomSenderClient

OrderByVerificationRequestedAtDescending()

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

public CustomSenderClient OrderByVerificationRequestedAtDescending()

Returns

CustomSenderClient

OrderByVerifiedAt()

Sort response items by the VerifiedAt attribute.

public CustomSenderClient OrderByVerifiedAt()

Returns

CustomSenderClient

OrderByVerifiedAtDescending()

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

public CustomSenderClient OrderByVerifiedAtDescending()

Returns

CustomSenderClient

PerPage(int)

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

public PaginatedCustomSenderClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCustomSenderClient

The current PaginatedCustomSenderClient instance.

WithId(string)

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

public CustomSenderClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CustomSenderClient

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