Class PlatformNotificationClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

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>.AddCustomParameter(string, string)

ResourceClient<PlatformNotification>.ClearParameters()

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

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.