Class MessageClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Message resource.

public class MessageClient : SingletonResourceClient<Message, MessageResource, MessageResponse>

Inheritance

object

ResourceClient<Message>

SingletonResourceClient<Message, MessageResource, MessageResponse>

MessageClient

Inherited Members

SingletonResourceClient<Message, MessageResource, MessageResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Message, MessageResource, MessageResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Message, MessageResource, MessageResponse>.PatchAsync(Message, CancellationToken)

SingletonResourceClient<Message, MessageResource, MessageResponse>.PatchAsync(JsonApiDocument<MessageResource>, CancellationToken)

SingletonResourceClient<Message, MessageResource, MessageResponse>.DeleteAsync(CancellationToken)

ResourceClient<Message>.AddQueryParameter(string, string)

ResourceClient<Message>.ReplaceQueryParameter(string, string)

ResourceClient<Message>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Message>.Uri

ResourceClient<Message>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MessageClient(HttpClient, Uri)

Client for interacting with the Message resource.

public MessageClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

MessageGroup

Associated MessageGroup.

public MessageGroupClient MessageGroup { get; }

Property Value

MessageGroupClient

To

Associated To.

public PersonClient To { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public MessageClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

MessageClient

The current MessageClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public MessageClient ClearParameters()

Returns

MessageClient

The current MessageClient instance.

GetAsync(CancellationToken)

Fetches the Message resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MessageResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeMessageGroup()

Include related MessageGroup resources in the response.

public MessageClient IncludeMessageGroup()

Returns

MessageClient

IncludeTo()

Include related To resources in the response.

public MessageClient IncludeTo()

Returns

MessageClient