Class SocialProfileClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SocialProfile resource.

public class SocialProfileClient : SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>

Inheritance

object

ResourceClient<SocialProfile>

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>

SocialProfileClient

Inherited Members

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>.PatchAsync(SocialProfile, CancellationToken)

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>.PatchAsync(JsonApiDocument<SocialProfileResource>, CancellationToken)

SingletonResourceClient<SocialProfile, SocialProfileResource, SocialProfileResponse>.DeleteAsync(CancellationToken)

ResourceClient<SocialProfile>.AddQueryParameter(string, string)

ResourceClient<SocialProfile>.ReplaceQueryParameter(string, string)

ResourceClient<SocialProfile>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SocialProfile>.Uri

ResourceClient<SocialProfile>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SocialProfileClient(HttpClient, Uri)

Client for interacting with the SocialProfile resource.

public SocialProfileClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SocialProfileClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SocialProfileClient

The current SocialProfileClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SocialProfileClient ClearParameters()

Returns

SocialProfileClient

The current SocialProfileClient instance.

DeleteAsync(CancellationToken)

Deletes the SocialProfile 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 SocialProfile resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public SocialProfileClient IncludePerson()

Returns

SocialProfileClient

PatchAsync(SocialProfile, CancellationToken)

Updates an existing SocialProfile resource asynchronously.

public Task<SocialProfileResponse> PatchAsync(SocialProfile resource, CancellationToken cancellationToken = default)

Parameters

resource SocialProfile

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<SocialProfileResource>, CancellationToken)

Updates an existing SocialProfile resource asynchronously.

public Task<SocialProfileResponse> PatchAsync(JsonApiDocument<SocialProfileResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SocialProfileResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.