Class ProjectService

A service that allows querying users project-related information.

Constructors

constructor

new ProjectService(): ProjectService

Returns ProjectService

Methods

`Static`acquireDeploymentLock

acquireDeploymentLock(projectUUID: UUID): UncertainAsyncOp<boolean, string>
Acquires a new project deployment lock. This is required to perform project deployments.
Parameters
- projectUUID: UUID
  The UUID of the project to acquire a lock for.
Returns UncertainAsyncOp<boolean, string>
An async op that completes once the web server has replied to our request. The value of the async op is a boolean that indicates whether or not the lock was acquired.

`Static`addUser

addUser(
    projectUUID: UUID,
    userUUID: UUID,
    permissions: EnumValue<CloudProjectPermission>,
): UncertainAsyncOp<void, string>
Adds a new user to the project with the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to add a new user to.
- userUUID: UUID
  The UUID of the user to be added to the project.
- permissions: EnumValue<CloudProjectPermission>
  The permissions to add the user with.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`changeUserPermission

changeUserPermission(
    projectUUID: UUID,
    userUUID: UUID,
    permissions: EnumValue<CloudProjectPermission>,
): UncertainAsyncOp<void, string>
Changes the permissions of a user on the given the project to the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- userUUID: UUID
  The UUID of the user to have it's permissions changed on the project.
- permissions: EnumValue<CloudProjectPermission>
  The permissions to change to.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`createCloudProject

createCloudProject(
    projectName: string,
    description: string,
    teamUUID?: UUID,
): UncertainAsyncOp<CloudProject, string>
Creates a new project on the web with the given name.
Parameters
- projectName: string
  The name of the project to be created.
- description: string
  A string that describes the project. Will be stored alongside project metadata and will be returned by the API.
- OptionalteamUUID: UUID
  Optional, the UUID of the team to create the project in. If not set, the project will be created in the user's personal projects.
Returns UncertainAsyncOp<CloudProject, string>

`Static`createCloudProjectFromTemplate

createCloudProjectFromTemplate(
    templateUUID: UUID,
    projectName: string,
    description: string,
    teamUUID?: UUID,
    isDeepClone?: boolean,
): UncertainAsyncOp<CloudProject, string>
Creates a new project on the web with the given name using the given templateUUID project as a reference. All contents of templateUUID will be copied into the new project.
Parameters
- templateUUID: UUID
  The UUID of a project template to be cloned when creating the new project.
- projectName: string
  The name of the project to be created.
- description: string
  A string that describes the project. Will be stored alongside project metadata and will be returned by the API.
- OptionalteamUUID: UUID
  Optional, the UUID of the team to create the project in. If not set, the project will be created in the user's personal projects.
- OptionalisDeepClone: boolean
  If true, will copy all files under the new project. If false, will only reference the files from the original project in read-only form.
Returns UncertainAsyncOp<CloudProject, string>

`Static`createPolyverseReference

createPolyverseReference(
    projectUUID: UUID,
    polyverseLibraryUUID: UUID,
    polyverseAssetUUID: UUID,
): UncertainAsyncOp<UUID, string>
Updates the project reference to the latest version.
Parameters
- projectUUID: UUID
  The project to update the reference for.
- polyverseLibraryUUID: UUID
- polyverseAssetUUID: UUID
Returns UncertainAsyncOp<UUID, string>
An async op that completes once the server has replied to our request. The result is the UUID of the newly created reference.

`Static`createProjectReference

createProjectReference(
projectUUID: UUID,
referencedProjectUUID: UUID,
): UncertainAsyncOp<UUID, string>
Creates a new project reference.
Parameters
- projectUUID: UUID
  The project to update the reference for.
- referencedProjectUUID: UUID
  The ID of the project to be referenced.
Returns UncertainAsyncOp<UUID, string>
An async op that completes once the server has replied to our request. The result is the UUID of the newly created reference.

`Static`createProjectTemplate

createProjectTemplate(projectUUID: UUID): UncertainAsyncOp<CloudProject, string>
Creates a new project template from the specified project. If a template for this project already exists, it will be updated.
Parameters
- projectUUID: UUID
  The project to create a new template from.
Returns UncertainAsyncOp<CloudProject, string>
An async op that completes once the server has replied to our request. The resulting object is the newly created template object.

Note
The user sending the request must have at least Deploy permission level to create a new template.

Note
A deployment lock must be acquired before creating the template and all MainIncremental resources on the project must be a head.

`Static`createSharedLink

createSharedLink(
projectUUID: UUID,
permissions: EnumValue<CloudProjectPermission>,
): UncertainAsyncOp<CloudProjectShareLink, string>
Creates a new shared link to access the project with the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- permissions: EnumValue<CloudProjectPermission>
  The permissions to create the shared link with.
Returns UncertainAsyncOp<CloudProjectShareLink, string>
An async op that completes once the web server has replied to our request.

Note
Only read and write permissions are allowed.

`Static`deleteCloudProject

deleteCloudProject(projectUUID: UUID): UncertainAsyncOp<void, string>
Creates a new project on the web with the given name.
Parameters
- projectUUID: UUID
  The project UUID to be deleted.
Returns UncertainAsyncOp<void, string>

`Static`deleteSharedLink

deleteSharedLink(
projectUUID: UUID,
sharedLinkUUID: UUID,
): UncertainAsyncOp<void, string>
Deletes an existing shared link.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- sharedLinkUUID: UUID
  The UUID of the shared link to delete.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`favoriteProject

favoriteProject(projectUUID: UUID): UncertainAsyncOp<void, string>
Marks the given projectUUID as a favorite for the user.
Parameters
- projectUUID: UUID
  The project o be marked as a favorite.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`getAllCloudProjects

getAllCloudProjects(): UncertainAsyncOp<CloudProjectListing, string>

Lists all projects that the current user has access to.

Returns UncertainAsyncOp<CloudProjectListing, string>

`Static`getAllUsersForProject

getAllUsersForProject(
projectUUID: UUID,
): UncertainAsyncOp<CloudProjectUsers, string>
Gets a list of all users that have access to the given project UUID on the web.
Parameters
- projectUUID: UUID
  The project UUID to get the list of all users.
Returns UncertainAsyncOp<CloudProjectUsers, string>

`Static`getAvailableReferences

getAvailableReferences(
projectUUID: UUID,
includePublicTemplates?: boolean,
): UncertainAsyncOp<CloudProject[], string>
Gets a list of project references that are available to the current project.
Parameters
- projectUUID: UUID
  The project to retrieve available references for.
- OptionalincludePublicTemplates: boolean
  If true, public templates will be included in the response.
Returns UncertainAsyncOp<CloudProject[], string>
An async op that completes once the server has replied to our request.

`Static`getProjectInformation

getProjectInformation(projectUUID: UUID): UncertainAsyncOp<CloudProject, string>
Gets information about a web project.
Parameters
- projectUUID: UUID
  The project UUID to get information for.
Returns UncertainAsyncOp<CloudProject, string>

`Static`getProjectTemplates

getProjectTemplates(): UncertainAsyncOp<CloudProjectTemplateCategory[], string>

Gets a list of all template projects available to create a new project from.

Returns UncertainAsyncOp<CloudProjectTemplateCategory[], string>

`Static`getProjectUserInformation

getProjectUserInformation(
projectUUID: UUID,
userUUID: UUID,
): UncertainAsyncOp<CloudProjectUser, string>
Gets user information with the given UUID.
Parameters
- projectUUID: UUID
  The project UUID to get the user from.
- userUUID: UUID
  The user UUID to get information for.
Returns UncertainAsyncOp<CloudProjectUser, string>

`Static`getSharedLinkToken

getSharedLinkToken(
projectUUID: UUID,
sharedLinkUUID: UUID,
): UncertainAsyncOp<string, string>
Creates a new shared link token to access the project with the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- sharedLinkUUID: UUID
  The UUID of the shared link to create a new token for.
Returns UncertainAsyncOp<string, string>
An async op that completes once the web server has replied to our request.

`Static`inviteUsers

inviteUsers(
projectUUID: UUID,
invitations: CloudProjectUserInvitation[],
): UncertainAsyncOp<void, string>
Invites new users to the project with the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to invite users to.
- invitations: CloudProjectUserInvitation[]
  A vector that specifies each invitation that should be sent.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`leaveProject

leaveProject(projectUUID: UUID): UncertainAsyncOp<void, string>
Leaves a project. After this call, the user will lose access to the project.
Parameters
- projectUUID: UUID
  The project to be removed from.
Returns UncertainAsyncOp<void, string>
An async op that completes once the server has replied to our request.

Note
If the user is the owner of the project, this call will fail.

`Static`releaseDeploymentLock

releaseDeploymentLock(projectUUID: UUID): UncertainAsyncOp<boolean, string>
Releases a project deployment lock.
Parameters
- projectUUID: UUID
  The UUID of the project to acquire a lock for.
Returns UncertainAsyncOp<boolean, string>
An async op that completes once the web server has replied to our request. The value of the async op is a boolean that indicates whether or not the lock was released.

`Static`removeReference

removeReference(
projectUUID: UUID,
referenceUUID: UUID,
): UncertainAsyncOp<void, string>
Removes the project reference.
Parameters
- projectUUID: UUID
  The project to update the reference for.
- referenceUUID: UUID
  The ID of the reference to update.
Returns UncertainAsyncOp<void, string>
An async op that completes once the server has replied to our request.

`Static`removeUser

removeUser(projectUUID: UUID, userUUID: UUID): UncertainAsyncOp<void, string>
Removes a user from a project. All access to the user will be revoked.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- userUUID: UUID
  The UUID of the user to have it's permissions revoked on the project.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`renewDeploymentLock

renewDeploymentLock(projectUUID: UUID): UncertainAsyncOp<boolean, string>
Renews a project deployment lock.
Parameters
- projectUUID: UUID
  The UUID of the project to acquire a lock for.
Returns UncertainAsyncOp<boolean, string>
An async op that completes once the web server has replied to our request. The value of the async op is a boolean that indicates whether or not the lock was renewed.

`Static`resendInvitation

resendInvitation(
projectUUID: UUID,
email: string,
): UncertainAsyncOp<void, string>
Resends an invitation to a user.
Parameters
- projectUUID: UUID
  The UUID of the project to resend the invitation for.
- email: string
  The email address of the user to resend the invitation to.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`unfavoriteProject

unfavoriteProject(projectUUID: UUID): UncertainAsyncOp<void, string>
Removes the favorite state for the given projectUUID for the user.
Parameters
- projectUUID: UUID
  The project o be unmarked as a favorite.
Returns UncertainAsyncOp<void, string>
An async op that completes once the web server has replied to our request.

`Static`updateProjectMetadata

updateProjectMetadata(
projectUUID: UUID,
metadataUpdate: CloudProjectMetadataUpdate,
): UncertainAsyncOp<CloudProject, string>
Updates project metadata on the server.
Parameters
- projectUUID: UUID
  The UUID of the project to update.
- metadataUpdate: CloudProjectMetadataUpdate
  The metadata object. Any fields that are empty won't be updated on the server.
Returns UncertainAsyncOp<CloudProject, string>

`Static`updateReference

updateReference(
projectUUID: UUID,
referenceUUID: UUID,
): UncertainAsyncOp<void, string>
Updates the project reference to the latest version.
Parameters
- projectUUID: UUID
  The project to update the reference for.
- referenceUUID: UUID
  The ID of the reference to update.
Returns UncertainAsyncOp<void, string>
An async op that completes once the server has replied to our request.

`Static`updateSharedLink

updateSharedLink(
    projectUUID: UUID,
    sharedLinkUUID: UUID,
    permissions: EnumValue<CloudProjectPermission>,
): UncertainAsyncOp<CloudProjectShareLink, string>
Creates a new shared link to access the project with the given permissions.
Parameters
- projectUUID: UUID
  The UUID of the project to change the permissions on.
- sharedLinkUUID: UUID
  The UUID of the shared link to create a new token for.
- permissions: EnumValue<CloudProjectPermission>
  The permissions to create the shared link with.
Returns UncertainAsyncOp<CloudProjectShareLink, string>
An async op that completes once the web server has replied to our request.

Note
Only read and write permissions are allowed.

`Static`uploadProjectPreviewImage

uploadProjectPreviewImage(
projectUUID: UUID,
pixelData: PixelData,
): UncertainAsyncOp<PixelData, string>
Uploads a new preview image to the project.
Parameters
- projectUUID: UUID
  The project to have a preview image uploaded.
- pixelData: PixelData
  The PixelData that represents the preview image. It will be automatically converted into a PNG and uploaded to the server.
Returns UncertainAsyncOp<PixelData, string>
An async op that completes once the web server has replied to our request. The value of the async data is the PixelData that was upload. The data might be different than the pixelData if the data needed to be adjusted prior to uploading.

Class ProjectService

Index

Constructors

Methods

Constructors

constructor

Returns ProjectService

Methods

StaticacquireDeploymentLock

Parameters

Returns UncertainAsyncOp<boolean, string>

StaticaddUser

Parameters

Returns UncertainAsyncOp<void, string>

StaticchangeUserPermission

Parameters

Returns UncertainAsyncOp<void, string>

StaticcreateCloudProject

Parameters

Returns UncertainAsyncOp<CloudProject, string>

StaticcreateCloudProjectFromTemplate

Parameters

Returns UncertainAsyncOp<CloudProject, string>

StaticcreatePolyverseReference

Parameters

Returns UncertainAsyncOp<UUID, string>

StaticcreateProjectReference

Parameters

Returns UncertainAsyncOp<UUID, string>

StaticcreateProjectTemplate

Parameters

Returns UncertainAsyncOp<CloudProject, string>

Note

Note

StaticcreateSharedLink

Parameters

Returns UncertainAsyncOp<CloudProjectShareLink, string>

Note

StaticdeleteCloudProject

Parameters

Returns UncertainAsyncOp<void, string>

StaticdeleteSharedLink

Parameters

Returns UncertainAsyncOp<void, string>

StaticfavoriteProject

Parameters

Returns UncertainAsyncOp<void, string>

StaticgetAllCloudProjects

Returns UncertainAsyncOp<CloudProjectListing, string>

StaticgetAllUsersForProject

Parameters

Returns UncertainAsyncOp<CloudProjectUsers, string>

StaticgetAvailableReferences

Parameters

Returns UncertainAsyncOp<CloudProject[], string>

StaticgetProjectInformation

Parameters

Returns UncertainAsyncOp<CloudProject, string>

StaticgetProjectTemplates

Returns UncertainAsyncOp<CloudProjectTemplateCategory[], string>

StaticgetProjectUserInformation

Parameters

Returns UncertainAsyncOp<CloudProjectUser, string>

StaticgetSharedLinkToken

Parameters

Returns UncertainAsyncOp<string, string>

StaticinviteUsers

Parameters

Returns UncertainAsyncOp<void, string>

StaticleaveProject

Parameters

Returns UncertainAsyncOp<void, string>

Note

StaticreleaseDeploymentLock

Parameters

Returns UncertainAsyncOp<boolean, string>

StaticremoveReference

Parameters

Returns UncertainAsyncOp<void, string>

StaticremoveUser

`Static`acquireDeploymentLock

`Static`addUser

`Static`changeUserPermission

`Static`createCloudProject

`Static`createCloudProjectFromTemplate

`Static`createPolyverseReference

`Static`createProjectReference

`Static`createProjectTemplate

`Static`createSharedLink

`Static`deleteCloudProject

`Static`deleteSharedLink

`Static`favoriteProject

`Static`getAllCloudProjects

`Static`getAllUsersForProject

`Static`getAvailableReferences

`Static`getProjectInformation

`Static`getProjectTemplates

`Static`getProjectUserInformation

`Static`getSharedLinkToken

`Static`inviteUsers

`Static`leaveProject

`Static`releaseDeploymentLock

`Static`removeReference

`Static`removeUser

`Static`renewDeploymentLock

`Static`resendInvitation

`Static`unfavoriteProject

`Static`updateProjectMetadata

`Static`updateReference

`Static`updateSharedLink

`Static`uploadProjectPreviewImage