Class MessageGroupClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the MessageGroup resource.

public class MessageGroupClient : SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>

Inheritance

object

ResourceClient<MessageGroup>

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>

MessageGroupClient

Inherited Members

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>.PatchAsync(MessageGroup, CancellationToken)

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>.PatchAsync(JsonApiDocument<MessageGroupResource>, CancellationToken)

SingletonResourceClient<MessageGroup, MessageGroupResource, MessageGroupResponse>.DeleteAsync(CancellationToken)

ResourceClient<MessageGroup>.AddQueryParameter(string, string)

ResourceClient<MessageGroup>.ReplaceQueryParameter(string, string)

ResourceClient<MessageGroup>.AddCustomParameter(string, string)

ResourceClient<MessageGroup>.ClearParameters()

ResourceClient<MessageGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MessageGroup>.Uri

ResourceClient<MessageGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MessageGroupClient(HttpClient, Uri)

Client for interacting with the MessageGroup resource.

public MessageGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

App

Associated App.

public AppClient App { get; }

Property Value

AppClient

From

Associated From.

public PersonClient From { get; }

Property Value

PersonClient

Messages

Associated Messages.

public PaginatedMessageClient Messages { get; }

Property Value

PaginatedMessageClient

Methods

GetAsync(CancellationToken)

Fetches the MessageGroup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MessageGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeApp()

Include related App resources in the response.

public MessageGroupClient IncludeApp()

Returns

MessageGroupClient

IncludeFrom()

Include related From resources in the response.

public MessageGroupClient IncludeFrom()

Returns

MessageGroupClient

IncludeMessages()

Include related Messages resources in the response.

public MessageGroupClient IncludeMessages()

Returns

MessageGroupClient