Interface ICloudSubscriptionsApiClient

Interface for API client server subscriptions operations.

Inherited Members

IPublishApiClient<ICloudSubscription, ICloudSubscription>.PublishAsync(ICloudSubscription, CancellationToken)

IDeleteApiClient.DeleteAsync(Guid, CancellationToken)

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface ICloudSubscriptionsApiClient : IPublishApiClient<ICloudSubscription>, IPublishApiClient<ICloudSubscription, ICloudSubscription>, IDeleteApiClient

Methods

CreateSubscriptionAsync(ICloudSubscription, CancellationToken)

Creates a new subscription on the cloud site.

Declaration

Task<IResult<ICloudSubscription>> CreateSubscriptionAsync(ICloudSubscription subscription, CancellationToken cancel)

Parameters

Type	Name	Description
ICloudSubscription	subscription	The subscription to create.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ICloudSubscription>>	The newly created cloud subscription.

GetAllSubscriptionsAsync(int, int, CancellationToken)

Gets all subscriptions on the cloud site.

Declaration

Task<IPagedResult<ICloudSubscription>> GetAllSubscriptionsAsync(int pageNumber, int pageSize, CancellationToken cancel)

Parameters

Type	Name	Description
int	pageNumber	The page number.
int	pageSize	The page size.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IPagedResult<ICloudSubscription>>	The list of subscriptions on the site.

UpdateSubscriptionAsync(Guid, CancellationToken, string?, bool?, bool?, string?, string?, bool?, string?, ISubscriptionContent?, Guid?, ICloudSchedule?)

Updates a subscription on the cloud site.

Declaration

Task<IResult<ICloudSubscription>> UpdateSubscriptionAsync(Guid subscriptionId, CancellationToken cancel, string? newSubject = null, bool? newAttachImage = null, bool? newAttachPdf = null, string? newPageOrientation = null, string? newPageSizeOption = null, bool? newSuspended = null, string? newMessage = null, ISubscriptionContent? newContent = null, Guid? newUserId = null, ICloudSchedule? newSchedule = null)

Parameters

Type	Name	Description
Guid	subscriptionId	The ID for the subscription to update.
CancellationToken	cancel	The cancellation token to obey.
string	newSubject	The new subject, or null to not update the subject.
bool?	newAttachImage	The new attach image flag, or null to not update the flag.
bool?	newAttachPdf	The new attach PDF flag, or null to not update the flag.
string	newPageOrientation	The new page orientation, or null to not update the page orientation.
string	newPageSizeOption	The new page size option, or null to not update the page size option.
bool?	newSuspended	The new suspended flag, or null to not update the flag.
string	newMessage	The new message, or null to not update the message.
ISubscriptionContent	newContent	The new content reference, or null to not update the content reference.
Guid?	newUserId	The new user ID, or null to not update the user ID.
ICloudSchedule	newSchedule	The new schedule, or null to not update the schedule.

Returns

Type	Description
Task<IResult<ICloudSubscription>>	The updated cloud subscription.