Class CloudProject

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

Constructors

constructor

new CloudProject(isInternalConstructor?: boolean): 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: string): 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: string): 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: string): void
Parameters
- value: string
Returns void

description

get description(): string

The description of the project.

Returns string
set description(value: string): 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: string): void
Parameters
- value: string
Returns void

featureFlags

get featureFlags(): Iterable<string>

The feature flags granted to the project, derived from the project owner's subscription (e.g. "StandaloneWebDeployment").

Returns Iterable<string>
set featureFlags(value: readonly string[] | Iterable<string>): void
Parameters
- value: readonly string[] | Iterable<string>
Returns void

freeSizeInMB

get freeSizeInMB(): number

Specifies the free size (in MB) available to the project. If empty, the project has no limit.

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

lastModifiedDate

get lastModifiedDate(): string

The last modification date of the project.

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

name

get name(): string

The name of the project.

Returns string
set name(value: string): 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: UUID): void
Parameters
- value: UUID
Returns void

permissions

get permissions(): EnumValue<CloudProjectPermission>

The current user's permission on the project.

Returns EnumValue<CloudProjectPermission>
set permissions(value: EnumValue<CloudProjectPermission>): void
Parameters
- value: EnumValue<CloudProjectPermission>
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: string): 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: string): void
Parameters
- value: string
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>

totalSizeInMB

get totalSizeInMB(): number

Specifies the size (in MB) of all files on the project.

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

usedMainSizeInMB

get usedMainSizeInMB(): number

Specifies the size (in MB) of all main files on the project.

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

usedSizeInMB

get usedSizeInMB(): number

Specifies the size (in MB) of all active files on the project.

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

usedStreamingSizeInMB

get usedStreamingSizeInMB(): number

Specifies the size (in MB) of all streaming files on the project.

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

usedVersionedSizeInMB

get usedVersionedSizeInMB(): number

Specifies the size (in MB) of all versioned files on the project.

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

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: UUID): void
Parameters
- value: UUID
Returns void