Class UserServiceSubscriptionInfo

Subscription information for the currently authenticated user.

Index

Constructors

Accessors

currentProjectCount currentUserCount featureFlags isEarlyAccess maximumProjectCount maximumProjectUserCount maximumUserCount percentage plan storageSize storedSize

Constructors

`Protected`constructor

new UserServiceSubscriptionInfo(
isInternalConstructor?: boolean,
): UserServiceSubscriptionInfo
Parameters
- OptionalisInternalConstructor: boolean
Returns UserServiceSubscriptionInfo

Overrides FrameworkObject.constructor

Accessors

currentProjectCount

get currentProjectCount(): number

Number of projects currently accessible to the user.

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

currentUserCount

get currentUserCount(): number

Number of members in the user's owned team. 0 if the user does not own a team.

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

featureFlags

get featureFlags(): Iterable<string>

The subscription feature flags granted to the user (e.g. "StandaloneWebDeployment").

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

isEarlyAccess

get isEarlyAccess(): boolean

Whether the subscription is an early access subscription.

Returns boolean
set isEarlyAccess(value: boolean): void
Parameters
- value: boolean
Returns void

maximumProjectCount

get maximumProjectCount(): number

Maximum number of private projects allowed by the subscription. Empty when there is no limit.

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

maximumProjectUserCount

get maximumProjectUserCount(): number

Maximum number of users per private project allowed by the subscription. Empty when there is no limit.

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

maximumUserCount

get maximumUserCount(): number

Maximum number of team members allowed by the subscription. Empty when there is no limit.

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

percentage

get percentage(): number

Storage usage as a percentage (0-100, 2 decimals). Meaningful only when {

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

plan

get plan(): string

The plan identifier (e.g. "Starter", "Professionals", "Teams", "Enterprise").

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

storageSize

get storageSize(): number

Total storage size available to the user, in bytes. Empty when storage is unlimited.

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

storedSize

get storedSize(): number

Storage currently used by the user, in bytes.

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