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>.AddCustomParameter(string, string)

ResourceClient<Chat>.ClearParameters()

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

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.

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.