Compartilhar via


AppInfo interface

Represents application information.

Properties

appLaunchId

ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data.

host

Info of the host

iconPositionVertical

Personal app icon y coordinate position

locale

The current locale that the user has configured for the app formatted as languageId-countryId (for example, en-us).

osLocaleInfo

More detailed locale info from the user's OS if available. Can be used together with the @microsoft/globe NPM package to ensure your app respects the user's OS date and time format configuration

parentMessageId

The ID of the parent message from which this task module was launched. This is only available in task modules launched from bot cards.

sessionId

Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.

theme

The current UI theme of the host. Possible values: "default", "dark", "contrast" or "glass".

userClickTime

Time when the user clicked on the tab

userFileOpenPreference

Where the user prefers the file to be opened from by default during file open

Property Details

appLaunchId

ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data.

appLaunchId?: string

Property Value

string

host

Info of the host

host: AppHostInfo

Property Value

iconPositionVertical

Personal app icon y coordinate position

iconPositionVertical?: number

Property Value

number

locale

The current locale that the user has configured for the app formatted as languageId-countryId (for example, en-us).

locale: string

Property Value

string

osLocaleInfo

More detailed locale info from the user's OS if available. Can be used together with the @microsoft/globe NPM package to ensure your app respects the user's OS date and time format configuration

osLocaleInfo?: LocaleInfo

Property Value

parentMessageId

The ID of the parent message from which this task module was launched. This is only available in task modules launched from bot cards.

parentMessageId?: string

Property Value

string

sessionId

Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.

sessionId: string

Property Value

string

theme

The current UI theme of the host. Possible values: "default", "dark", "contrast" or "glass".

theme: string

Property Value

string

userClickTime

Time when the user clicked on the tab

userClickTime?: number

Property Value

number

userFileOpenPreference

Where the user prefers the file to be opened from by default during file open

userFileOpenPreference?: FileOpenPreference

Property Value