Interface ProfileMetadata

The metadata of the profile.

Remarks

This includes the name, version, and other information about the profile.

Since

0.12.0 - Add name and displayName properties.

Since

0.5.0

interface ProfileMetadata {
    dateCreated: string;
    dateUpdated: string;
    displayName: string;
    name: string;
    version: string;
}

Properties

dateCreated dateUpdated displayName name version

Properties

dateCreated

dateCreated: string

The date and time when the profile was created.

dateUpdated

dateUpdated: string

The date and time when the profile was last updated.

displayName

displayName: string

The display name of the profile.

Remarks

If the name is not suitable for display, this property can be used.

Since

0.12.0

name

name: string

The name of the profile.

version

version: string

The version of the profile.

Remarks

This is used to determine the compatibility of the profile with the application. The version is the same as the application version when the profile was created.

A profile with a higher version than the application will fail to load. However, a profile with a lower version will be upgraded to the current version using migration scripts.

Settings

Member Visibility

On This Page

Properties