Class ProjectService

A service that allows querying users project-related information.

Constructors

constructor

Methods

acquireDeploymentLock addUser changeUserPermission createCloudProject createCloudProjectFromTemplate createPolyverseReference createProjectReference createProjectTemplate createSharedLink deleteCloudProject deleteSharedLink favoriteProject getAllCloudProjects getAllUsersForProject getAvailableReferences getProjectInformation getProjectTemplates getProjectUserInformation getSharedLinkToken inviteUsers leaveProject releaseDeploymentLock removeReference removeUser renewDeploymentLock resendInvitation unfavoriteProject updateProjectMetadata updateReference updateSharedLink uploadProjectPreviewImage

Constructors

constructor

Methods

StaticacquireDeploymentLock

  • acquireDeploymentLock(projectUUID): 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.

StaticaddUser

  • addUser(projectUUID, userUUID, permissions): UncertainAsyncOp<Any, 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, number>

      The permissions to add the user with.

    Returns UncertainAsyncOp<Any, string>

    An async op that completes once the web server has replied to our request.

StaticchangeUserPermission

  • changeUserPermission(projectUUID, userUUID, permissions): UncertainAsyncOp<Any, 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, number>

      The permissions to change to.

    Returns UncertainAsyncOp<Any, string>

    An async op that completes once the web server has replied to our request.

StaticcreateCloudProject

  • createCloudProject(projectName, description, teamUUID?): 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>

StaticcreateCloudProjectFromTemplate

  • createCloudProjectFromTemplate(templateUUID, projectName, description, teamUUID?, isDeepClone?): 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>

StaticcreatePolyverseReference

  • createPolyverseReference(projectUUID, polyverseLibraryUUID, polyverseAssetUUID): 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.

StaticcreateProjectReference

  • createProjectReference(projectUUID, referencedProjectUUID): 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.

StaticcreateProjectTemplate

  • createProjectTemplate(projectUUID): 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.

StaticcreateSharedLink

StaticdeleteCloudProject

  • deleteCloudProject(projectUUID): UncertainAsyncOp<Any, string>

  • Creates a new project on the web with the given name.

    Parameters

    • projectUUID: UUID

      The project UUID to be deleted.

    Returns UncertainAsyncOp<Any, string>

StaticdeleteSharedLink

  • deleteSharedLink(projectUUID, sharedLinkUUID): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the web server has replied to our request.

StaticfavoriteProject

  • favoriteProject(projectUUID): UncertainAsyncOp<Any, string>

  • Marks the given projectUUID as a favorite for the user.

    Parameters

    • projectUUID: UUID

      The project o be marked as a favorite.

    Returns UncertainAsyncOp<Any, string>

    An async op that completes once the web server has replied to our request.

StaticgetAllCloudProjects

StaticgetAllUsersForProject

StaticgetAvailableReferences

  • getAvailableReferences(projectUUID): 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.

    Returns UncertainAsyncOp<CloudProject[], string>

    An async op that completes once the server has replied to our request.

StaticgetProjectInformation

StaticgetProjectTemplates

StaticgetProjectUserInformation

StaticgetSharedLinkToken

  • getSharedLinkToken(projectUUID, sharedLinkUUID): 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.

StaticinviteUsers

  • inviteUsers(projectUUID, invitations): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the web server has replied to our request.

StaticleaveProject

  • leaveProject(projectUUID): UncertainAsyncOp<Any, 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<Any, 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.

StaticreleaseDeploymentLock

  • releaseDeploymentLock(projectUUID): 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.

StaticremoveReference

  • removeReference(projectUUID, referenceUUID): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the server has replied to our request.

StaticremoveUser

  • removeUser(projectUUID, userUUID): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the web server has replied to our request.

StaticrenewDeploymentLock

  • renewDeploymentLock(projectUUID): 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.

StaticresendInvitation

  • resendInvitation(projectUUID, email): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the web server has replied to our request.

StaticunfavoriteProject

  • unfavoriteProject(projectUUID): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the web server has replied to our request.

StaticupdateProjectMetadata

StaticupdateReference

  • updateReference(projectUUID, referenceUUID): UncertainAsyncOp<Any, 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<Any, string>

    An async op that completes once the server has replied to our request.

StaticupdateSharedLink

  • updateSharedLink(projectUUID, sharedLinkUUID, permissions): 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, number>

      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.

StaticuploadProjectPreviewImage

  • uploadProjectPreviewImage(projectUUID, 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.

Settings

Member Visibility

On This Page

Constructors
Methods