Interface IChannelClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IChannelClient

Methods

CreateAsync(ChannelCreateRequest, CancellationToken)

Create channel

Declaration

Task<Channel> CreateAsync(ChannelCreateRequest request, CancellationToken cancellationToken = default)

Parameters

ChannelCreateRequest request The request containing information needed to create new channel.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Channel> Created channel

Remarks

Creates new channel based on supplied request.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

DeleteAsync(string, CancellationToken)

Delete channel

Declaration

Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id ID of the channel that should be deleted.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task OK

Remarks

Deletes the channel specified by the ID.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAggregationFieldsAsync(CancellationToken)

Retrieve the fields that can be used in an aggregator on any channel.

Declaration

Task<ICollection<FieldInfo>> GetAggregationFieldsAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<FieldInfo>> The list of fields

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAllAsync(CancellationToken)

Get all channels

Declaration

Task<ICollection<Channel>> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<Channel>> List of channel

Remarks

Get all channels available for the current user.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAsync(string, CancellationToken)

Get channel

Declaration

Task<Channel> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id The channel ID.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Channel> Requested channel

Remarks

Gets the channel information by the channel ID.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetChannelsAsync(CancellationToken)

Declaration

Task<ICollection<Channel>> GetChannelsAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken

Returns

Task<ICollection<Channel>>

GetFilterFieldsAsync(CancellationToken)

Retrieve the fields that can be used as filter fields on any channel.

Declaration

Task<ICollection<FieldInfo>> GetFilterFieldsAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<FieldInfo>> The list of fields

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetSortFieldsAsync(CancellationToken)

Retrieve the fields that can be used as sort fields on any channel.

Declaration

Task<ICollection<SortFieldInfo>> GetSortFieldsAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<SortFieldInfo>> The list of fields

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateAsync(string, ChannelUpdateRequest, CancellationToken)

Update channel

Declaration

Task<Channel> UpdateAsync(string id, ChannelUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

string id ID of channel to update

ChannelUpdateRequest request The request containing information needed to update the channel.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Channel> Updated channel

Remarks

Updates the channel specified by the ID and based on supplied request.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error