Class AnnouncementsAnnouncementCategoryClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AnnouncementsAnnouncementCategory resource.

public class AnnouncementsAnnouncementCategoryClient : SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>

Inheritance

object

ResourceClient<AnnouncementsAnnouncementCategory>

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>

AnnouncementsAnnouncementCategoryClient

Inherited Members

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>.PatchAsync(AnnouncementsAnnouncementCategory, CancellationToken)

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>.PatchAsync(JsonApiDocument<AnnouncementsAnnouncementCategoryResource>, CancellationToken)

SingletonResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<AnnouncementsAnnouncementCategory>.AddQueryParameter(string, string)

ResourceClient<AnnouncementsAnnouncementCategory>.ReplaceQueryParameter(string, string)

ResourceClient<AnnouncementsAnnouncementCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AnnouncementsAnnouncementCategory>.Uri

ResourceClient<AnnouncementsAnnouncementCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AnnouncementsAnnouncementCategoryClient(HttpClient, Uri)

Client for interacting with the AnnouncementsAnnouncementCategory resource.

public AnnouncementsAnnouncementCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AnnouncementCategory

Associated AnnouncementCategory.

public AnnouncementCategoryClient AnnouncementCategory { get; }

Property Value

AnnouncementCategoryClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AnnouncementsAnnouncementCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AnnouncementsAnnouncementCategoryClient

The current AnnouncementsAnnouncementCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AnnouncementsAnnouncementCategoryClient ClearParameters()

Returns

AnnouncementsAnnouncementCategoryClient

The current AnnouncementsAnnouncementCategoryClient instance.

GetAsync(CancellationToken)

Fetches the AnnouncementsAnnouncementCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementsAnnouncementCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAnnouncementCategory()

Include related AnnouncementCategory resources in the response.

public AnnouncementsAnnouncementCategoryClient IncludeAnnouncementCategory()

Returns

AnnouncementsAnnouncementCategoryClient