Interface IProjectsApiClient

Interface for API client project operations.

Inherited Members
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface IProjectsApiClient : IPagedListApiClient<IProject>, IContentApiClient, IPublishApiClient<IProject>, IPublishApiClient<IProject, IProject>, IPermissionsContentApiClient, IOwnershipApiClient

Methods

CreateProjectAsync(ICreateProjectOptions, CancellationToken)

Creates a project.

Declaration
Task<IResult<IProject>> CreateProjectAsync(ICreateProjectOptions options, CancellationToken cancel)
Parameters
Type Name Description
ICreateProjectOptions options

The new project's details.
CancellationToken cancel

The cancellation token to obey.
Returns
Type Description
Task<IResult<IProject>>

The newly created project.

DeleteProjectAsync(Guid, CancellationToken)

Deletes a project.

Declaration
Task<IResult> DeleteProjectAsync(Guid projectId, CancellationToken cancel)
Parameters
Type Name Description
Guid projectId

The ID for the project to delete.
CancellationToken cancel

The cancellation token to obey.
Returns
Type Description
Task<IResult>

GetAllDefaultPermissionsAsync(Guid, CancellationToken)

Gets the project's default permissions.

Declaration
Task<IResult<IImmutableDictionary<string, IPermissions>>> GetAllDefaultPermissionsAsync(Guid projectId, CancellationToken cancel)
Parameters
Type Name Description
Guid projectId

The project ID.
CancellationToken cancel

The cancellation token to obey.
Returns
Type Description
Task<IResult<IImmutableDictionary<string, IPermissions>>>

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

Updates the project's default permissions.

Declaration
Task<IResult> UpdateAllDefaultPermissionsAsync(Guid projectId, IReadOnlyDictionary<string, IPermissions> permissions, CancellationToken cancel)
Parameters
Type Name Description
Guid projectId

The project ID.
IReadOnlyDictionary<string, IPermissions> permissions

The new permissions.
CancellationToken cancel

The cancellation token to obey.
Returns
Type Description
Task<IResult>

UpdateProjectAsync(Guid, CancellationToken, string?, string?, Guid?, string?, Guid?, Guid?)

Updates the project after publishing.

Declaration
Task<IResult<IUpdateProjectResult>> UpdateProjectAsync(Guid projectId, CancellationToken cancel, string? newName = null, string? newDescription = null, Guid? newParentProjectId = null, string? newContentPermissions = null, Guid? newControllingPermissionsProjectId = null, Guid? newOwnerId = null)
Parameters
Type Name Description
Guid projectId

The ID for the project to update.
CancellationToken cancel

The cancellation token to obey.
string newName

The new name of the project, or null to not update the name.
string newDescription

The new description of the project, or null to not update the description.
Guid? newParentProjectId

The ID of the new parent project, or null to not update the parent project, or Empty to remove the parent project.
string newContentPermissions

The new content permission mode of the project, or null to not update the mode.
Guid? newControllingPermissionsProjectId

The ID of the new controlling permissions project, or null to not update the controlling permissions project.
Guid? newOwnerId

The ID of the new owner of the project, or null to not update the owner.
Returns
Type Description
Task<IResult<IUpdateProjectResult>>

The update result.