Class PaginatedMessageGroupClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with MessageGroup collection resources.

public class PaginatedMessageGroupClient : PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>

Inheritance

object

ResourceClient<MessageGroup>

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>

PaginatedMessageGroupClient

Inherited Members

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.PerPage(int)

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.Offset(int)

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.Filter(string)

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.PostAsync(MessageGroup, CancellationToken)

PaginatedResourceClient<MessageGroup, MessageGroupResource, MessageGroupCollectionResponse, MessageGroupResponse>.PostAsync(JsonApiDocument<MessageGroupResource>, 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

PaginatedMessageGroupClient(HttpClient, Uri)

Client for interacting with MessageGroup collection resources.

public PaginatedMessageGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of MessageGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MessageGroupCollectionResponse>

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

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

OrderByContainsUserGeneratedContent()

Sort response items by the ContainsUserGeneratedContent attribute.

public MessageGroupClient OrderByContainsUserGeneratedContent()

Returns

MessageGroupClient

OrderByContainsUserGeneratedContentDescending()

Sort response items by the ContainsUserGeneratedContent attribute. Use reverse order.

public MessageGroupClient OrderByContainsUserGeneratedContentDescending()

Returns

MessageGroupClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public MessageGroupClient OrderByCreatedAt()

Returns

MessageGroupClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public MessageGroupClient OrderByCreatedAtDescending()

Returns

MessageGroupClient

OrderByFromAddress()

Sort response items by the FromAddress attribute.

public MessageGroupClient OrderByFromAddress()

Returns

MessageGroupClient

OrderByFromAddressDescending()

Sort response items by the FromAddress attribute. Use reverse order.

public MessageGroupClient OrderByFromAddressDescending()

Returns

MessageGroupClient

OrderByMessageCount()

Sort response items by the MessageCount attribute.

public MessageGroupClient OrderByMessageCount()

Returns

MessageGroupClient

OrderByMessageCountDescending()

Sort response items by the MessageCount attribute. Use reverse order.

public MessageGroupClient OrderByMessageCountDescending()

Returns

MessageGroupClient

OrderByMessageType()

Sort response items by the MessageType attribute.

public MessageGroupClient OrderByMessageType()

Returns

MessageGroupClient

OrderByMessageTypeDescending()

Sort response items by the MessageType attribute. Use reverse order.

public MessageGroupClient OrderByMessageTypeDescending()

Returns

MessageGroupClient

OrderByReplyToAddress()

Sort response items by the ReplyToAddress attribute.

public MessageGroupClient OrderByReplyToAddress()

Returns

MessageGroupClient

OrderByReplyToAddressDescending()

Sort response items by the ReplyToAddress attribute. Use reverse order.

public MessageGroupClient OrderByReplyToAddressDescending()

Returns

MessageGroupClient

OrderByReplyToName()

Sort response items by the ReplyToName attribute.

public MessageGroupClient OrderByReplyToName()

Returns

MessageGroupClient

OrderByReplyToNameDescending()

Sort response items by the ReplyToName attribute. Use reverse order.

public MessageGroupClient OrderByReplyToNameDescending()

Returns

MessageGroupClient

OrderBySubject()

Sort response items by the Subject attribute.

public MessageGroupClient OrderBySubject()

Returns

MessageGroupClient

OrderBySubjectDescending()

Sort response items by the Subject attribute. Use reverse order.

public MessageGroupClient OrderBySubjectDescending()

Returns

MessageGroupClient

OrderBySystemMessage()

Sort response items by the SystemMessage attribute.

public MessageGroupClient OrderBySystemMessage()

Returns

MessageGroupClient

OrderBySystemMessageDescending()

Sort response items by the SystemMessage attribute. Use reverse order.

public MessageGroupClient OrderBySystemMessageDescending()

Returns

MessageGroupClient

OrderByTransactionalMessage()

Sort response items by the TransactionalMessage attribute.

public MessageGroupClient OrderByTransactionalMessage()

Returns

MessageGroupClient

OrderByTransactionalMessageDescending()

Sort response items by the TransactionalMessage attribute. Use reverse order.

public MessageGroupClient OrderByTransactionalMessageDescending()

Returns

MessageGroupClient

OrderByUuid()

Sort response items by the Uuid attribute.

public MessageGroupClient OrderByUuid()

Returns

MessageGroupClient

OrderByUuidDescending()

Sort response items by the Uuid attribute. Use reverse order.

public MessageGroupClient OrderByUuidDescending()

Returns

MessageGroupClient

WhereContainsUserGeneratedContent(bool)

Query response items by the ContainsUserGeneratedContent attribute.

public MessageGroupClient WhereContainsUserGeneratedContent(bool value)

Parameters

value bool

Returns

MessageGroupClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public MessageGroupClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

MessageGroupClient

WhereFromAddress(string)

Query response items by the FromAddress attribute.

public MessageGroupClient WhereFromAddress(string value)

Parameters

value string

Returns

MessageGroupClient

WhereMessageCount(int)

Query response items by the MessageCount attribute.

public MessageGroupClient WhereMessageCount(int value)

Parameters

value int

Returns

MessageGroupClient

WhereMessageType(string)

Query response items by the MessageType attribute.

public MessageGroupClient WhereMessageType(string value)

Parameters

value string

Returns

MessageGroupClient

WhereReplyToAddress(string)

Query response items by the ReplyToAddress attribute.

public MessageGroupClient WhereReplyToAddress(string value)

Parameters

value string

Returns

MessageGroupClient

WhereReplyToName(string)

Query response items by the ReplyToName attribute.

public MessageGroupClient WhereReplyToName(string value)

Parameters

value string

Returns

MessageGroupClient

WhereSubject(string)

Query response items by the Subject attribute.

public MessageGroupClient WhereSubject(string value)

Parameters

value string

Returns

MessageGroupClient

WhereSystemMessage(bool)

Query response items by the SystemMessage attribute.

public MessageGroupClient WhereSystemMessage(bool value)

Parameters

value bool

Returns

MessageGroupClient

WhereTransactionalMessage(bool)

Query response items by the TransactionalMessage attribute.

public MessageGroupClient WhereTransactionalMessage(bool value)

Parameters

value bool

Returns

MessageGroupClient

WhereUuid(string)

Query response items by the Uuid attribute.

public MessageGroupClient WhereUuid(string value)

Parameters

value string

Returns

MessageGroupClient

WithId(string)

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

public MessageGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MessageGroupClient

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