Class PaginatedChatClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Chat collection resources.

public class PaginatedChatClient : PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>

Inheritance

object

ResourceClient<Chat>

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>

PaginatedChatClient

Inherited Members

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.PerPage(int)

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.Offset(int)

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.Filter(string)

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.PostAsync(Chat, CancellationToken)

PaginatedResourceClient<Chat, ChatResource, ChatCollectionResponse, ChatResponse>.PostAsync(JsonApiDocument<ChatResource>, CancellationToken)

ResourceClient<Chat>.AddQueryParameter(string, string)

ResourceClient<Chat>.ReplaceQueryParameter(string, string)

ResourceClient<Chat>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Chat>.Uri

ResourceClient<Chat>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedChatClient(HttpClient, Uri)

Client for interacting with Chat collection resources.

public PaginatedChatClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedChatClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedChatClient

The current PaginatedChatClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedChatClient ClearParameters()

Returns

PaginatedChatClient

The current PaginatedChatClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedChatClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedChatClient

The current PaginatedChatClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Chat resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChatCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedChatClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedChatClient

The current PaginatedChatClient instance.

PerPage(int)

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

public PaginatedChatClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedChatClient

The current PaginatedChatClient instance.

WithId(string)

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

public ChatClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ChatClient

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