Class PaginatedAnnouncementsCampusClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AnnouncementsCampus collection resources.

public class PaginatedAnnouncementsCampusClient : PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>

Inheritance

object

ResourceClient<AnnouncementsCampus>

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>

PaginatedAnnouncementsCampusClient

Inherited Members

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.PerPage(int)

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.Offset(int)

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.Filter(string)

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.PostAsync(AnnouncementsCampus, CancellationToken)

PaginatedResourceClient<AnnouncementsCampus, AnnouncementsCampusResource, AnnouncementsCampusCollectionResponse, AnnouncementsCampusResponse>.PostAsync(JsonApiDocument<AnnouncementsCampusResource>, 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

PaginatedAnnouncementsCampusClient(HttpClient, Uri)

Client for interacting with AnnouncementsCampus collection resources.

public PaginatedAnnouncementsCampusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAnnouncementsCampusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAnnouncementsCampusClient

The current PaginatedAnnouncementsCampusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAnnouncementsCampusClient ClearParameters()

Returns

PaginatedAnnouncementsCampusClient

The current PaginatedAnnouncementsCampusClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAnnouncementsCampusClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAnnouncementsCampusClient

The current PaginatedAnnouncementsCampusClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of AnnouncementsCampus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementsCampusCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAnnouncementsCampusClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAnnouncementsCampusClient

The current PaginatedAnnouncementsCampusClient instance.

PerPage(int)

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

public PaginatedAnnouncementsCampusClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAnnouncementsCampusClient

The current PaginatedAnnouncementsCampusClient instance.

WithId(string)

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

public AnnouncementsCampusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AnnouncementsCampusClient

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