Class PaginatedSocialProfileClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SocialProfile collection resources.

public class PaginatedSocialProfileClient : PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>

Inheritance

object

ResourceClient<SocialProfile>

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>

PaginatedSocialProfileClient

Inherited Members

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.PerPage(int)

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.Offset(int)

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.Filter(string)

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.PostAsync(SocialProfile, CancellationToken)

PaginatedResourceClient<SocialProfile, SocialProfileResource, SocialProfileCollectionResponse, SocialProfileResponse>.PostAsync(JsonApiDocument<SocialProfileResource>, 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

PaginatedSocialProfileClient(HttpClient, Uri)

Client for interacting with SocialProfile collection resources.

public PaginatedSocialProfileClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSocialProfileClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSocialProfileClient

The current PaginatedSocialProfileClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSocialProfileClient ClearParameters()

Returns

PaginatedSocialProfileClient

The current PaginatedSocialProfileClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSocialProfileClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSocialProfileClient

The current PaginatedSocialProfileClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SocialProfile resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileCollectionResponse>

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSocialProfileClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSocialProfileClient

The current PaginatedSocialProfileClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public SocialProfileClient OrderByCreatedAt()

Returns

SocialProfileClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public SocialProfileClient OrderByCreatedAtDescending()

Returns

SocialProfileClient

OrderBySite()

Sort response items by the Site attribute.

public SocialProfileClient OrderBySite()

Returns

SocialProfileClient

OrderBySiteDescending()

Sort response items by the Site attribute. Use reverse order.

public SocialProfileClient OrderBySiteDescending()

Returns

SocialProfileClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public SocialProfileClient OrderByUpdatedAt()

Returns

SocialProfileClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public SocialProfileClient OrderByUpdatedAtDescending()

Returns

SocialProfileClient

OrderByUrl()

Sort response items by the Url attribute.

public SocialProfileClient OrderByUrl()

Returns

SocialProfileClient

OrderByUrlDescending()

Sort response items by the Url attribute. Use reverse order.

public SocialProfileClient OrderByUrlDescending()

Returns

SocialProfileClient

OrderByVerified()

Sort response items by the Verified attribute.

public SocialProfileClient OrderByVerified()

Returns

SocialProfileClient

OrderByVerifiedDescending()

Sort response items by the Verified attribute. Use reverse order.

public SocialProfileClient OrderByVerifiedDescending()

Returns

SocialProfileClient

PerPage(int)

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

public PaginatedSocialProfileClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSocialProfileClient

The current PaginatedSocialProfileClient instance.

PostAsync(SocialProfile, CancellationToken)

Creates a new SocialProfile resource asynchronously.

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

Parameters

resource SocialProfile

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SocialProfileResource>, CancellationToken)

Creates a new SocialProfile resource asynchronously.

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

Parameters

document JsonApiDocument<SocialProfileResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SocialProfileResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public SocialProfileClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

SocialProfileClient

WhereSite(string)

Query response items by the Site attribute.

public SocialProfileClient WhereSite(string value)

Parameters

value string

Returns

SocialProfileClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public SocialProfileClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

SocialProfileClient

WhereUrl(string)

Query response items by the Url attribute.

public SocialProfileClient WhereUrl(string value)

Parameters

value string

Returns

SocialProfileClient

WhereVerified(bool)

Query response items by the Verified attribute.

public SocialProfileClient WhereVerified(bool value)

Parameters

value bool

Returns

SocialProfileClient

WithId(string)

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

public SocialProfileClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SocialProfileClient

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