Class Project

Provides properties and methods for obtaining information about a project on the Open Cloud Server and managing its roles, members and models.

Hierarchy (View Summary)

Endpoint
- Project

Index

Constructors

constructor

new Project(data: any, httpClient: IHttpClient): Project
Parameters
- data: any
  Raw project data received from the server. For more information, see Open Cloud Projects API.
- httpClient: IHttpClient
  HTTP client instance used to send requests to the REST API server.
Returns Project
Overrides Endpoint.constructor

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

authorization

get authorization(): { project_actions: string[] }
Project features the user has access to.

Returns { project_actions: string[] }
- project_actions: string[]
  Actions are allowed to be performed:
  - update - The ability to update the project details.
  - createTopic - The ability to create a new topic.
  - createDocument - The ability to create a new document.

createdAt

get createdAt(): string
Project creation time (UTC) in the format specified in ISO 8601.

Returns string

customFields

get customFields(): any
Project custom fields object, to store custom data.

Returns any

data

get data(): any
Raw project data received from the server. For more information, see Open Cloud Projects API.

Returns any

description

get description(): string
Project description.

Returns string

endDate

get endDate(): string
Project end date in the format specified in ISO 8601.

Returns string

id

get id(): string
Unique project ID.

Returns string

memberCount

get memberCount(): number
The number of members in the project.

Returns number

modelCount

get modelCount(): number
The number of models in the project.

Returns number

name

get name(): string
Project name.

Returns string

owner

get owner(): IShortUserDesc
Project owner information.

Returns IShortUserDesc

previewUrl

get previewUrl(): string
Project preview image URL or empty string if the project does not have a preview. Use setPreview() to change preview image.

Returns string

public

get public(): boolean
true if project is shared project.

Returns boolean

startDate

get startDate(): string
Project start date in the format specified in ISO 8601.

Returns string

topicCount

get topicCount(): number
The number of topics in the project.

Returns number

updatedAt

get updatedAt(): string
Project last update time (UTC) in the format specified in ISO 8601.

Returns string

Methods

addMember

addMember(userId: string, role: string): Promise<Member>
Adds a user to the project to become a member and have permission to perform actions.
Parameters
- userId: string
  User ID.
- role: string
  Role name from the list of project roles.
Returns Promise<Member>

addModel

addModel(
    fileId: string,
    actions: string | string[],
    _public: boolean,
): Promise<File>
Adds a file to the project with specified permissions.

To change file permissions for the project use Permission.actions.
Parameters
- fileId: string
  File ID.
- actions: string | string[]
  Actions are allowed to be performed on a file:
  
  read - The ability to read file description, geometry data and properties.
  
  readSourceFile - The ability to download source file.
  
  write - The ability to modify file name, description and references.
  
  readViewpoint - The ability to read file viewpoints.
  
  createViewpoint - The ability to create file viewpoints.
- _public: boolean
  Specifies whether all users have access to the file or not.
Returns Promise<File>
Returns a file instance added to the project.

checkout

checkout(): Promise<Project>
Reloads project data from the server.

Returns Promise<Project>

createRole

createRole(
    name: string,
    description: string,
    permissions: IRoleActions,
): Promise<Role>
Creates a new project role.
Parameters
- name: string
  Role name.
- description: string
  Role description.
- permissions: IRoleActions
  Actions are allowed to be performed for the role.
Returns Promise<Role>

delete

delete(): Promise<any>
Deletes a project from the server.

Returns Promise<any>
Returns the raw data of a deleted project. For more information, see Open Cloud Projects API.

Overrides Endpoint.delete

deletePreview

deletePreview(): Promise<Project>
Removes the project preview.

Returns Promise<Project>

deleteRole

deleteRole(name: string): Promise<any>
Deletes the specified project role.
Parameters
- name: string
  Role name.
Returns Promise<any>
Returns the raw data of a deleted role. For more information, see Open Cloud Projects API.

getFilesInformation

getFilesInformation(): Promise<any[]>
Returns a list of project files. For more information, see Open Cloud BCF3 API.

This list contains all files that the project has access to. To add a file to this list, create a project permission on the file using File.createPermission().

Returns Promise<any[]>

getMember

getMember(memberId: string): Promise<Member>
Returns information about the specified project member.
Parameters
- memberId: string
  Member ID.
Returns Promise<Member>

getMembers

getMembers(): Promise<Member[]>
Returns a list of project members.

Returns Promise<Member[]>

getModels

getModels(): Promise<File[]>
Returns a list of project files.

Returns Promise<File[]>

getRole

getRole(name: string): Promise<Role>
Returns information about the specified project role.
Parameters
- name: string
  Role name.
Returns Promise<Role>

getRoles

getRoles(): Promise<Role[]>
Returns a list of project roles. Project members have different abilities depending on the role they have in a project.

Returns Promise<Role[]>

removeMember

removeMember(memberId: string): Promise<any>
Removes the specified member from a project.
Parameters
- memberId: string
  Member ID.
Returns Promise<any>
Returns the raw data of a deleted member. For more information, see Open Cloud Projects API.

removeModel

removeModel(fileId: string): Promise<File>
Removes the specified file from a project.
Parameters
- fileId: string
  File ID.
Returns Promise<File>
Returns a file instance removed from the project.

save

save(): Promise<Project>
Saves project properties changes to the server. Call this method to update project data on the server after any property changes.

Returns Promise<Project>

setPreview

setPreview(image?: BodyInit): Promise<Project>
Sets or removes the project preview.
Parameters
- Optionalimage: BodyInit
  Preview image. Can be a Data URL string, ArrayBuffer, Blob or Web API File object. Setting the image to null will remove the preview.
Returns Promise<Project>

update

update(data: any): Promise<Project>
Updates project data on the server.
Parameters
- data: any
  Raw project data. For more information, see Open Cloud Projects API.
Returns Promise<Project>