Interface IPermissionsApiClient

Interface for API client content item permissions operations.

Namespace: Tableau.Migration.Api.Permissions

Assembly: Tableau.Migration.dll

Syntax

public interface IPermissionsApiClient

Methods

CreatePermissionsAsync(Guid, IPermissions, CancellationToken)

Creates the permissions for the content item with the specified ID.

Declaration

Task<IResult<IPermissions>> CreatePermissionsAsync(Guid contentItemId, IPermissions permissions, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	The id of the content item.
IPermissions	permissions	The permissions of the content item.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IPermissions>>	The permissions result with IPermissions.

DeleteCapabilityAsync(Guid, Guid, GranteeType, ICapability, CancellationToken)

Remove a ICapability for a user/group on a content item.

Declaration

Task<IResult> DeleteCapabilityAsync(Guid contentItemId, Guid granteeId, GranteeType granteeType, ICapability capability, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	Id of the content item.
Guid	granteeId	The id of the permissions grantee. This is either a user or group.
GranteeType	granteeType	The type of the permissions grantee.
ICapability	capability	The object containing the capability name and mode.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>

GetPermissionsAsync(Guid, CancellationToken)

Gets the permissions for the content item with the specified ID.

Declaration

Task<IResult<IPermissions>> GetPermissionsAsync(Guid contentItemId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IPermissions>>	The permissions result with IPermissions.

UpdatePermissionsAsync(Guid, IPermissions, CancellationToken)

Updates the permissions for the content item with the specified ID.

Declaration

Task<IResult> UpdatePermissionsAsync(Guid contentItemId, IPermissions permissions, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	Id of the content item.
IPermissions	permissions	The permissions of the content item.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>	The permissions result with IPermissions.