Class PaginatedMessageClient

Namespace

Crews.PlanningCenter.Api.People.V2023_03_21

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Message collection resources.

public class PaginatedMessageClient : PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>

Inheritance

object

ResourceClient<Message>

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>

PaginatedMessageClient

Inherited Members

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.PerPage(int)

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.Offset(int)

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.Filter(string)

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.PostAsync(Message, CancellationToken)

PaginatedResourceClient<Message, MessageResource, MessageCollectionResponse, MessageResponse>.PostAsync(JsonApiDocument<MessageResource>, CancellationToken)

ResourceClient<Message>.AddQueryParameter(string, string)

ResourceClient<Message>.ReplaceQueryParameter(string, string)

ResourceClient<Message>.AddCustomParameter(string, string)

ResourceClient<Message>.ClearParameters()

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

PaginatedMessageClient(HttpClient, Uri)

Client for interacting with Message collection resources.

public PaginatedMessageClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Message resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MessageCollectionResponse>

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

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

OrderByAppName()

Sort response items by the AppName attribute.

public MessageClient OrderByAppName()

Returns

MessageClient

OrderByAppNameDescending()

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

public MessageClient OrderByAppNameDescending()

Returns

MessageClient

OrderByBouncedAt()

Sort response items by the BouncedAt attribute.

public MessageClient OrderByBouncedAt()

Returns

MessageClient

OrderByBouncedAtDescending()

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

public MessageClient OrderByBouncedAtDescending()

Returns

MessageClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public MessageClient OrderByCreatedAt()

Returns

MessageClient

OrderByCreatedAtDescending()

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

public MessageClient OrderByCreatedAtDescending()

Returns

MessageClient

OrderByDeliveryStatus()

Sort response items by the DeliveryStatus attribute.

public MessageClient OrderByDeliveryStatus()

Returns

MessageClient

OrderByDeliveryStatusDescending()

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

public MessageClient OrderByDeliveryStatusDescending()

Returns

MessageClient

OrderByFile()

Sort response items by the File attribute.

public MessageClient OrderByFile()

Returns

MessageClient

OrderByFileDescending()

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

public MessageClient OrderByFileDescending()

Returns

MessageClient

OrderByFromAddress()

Sort response items by the FromAddress attribute.

public MessageClient OrderByFromAddress()

Returns

MessageClient

OrderByFromAddressDescending()

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

public MessageClient OrderByFromAddressDescending()

Returns

MessageClient

OrderByFromName()

Sort response items by the FromName attribute.

public MessageClient OrderByFromName()

Returns

MessageClient

OrderByFromNameDescending()

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

public MessageClient OrderByFromNameDescending()

Returns

MessageClient

OrderByKind()

Sort response items by the Kind attribute.

public MessageClient OrderByKind()

Returns

MessageClient

OrderByKindDescending()

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

public MessageClient OrderByKindDescending()

Returns

MessageClient

OrderByRejectReason()

Sort response items by the RejectReason attribute.

public MessageClient OrderByRejectReason()

Returns

MessageClient

OrderByRejectReasonDescending()

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

public MessageClient OrderByRejectReasonDescending()

Returns

MessageClient

OrderByRejectionNotificationSentAt()

Sort response items by the RejectionNotificationSentAt attribute.

public MessageClient OrderByRejectionNotificationSentAt()

Returns

MessageClient

OrderByRejectionNotificationSentAtDescending()

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

public MessageClient OrderByRejectionNotificationSentAtDescending()

Returns

MessageClient

OrderBySentAt()

Sort response items by the SentAt attribute.

public MessageClient OrderBySentAt()

Returns

MessageClient

OrderBySentAtDescending()

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

public MessageClient OrderBySentAtDescending()

Returns

MessageClient

OrderBySubject()

Sort response items by the Subject attribute.

public MessageClient OrderBySubject()

Returns

MessageClient

OrderBySubjectDescending()

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

public MessageClient OrderBySubjectDescending()

Returns

MessageClient

OrderByToAddresses()

Sort response items by the ToAddresses attribute.

public MessageClient OrderByToAddresses()

Returns

MessageClient

OrderByToAddressesDescending()

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

public MessageClient OrderByToAddressesDescending()

Returns

MessageClient

WhereAppName(string)

Query response items by the AppName attribute.

public MessageClient WhereAppName(string value)

Parameters

value string

Returns

MessageClient

WhereBouncedAt(DateTime)

Query response items by the BouncedAt attribute.

public MessageClient WhereBouncedAt(DateTime value)

Parameters

value DateTime

Returns

MessageClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public MessageClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

MessageClient

WhereDeliveryStatus(string)

Query response items by the DeliveryStatus attribute.

public MessageClient WhereDeliveryStatus(string value)

Parameters

value string

Returns

MessageClient

WhereFile(string)

Query response items by the File attribute.

public MessageClient WhereFile(string value)

Parameters

value string

Returns

MessageClient

WhereFromAddress(string)

Query response items by the FromAddress attribute.

public MessageClient WhereFromAddress(string value)

Parameters

value string

Returns

MessageClient

WhereKind(string)

Query response items by the Kind attribute.

public MessageClient WhereKind(string value)

Parameters

value string

Returns

MessageClient

WhereRejectReason(string)

Query response items by the RejectReason attribute.

public MessageClient WhereRejectReason(string value)

Parameters

value string

Returns

MessageClient

WhereRejectionNotificationSentAt(DateTime)

Query response items by the RejectionNotificationSentAt attribute.

public MessageClient WhereRejectionNotificationSentAt(DateTime value)

Parameters

value DateTime

Returns

MessageClient

WhereSentAt(DateTime)

Query response items by the SentAt attribute.

public MessageClient WhereSentAt(DateTime value)

Parameters

value DateTime

Returns

MessageClient

WhereSubject(string)

Query response items by the Subject attribute.

public MessageClient WhereSubject(string value)

Parameters

value string

Returns

MessageClient

WhereToAddresses(string)

Query response items by the ToAddresses attribute.

public MessageClient WhereToAddresses(string value)

Parameters

value string

Returns

MessageClient

WithId(string)

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

public MessageClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MessageClient

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