Interface IChannelClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IChannelClient
Methods
CreateAsync(ChannelCreateRequest, CancellationToken)
Create channel
Declaration
Task<Channel> CreateAsync(ChannelCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ChannelCreateRequest
request
The request containing information needed to create new channel. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<Channel>
Created channel |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteAsync(String, CancellationToken)
Delete channel
Declaration
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of the channel that should be deleted. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.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 |
PictureparkException
Internal server error |
GetAllAsync(CancellationToken)
Get all channels
Declaration
Task<ICollection<Channel>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Channel>>
List of channel |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAsync(String, CancellationToken)
Get channel
Declaration
Task<Channel> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The channel ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<Channel>
Requested channel |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetChannelsAsync(CancellationToken)
Declaration
Task<ICollection<Channel>> GetChannelsAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
|
Returns
System.Threading.Tasks.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(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.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 |
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(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.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 |
PictureparkException
Internal server error |
UpdateAsync(String, ChannelUpdateRequest, CancellationToken)
Update channel
Declaration
Task<Channel> UpdateAsync(string id, ChannelUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of channel to update |
ChannelUpdateRequest
request
The request containing information needed to update the channel. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<Channel>
Updated channel |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |