Class PlatformNotificationClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlatformNotification resource.

public class PlatformNotificationClient : SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>

Inheritance

object

ResourceClient<PlatformNotification>

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>

PlatformNotificationClient

Inherited Members

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>.PatchAsync(PlatformNotification, CancellationToken)

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>.PatchAsync(JsonApiDocument<PlatformNotificationResource>, CancellationToken)

SingletonResourceClient<PlatformNotification, PlatformNotificationResource, PlatformNotificationResponse>.DeleteAsync(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

PlatformNotificationClient(HttpClient, Uri)

Client for interacting with the PlatformNotification resource.

public PlatformNotificationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PlatformNotificationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PlatformNotificationClient

The current PlatformNotificationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PlatformNotificationClient ClearParameters()

Returns

PlatformNotificationClient

The current PlatformNotificationClient instance.

GetAsync(CancellationToken)

Fetches the PlatformNotification resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlatformNotificationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.