Class ChatClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Chat resource.

public class ChatClient : SingletonResourceClient<Chat, ChatResource, ChatResponse>

Inheritance

object

ResourceClient<Chat>

SingletonResourceClient<Chat, ChatResource, ChatResponse>

ChatClient

Inherited Members

SingletonResourceClient<Chat, ChatResource, ChatResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Chat, ChatResource, ChatResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Chat, ChatResource, ChatResponse>.PatchAsync(Chat, CancellationToken)

SingletonResourceClient<Chat, ChatResource, ChatResponse>.PatchAsync(JsonApiDocument<ChatResource>, CancellationToken)

SingletonResourceClient<Chat, ChatResource, ChatResponse>.DeleteAsync(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

ChatClient(HttpClient, Uri)

Client for interacting with the Chat resource.

public ChatClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ChatClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ChatClient

The current ChatClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ChatClient ClearParameters()

Returns

ChatClient

The current ChatClient instance.

GetAsync(CancellationToken)

Fetches the Chat resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChatResponse>

A task representing the asynchronous operation, containing the Chat resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.