Class PaginatedAnnouncementsAnnouncementCategoryClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AnnouncementsAnnouncementCategory collection resources.

public class PaginatedAnnouncementsAnnouncementCategoryClient : PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>

Inheritance

object

ResourceClient<AnnouncementsAnnouncementCategory>

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>

PaginatedAnnouncementsAnnouncementCategoryClient

Inherited Members

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.PerPage(int)

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.Offset(int)

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.Filter(string)

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.PostAsync(AnnouncementsAnnouncementCategory, CancellationToken)

PaginatedResourceClient<AnnouncementsAnnouncementCategory, AnnouncementsAnnouncementCategoryResource, AnnouncementsAnnouncementCategoryCollectionResponse, AnnouncementsAnnouncementCategoryResponse>.PostAsync(JsonApiDocument<AnnouncementsAnnouncementCategoryResource>, 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

PaginatedAnnouncementsAnnouncementCategoryClient(HttpClient, Uri)

Client for interacting with AnnouncementsAnnouncementCategory collection resources.

public PaginatedAnnouncementsAnnouncementCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAnnouncementsAnnouncementCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAnnouncementsAnnouncementCategoryClient

The current PaginatedAnnouncementsAnnouncementCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAnnouncementsAnnouncementCategoryClient ClearParameters()

Returns

PaginatedAnnouncementsAnnouncementCategoryClient

The current PaginatedAnnouncementsAnnouncementCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAnnouncementsAnnouncementCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAnnouncementsAnnouncementCategoryClient

The current PaginatedAnnouncementsAnnouncementCategoryClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of AnnouncementsAnnouncementCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementsAnnouncementCategoryCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of AnnouncementsAnnouncementCategory resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAnnouncementsAnnouncementCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAnnouncementsAnnouncementCategoryClient

The current PaginatedAnnouncementsAnnouncementCategoryClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedAnnouncementsAnnouncementCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAnnouncementsAnnouncementCategoryClient

The current PaginatedAnnouncementsAnnouncementCategoryClient instance.

WithId(string)

Creates a new instance of a AnnouncementsAnnouncementCategory client for a specific resource ID.

public AnnouncementsAnnouncementCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AnnouncementsAnnouncementCategoryClient

A new instance of the resource client for the specified resource ID.