Interface IGroupSetsApiClient

Interface for API client group set operations.

Inherited Members

IPagedListApiClient<IGroupSet>.GetPager(int)

IPagedListApiClient<IGroupSet>.GetAllAsync(int, CancellationToken)

IApiPageAccessor<IGroupSet>.GetPageAsync(int, int, CancellationToken)

IContentApiClient.UrlPrefix

IReadApiClient<IGroupSet>.GetByIdAsync(Guid, CancellationToken)

IPullApiClient<IGroupSet, IPublishableGroupSet>.PullAsync(IGroupSet, CancellationToken)

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

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface IGroupSetsApiClient : IPagedListApiClient<IGroupSet>, IApiPageAccessor<IGroupSet>, IContentApiClient, IReadApiClient<IGroupSet>, IPullApiClient<IGroupSet, IPublishableGroupSet>, IPublishApiClient<IPublishableGroupSet>, IPublishApiClient<IPublishableGroupSet, IPublishableGroupSet>

Methods

AddGroupToGroupSetAsync(Guid, Guid, CancellationToken)

Adds a group to a group set.

Declaration

Task<IResult> AddGroupToGroupSetAsync(Guid groupSetId, Guid groupId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	groupSetId	The group set ID.
Guid	groupId	The group ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>	The result.

RemoveGroupFromGroupSetAsync(Guid, Guid, CancellationToken)

Removes a group from a group set.

Declaration

Task<IResult> RemoveGroupFromGroupSetAsync(Guid groupSetId, Guid groupId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	groupSetId	The group set ID.
Guid	groupId	The group ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>	The result.