Class PaginatedPlanImportMetadataClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanImportMetadata collection resources.

public class PaginatedPlanImportMetadataClient : PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>

Inheritance

object

ResourceClient<PlanImportMetadata>

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>

PaginatedPlanImportMetadataClient

Inherited Members

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.PerPage(int)

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.Offset(int)

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.Filter(string)

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.PostAsync(PlanImportMetadata, CancellationToken)

PaginatedResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataCollectionResponse, PlanImportMetadataResponse>.PostAsync(JsonApiDocument<PlanImportMetadataResource>, CancellationToken)

ResourceClient<PlanImportMetadata>.AddQueryParameter(string, string)

ResourceClient<PlanImportMetadata>.ReplaceQueryParameter(string, string)

ResourceClient<PlanImportMetadata>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanImportMetadata>.Uri

ResourceClient<PlanImportMetadata>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPlanImportMetadataClient(HttpClient, Uri)

Client for interacting with PlanImportMetadata collection resources.

public PaginatedPlanImportMetadataClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanImportMetadataClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanImportMetadataClient

The current PaginatedPlanImportMetadataClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanImportMetadataClient ClearParameters()

Returns

PaginatedPlanImportMetadataClient

The current PaginatedPlanImportMetadataClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanImportMetadataClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanImportMetadataClient

The current PaginatedPlanImportMetadataClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PlanImportMetadata resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanImportMetadataCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanImportMetadataClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanImportMetadataClient

The current PaginatedPlanImportMetadataClient instance.

PerPage(int)

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

public PaginatedPlanImportMetadataClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanImportMetadataClient

The current PaginatedPlanImportMetadataClient instance.

WithId(string)

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

public PlanImportMetadataClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanImportMetadataClient

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