AppHostInfo interface
Represents information about the application's host.
Properties
| ancestors | An array representing the hierarchy of ancestor hosts that the app is embedded inside of. The array is ordered from immediate parent to root host. For example, if Bizchat is running in Calendar in Teams, this would be ["Calendar", "Teams"]. |
| client |
The client type on which the host is running |
| features | The features supported by the host. This is an optional field that may not be populated by all hosts, and may be added to over time as new features are added to hosts. Because of this, apps should always check for the presence of a feature and its value before using it, and should gracefully handle the case where the feature is not present. |
| name | Identifies which host is running your app |
| ring |
Current ring ID |
| session |
Unique ID for the current Host session for use in correlating telemetry data. |
Property Details
ancestors
An array representing the hierarchy of ancestor hosts that the app is embedded inside of. The array is ordered from immediate parent to root host. For example, if Bizchat is running in Calendar in Teams, this would be ["Calendar", "Teams"].
ancestors?: string[]Property Value
string[]
clientType
The client type on which the host is running
clientType: HostClientTypeProperty Value
features
The features supported by the host. This is an optional field that may not be populated by all hosts, and may be added to over time as new features are added to hosts. Because of this, apps should always check for the presence of a feature and its value before using it, and should gracefully handle the case where the feature is not present.
features?: HostFeaturesProperty Value
name
ringId
Current ring ID
ringId?: stringProperty Value
string
sessionId
Unique ID for the current Host session for use in correlating telemetry data.
sessionId: stringProperty Value
string