Class EventNoteClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventNote resource.

public class EventNoteClient : SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>

Inheritance

object

ResourceClient<EventNote>

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>

EventNoteClient

Inherited Members

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>.PatchAsync(EventNote, CancellationToken)

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>.PatchAsync(JsonApiDocument<EventNoteResource>, CancellationToken)

SingletonResourceClient<EventNote, EventNoteResource, EventNoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<EventNote>.AddQueryParameter(string, string)

ResourceClient<EventNote>.ReplaceQueryParameter(string, string)

ResourceClient<EventNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventNote>.Uri

ResourceClient<EventNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventNoteClient(HttpClient, Uri)

Client for interacting with the EventNote resource.

public EventNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Owner

Associated Owner.

public OwnerClient Owner { get; }

Property Value

OwnerClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventNoteClient

The current EventNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventNoteClient ClearParameters()

Returns

EventNoteClient

The current EventNoteClient instance.

GetAsync(CancellationToken)

Fetches the EventNote resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOwner()

Include related Owner resources in the response.

public EventNoteClient IncludeOwner()

Returns

EventNoteClient