Class AnnouncementClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Announcement resource.

public class AnnouncementClient : SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>

Inheritance

object

ResourceClient<Announcement>

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>

AnnouncementClient

Inherited Members

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>.PatchAsync(Announcement, CancellationToken)

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>.PatchAsync(JsonApiDocument<AnnouncementResource>, CancellationToken)

SingletonResourceClient<Announcement, AnnouncementResource, AnnouncementResponse>.DeleteAsync(CancellationToken)

ResourceClient<Announcement>.AddQueryParameter(string, string)

ResourceClient<Announcement>.ReplaceQueryParameter(string, string)

ResourceClient<Announcement>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Announcement>.Uri

ResourceClient<Announcement>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AnnouncementClient(HttpClient, Uri)

Client for interacting with the Announcement resource.

public AnnouncementClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AnnouncementsAnnouncementCategories

Associated AnnouncementsAnnouncementCategories.

public PaginatedAnnouncementsAnnouncementCategoryClient AnnouncementsAnnouncementCategories { get; }

Property Value

PaginatedAnnouncementsAnnouncementCategoryClient

AnnouncementsCampuses

Associated AnnouncementsCampuses.

public PaginatedAnnouncementsCampusClient AnnouncementsCampuses { get; }

Property Value

PaginatedAnnouncementsCampusClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AnnouncementClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AnnouncementClient

The current AnnouncementClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AnnouncementClient ClearParameters()

Returns

AnnouncementClient

The current AnnouncementClient instance.

GetAsync(CancellationToken)

Fetches the Announcement resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAnnouncementsAnnouncementCategories()

Include related AnnouncementsAnnouncementCategories resources in the response.

public AnnouncementClient IncludeAnnouncementsAnnouncementCategories()

Returns

AnnouncementClient

IncludeAnnouncementsCampuses()

Include related AnnouncementsCampuses resources in the response.

public AnnouncementClient IncludeAnnouncementsCampuses()

Returns

AnnouncementClient