Class PaginatedAnnouncementCategoryClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AnnouncementCategory collection resources.

public class PaginatedAnnouncementCategoryClient : PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>

Inheritance

object

ResourceClient<AnnouncementCategory>

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>

PaginatedAnnouncementCategoryClient

Inherited Members

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.PerPage(int)

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.Offset(int)

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.Filter(string)

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.PostAsync(AnnouncementCategory, CancellationToken)

PaginatedResourceClient<AnnouncementCategory, AnnouncementCategoryResource, AnnouncementCategoryCollectionResponse, AnnouncementCategoryResponse>.PostAsync(JsonApiDocument<AnnouncementCategoryResource>, 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

PaginatedAnnouncementCategoryClient(HttpClient, Uri)

Client for interacting with AnnouncementCategory collection resources.

public PaginatedAnnouncementCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAnnouncementCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAnnouncementCategoryClient

The current PaginatedAnnouncementCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAnnouncementCategoryClient ClearParameters()

Returns

PaginatedAnnouncementCategoryClient

The current PaginatedAnnouncementCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAnnouncementCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAnnouncementCategoryClient

The current PaginatedAnnouncementCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of AnnouncementCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAnnouncementCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAnnouncementCategoryClient

The current PaginatedAnnouncementCategoryClient instance.

OrderByName()

Sort response items by the Name attribute.

public AnnouncementCategoryClient OrderByName()

Returns

AnnouncementCategoryClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public AnnouncementCategoryClient OrderByNameDescending()

Returns

AnnouncementCategoryClient

PerPage(int)

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

public PaginatedAnnouncementCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAnnouncementCategoryClient

The current PaginatedAnnouncementCategoryClient instance.

WithId(string)

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

public AnnouncementCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AnnouncementCategoryClient

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