Class: Project
Represents a project.
Methods
GetProjectId()
static GetProjectId(): string;
Gets the current project ID.
Returns
string
The project ID.
FromBundle()
static FromBundle(bundle): Project;
Creates a project from a project bundle.
Parameters
| Parameter | Type | Description |
|---|---|---|
bundle | ProjectBundle | The project bundle. |
Returns
Project
The created Project.
New()
static New(metadata): Project;
Creates a new project from project metadata. This is intended for projects distributed outside the platform.
Parameters
| Parameter | Type | Description |
|---|---|---|
metadata | Omit<ProjectMetadata, "projectId"> | The project metadata, excluding the project identifier, which is generated at runtime. |
Returns
Project
The created Project.
Launch()
Launch(callbacks): Promise<void>;
Launches the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
callbacks | ProjectCallbacks | The project lifecycle callbacks. |
Returns
Promise<void>
A promise that resolves when project launch has completed.