Class AnnouncementsCampusClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AnnouncementsCampus resource.

public class AnnouncementsCampusClient : SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>

Inheritance

object

ResourceClient<AnnouncementsCampus>

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>

AnnouncementsCampusClient

Inherited Members

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>.PatchAsync(AnnouncementsCampus, CancellationToken)

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>.PatchAsync(JsonApiDocument<AnnouncementsCampusResource>, CancellationToken)

SingletonResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusResponse>.DeleteAsync(CancellationToken)

ResourceClient<AnnouncementsCampus>.AddQueryParameter(string, string)

ResourceClient<AnnouncementsCampus>.ReplaceQueryParameter(string, string)

ResourceClient<AnnouncementsCampus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AnnouncementsCampus>.Uri

ResourceClient<AnnouncementsCampus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AnnouncementsCampusClient(HttpClient, Uri)

Client for interacting with the AnnouncementsCampus resource.

public AnnouncementsCampusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AnnouncementsCampusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AnnouncementsCampusClient

The current AnnouncementsCampusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AnnouncementsCampusClient ClearParameters()

Returns

AnnouncementsCampusClient

The current AnnouncementsCampusClient instance.

GetAsync(CancellationToken)

Fetches the AnnouncementsCampus resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementsCampusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.