Class PaginatedAnnouncementClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Announcement collection resources.

public class PaginatedAnnouncementClient : PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>

Inheritance

object

ResourceClient<Announcement>

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>

PaginatedAnnouncementClient

Inherited Members

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.PerPage(int)

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.Offset(int)

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.Filter(string)

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.PostAsync(Announcement, CancellationToken)

PaginatedResourceClient<Announcement, AnnouncementResource, AnnouncementCollectionResponse, AnnouncementResponse>.PostAsync(JsonApiDocument<AnnouncementResource>, 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

PaginatedAnnouncementClient(HttpClient, Uri)

Client for interacting with Announcement collection resources.

public PaginatedAnnouncementClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAnnouncementClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAnnouncementClient

The current PaginatedAnnouncementClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAnnouncementClient ClearParameters()

Returns

PaginatedAnnouncementClient

The current PaginatedAnnouncementClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAnnouncementClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAnnouncementClient

The current PaginatedAnnouncementClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Announcement resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AnnouncementCollectionResponse>

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAnnouncementClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAnnouncementClient

The current PaginatedAnnouncementClient instance.

OrderByFeatured()

Sort response items by the Featured attribute.

public AnnouncementClient OrderByFeatured()

Returns

AnnouncementClient

OrderByFeaturedDescending()

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

public AnnouncementClient OrderByFeaturedDescending()

Returns

AnnouncementClient

OrderByPosition()

Sort response items by the Position attribute.

public AnnouncementClient OrderByPosition()

Returns

AnnouncementClient

OrderByPositionDescending()

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

public AnnouncementClient OrderByPositionDescending()

Returns

AnnouncementClient

OrderByShowAt()

Sort response items by the ShowAt attribute.

public AnnouncementClient OrderByShowAt()

Returns

AnnouncementClient

OrderByShowAtDescending()

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

public AnnouncementClient OrderByShowAtDescending()

Returns

AnnouncementClient

OrderByStatus()

Sort response items by the Status attribute.

public AnnouncementClient OrderByStatus()

Returns

AnnouncementClient

OrderByStatusDescending()

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

public AnnouncementClient OrderByStatusDescending()

Returns

AnnouncementClient

OrderByTitle()

Sort response items by the Title attribute.

public AnnouncementClient OrderByTitle()

Returns

AnnouncementClient

OrderByTitleDescending()

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

public AnnouncementClient OrderByTitleDescending()

Returns

AnnouncementClient

PerPage(int)

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

public PaginatedAnnouncementClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAnnouncementClient

The current PaginatedAnnouncementClient instance.

WhereTitle(string)

Query response items by the Title attribute.

public AnnouncementClient WhereTitle(string value)

Parameters

value string

Returns

AnnouncementClient

WithId(string)

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

public AnnouncementClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AnnouncementClient

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