Class PaginatedEmergencyContactClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EmergencyContact collection resources.

public class PaginatedEmergencyContactClient : PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>

Inheritance

object

ResourceClient<EmergencyContact>

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>

PaginatedEmergencyContactClient

Inherited Members

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.PerPage(int)

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.Offset(int)

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.Filter(string)

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.PostAsync(EmergencyContact, CancellationToken)

PaginatedResourceClient<EmergencyContact, EmergencyContactResource, EmergencyContactCollectionResponse, EmergencyContactResponse>.PostAsync(JsonApiDocument<EmergencyContactResource>, CancellationToken)

ResourceClient<EmergencyContact>.AddQueryParameter(string, string)

ResourceClient<EmergencyContact>.ReplaceQueryParameter(string, string)

ResourceClient<EmergencyContact>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EmergencyContact>.Uri

ResourceClient<EmergencyContact>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEmergencyContactClient(HttpClient, Uri)

Client for interacting with EmergencyContact collection resources.

public PaginatedEmergencyContactClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEmergencyContactClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEmergencyContactClient

The current PaginatedEmergencyContactClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEmergencyContactClient ClearParameters()

Returns

PaginatedEmergencyContactClient

The current PaginatedEmergencyContactClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEmergencyContactClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEmergencyContactClient

The current PaginatedEmergencyContactClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EmergencyContact resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmergencyContactCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEmergencyContactClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEmergencyContactClient

The current PaginatedEmergencyContactClient instance.

PerPage(int)

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

public PaginatedEmergencyContactClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEmergencyContactClient

The current PaginatedEmergencyContactClient instance.

WithId(string)

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

public EmergencyContactClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EmergencyContactClient

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