Interface IDefaultPermissionsApiClient

Interface for API client project default permissions operations.

Namespace: Tableau.Migration.Api.Permissions

Assembly: Tableau.Migration.dll

Syntax

public interface IDefaultPermissionsApiClient

Methods

CreatePermissionsAsync(string, Guid, IPermissions, CancellationToken)

Creates the content type's default permissions for the project with the specified ID.

Declaration

Task<IResult<IPermissions>> CreatePermissionsAsync(string contentTypeUrlSegment, Guid projectId, IPermissions permissions, CancellationToken cancel)

Parameters

Type	Name	Description
string	contentTypeUrlSegment	The permissions' content type URL segment.
Guid	projectId	The ID of the project.
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(string, Guid, Guid, GranteeType, ICapability, CancellationToken)

Remove a content type's default ICapability for a user/group in a project.

Declaration

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

Parameters

Type	Name	Description
string	contentTypeUrlSegment	The permissions' content type URL segment.
Guid	projectId	The ID of the project.
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>

GetAllPermissionsAsync(Guid, CancellationToken)

Gets the default permissions for the project with the specified ID.

Declaration

Task<IResult<IImmutableDictionary<string, IPermissions>>> GetAllPermissionsAsync(Guid projectId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	projectId	The ID of the project.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IImmutableDictionary<string, IPermissions>>>	The permissions result with content type IPermissions.

GetPermissionsAsync(string, Guid, CancellationToken)

Gets the content type's default permissions for the project with the specified ID.

Declaration

Task<IResult<IPermissions>> GetPermissionsAsync(string contentTypeUrlSegment, Guid projectId, CancellationToken cancel)

Parameters

Type	Name	Description
string	contentTypeUrlSegment	The permissions' content type URL segment.
Guid	projectId	The ID of the project.
CancellationToken	cancel	The cancellation token to obey.

Returns

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

UpdateAllPermissionsAsync(Guid, IReadOnlyDictionary<string, IPermissions>, CancellationToken)

Updates the content types' default permissions for the project with the specified ID.

Declaration

Task<IResult> UpdateAllPermissionsAsync(Guid projectId, IReadOnlyDictionary<string, IPermissions> permissions, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	projectId	The ID of the project.
IReadOnlyDictionary<string, IPermissions>	permissions	The permissions of the content items, keyed by the content type's URL segment.
CancellationToken	cancel	The cancellation token to obey.

Returns

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

UpdatePermissionsAsync(string, Guid, IPermissions, CancellationToken)

Updates the content type's default permissions for the project with the specified ID.

Declaration

Task<IResult> UpdatePermissionsAsync(string contentTypeUrlSegment, Guid projectId, IPermissions permissions, CancellationToken cancel)

Parameters

Type	Name	Description
string	contentTypeUrlSegment	The permissions' content type URL segment.
Guid	projectId	The ID of the project.
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.