Class ReportClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Report resource.

public class ReportClient : SingletonResourceClient<Report, ReportResource, ReportResponse>

Inheritance

object

ResourceClient<Report>

SingletonResourceClient<Report, ReportResource, ReportResponse>

ReportClient

Inherited Members

SingletonResourceClient<Report, ReportResource, ReportResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Report, ReportResource, ReportResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Report, ReportResource, ReportResponse>.PatchAsync(Report, CancellationToken)

SingletonResourceClient<Report, ReportResource, ReportResponse>.PatchAsync(JsonApiDocument<ReportResource>, CancellationToken)

SingletonResourceClient<Report, ReportResource, ReportResponse>.DeleteAsync(CancellationToken)

ResourceClient<Report>.AddQueryParameter(string, string)

ResourceClient<Report>.ReplaceQueryParameter(string, string)

ResourceClient<Report>.AddCustomParameter(string, string)

ResourceClient<Report>.ClearParameters()

ResourceClient<Report>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Report>.Uri

ResourceClient<Report>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ReportClient(HttpClient, Uri)

Client for interacting with the Report resource.

public ReportClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

UpdatedBy

Associated UpdatedBy.

public PersonClient UpdatedBy { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

Deletes the Report resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Report resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportResponse>

A task representing the asynchronous operation, containing the Report resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public ReportClient IncludeCreatedBy()

Returns

ReportClient

IncludeUpdatedBy()

Include related UpdatedBy resources in the response.

public ReportClient IncludeUpdatedBy()

Returns

ReportClient

PatchAsync(Report, CancellationToken)

Updates an existing Report resource asynchronously.

public Task<ReportResponse> PatchAsync(Report resource, CancellationToken cancellationToken = default)

Parameters

resource Report

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportResponse>

A task representing the asynchronous operation, containing the updated Report resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ReportResource>, CancellationToken)

Updates an existing Report resource asynchronously.

public Task<ReportResponse> PatchAsync(JsonApiDocument<ReportResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ReportResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportResponse>

A task representing the asynchronous operation, containing the updated Report resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.