Class AnnouncementCategoryClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AnnouncementCategory resource.

public class AnnouncementCategoryClient : SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>

Inheritance

object

ResourceClient<AnnouncementCategory>

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>

AnnouncementCategoryClient

Inherited Members

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>.PatchAsync(AnnouncementCategory, CancellationToken)

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>.PatchAsync(JsonApiDocument<AnnouncementCategoryResource>, CancellationToken)

SingletonResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<AnnouncementCategory>.AddQueryParameter(string, string)

ResourceClient<AnnouncementCategory>.ReplaceQueryParameter(string, string)

ResourceClient<AnnouncementCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AnnouncementCategory>.Uri

ResourceClient<AnnouncementCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AnnouncementCategoryClient(HttpClient, Uri)

Client for interacting with the AnnouncementCategory resource.

public AnnouncementCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AnnouncementCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AnnouncementCategoryClient

The current AnnouncementCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AnnouncementCategoryClient ClearParameters()

Returns

AnnouncementCategoryClient

The current AnnouncementCategoryClient instance.

GetAsync(CancellationToken)

Fetches the AnnouncementCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.