Interface ProjectFeature

Details of a project feature.

interface ProjectFeature {
    feature?: string;
    imageUri?: string;
    localisedDescription?: string;
    localisedName?: string;
    prerequisites?: string[];
    projectId?: number;
    state?: "ENABLED" | "DISABLED" | "COMING_SOON";
    toggleLocked?: boolean;
}

Properties

feature? imageUri? localisedDescription? localisedName? prerequisites? projectId? state? toggleLocked?

Properties

Optionalfeature

feature?: string

The key of the feature.

OptionalimageUri

imageUri?: string

URI for the image representing the feature.

OptionallocalisedDescription

localisedDescription?: string

Localized display description for the feature.

OptionallocalisedName

localisedName?: string

Localized display name for the feature.

Optionalprerequisites

prerequisites?: string[]

List of keys of the features required to enable the feature.

OptionalprojectId

projectId?: number

The ID of the project.

Optionalstate

state?: "ENABLED" | "DISABLED" | "COMING_SOON"

The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values

OptionaltoggleLocked

toggleLocked?: boolean

Whether the state of the feature can be updated.

Settings

Member Visibility

On This Page

Properties