Class PaginatedPlatformNotificationClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlatformNotification collection resources.

public class PaginatedPlatformNotificationClient : PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>

Inheritance

object

ResourceClient<PlatformNotification>

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>

PaginatedPlatformNotificationClient

Inherited Members

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.PerPage(int)

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.Offset(int)

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.Filter(string)

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.PostAsync(PlatformNotification, CancellationToken)

PaginatedResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationCollectionResponse, PlatformNotificationResponse>.PostAsync(JsonApiDocument<PlatformNotificationResource>, CancellationToken)

ResourceClient<PlatformNotification>.AddQueryParameter(string, string)

ResourceClient<PlatformNotification>.ReplaceQueryParameter(string, string)

ResourceClient<PlatformNotification>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlatformNotification>.Uri

ResourceClient<PlatformNotification>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPlatformNotificationClient(HttpClient, Uri)

Client for interacting with PlatformNotification collection resources.

public PaginatedPlatformNotificationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlatformNotificationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlatformNotificationClient

The current PaginatedPlatformNotificationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlatformNotificationClient ClearParameters()

Returns

PaginatedPlatformNotificationClient

The current PaginatedPlatformNotificationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlatformNotificationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlatformNotificationClient

The current PaginatedPlatformNotificationClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of PlatformNotification resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlatformNotificationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlatformNotificationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlatformNotificationClient

The current PaginatedPlatformNotificationClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedPlatformNotificationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlatformNotificationClient

The current PaginatedPlatformNotificationClient instance.

WithId(string)

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

public PlatformNotificationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlatformNotificationClient

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