Class CloudProject

Represents a unique cloud project that the user has access to on the web.

Hierarchy

FrameworkObject
- CloudProject

Index

Constructors

Accessors

category companyName copyrightOwner description developerWebsite lastModifiedDate name owner ownerUserUUID permissions previewImage privacyPolicyURL projectWebsite size team userSettings uuid

Constructors

constructor

new CloudProject(isInternalConstructor?): CloudProject
Parameters
- OptionalisInternalConstructor: boolean
Returns CloudProject
Overrides FrameworkObject.constructor

Accessors

category

get category(): string
A string that represents the category of a project.

Returns string
set category(value): void
Parameters
- value: string
Returns void

companyName

get companyName(): string
Contains the name of the company that owns the project.

Returns string
set companyName(value): void
Parameters
- value: string
Returns void

copyrightOwner

get copyrightOwner(): string
Contains the name of the company that owns the project.

Returns string
set copyrightOwner(value): void
Parameters
- value: string
Returns void

description

get description(): string
The description of the project.

Returns string
set description(value): void
Parameters
- value: string
Returns void

developerWebsite

get developerWebsite(): string
A URL of the developer website for the project. Can be empty.

Returns string
set developerWebsite(value): void
Parameters
- value: string
Returns void

lastModifiedDate

get lastModifiedDate(): string
The last modification date of the project.

Returns string
set lastModifiedDate(value): void
Parameters
- value: string
Returns void

name

get name(): string
The name of the project.

Returns string
set name(value): void
Parameters
- value: string
Returns void

owner

get owner(): CloudUserInformation
The owning user of the project.

Returns CloudUserInformation

ownerUserUUID

get ownerUserUUID(): UUID
The owning user UUID of the project.

Returns UUID
set ownerUserUUID(value): void
Parameters
- value: UUID
Returns void

permissions

get permissions(): EnumValue<CloudProjectPermission, number>
The current user's permission on the project.

Returns EnumValue<CloudProjectPermission, number>
set permissions(value): void
Parameters
- value: EnumValue<CloudProjectPermission, number>
Returns void

previewImage

get previewImage(): CloudProjectPreviewImage
If defined, the project has a preview image available.

Returns CloudProjectPreviewImage

privacyPolicyURL

get privacyPolicyURL(): string
A URL of the project's privacy policy.

Returns string
set privacyPolicyURL(value): void
Parameters
- value: string
Returns void

projectWebsite

get projectWebsite(): string
A URL of the website for the project. Can be empty.

Returns string
set projectWebsite(value): void
Parameters
- value: string
Returns void

size

get size(): number
Specifies the size (in bytes) of all files on the project.

Returns number
set size(value): void
Parameters
- value: number
Returns void

team

get team(): Immutable<CloudTeamInformation>
Specifies settings for the current user. Only set if fetching the project information as an authenticated user.

Returns Immutable<CloudTeamInformation>

userSettings

get userSettings(): CloudProjectUserSettings
Specifies settings for the current user. Only set if fetching the project information as an authenticated user.

Returns CloudProjectUserSettings

uuid

get uuid(): UUID
The UUID of the project.

Returns UUID
set uuid(value): void
Parameters
- value: UUID
Returns void