API Reference version 2
Create room glance
Create a glance.
Dynamically created glances have the following restrictions:
- You can only create 10 glances in a room
- You cannot modify a glance that was declared in the descriptor
Path parameters
Type | Parameter | Description | Required? |
---|---|---|---|
string | key |
Unique key (in the context of the integration) to identify this glance. Valid length range: |
|
string | room_id_or_name |
The id of the room Valid length range: |
Request body
Type | Property | Description | Required? |
---|---|---|---|
str | obj | target |
Defines the behaviour when clicking on the glance. |
|
object | [target, object 2] |
An object with the following properties. |
|
object | options |
An object containing options which vary based on the type of target. |
|
string | key |
The key of a dialog, glance or web panel that should be opened in response to this action. Valid length range: |
|
integer | weight |
Determines the order in which glances appear. Glances are displayed top to bottom in order of ascending weight. Defaults to |
|
string | key |
Unique key (in the context of the integration) to identify this glance. Valid length range: |
|
string | queryUrl |
The URL of the resource providing the glance content. |
|
object | icon |
Icon to display on the left side of the glance. |
|
string | url |
Url for the icon. |
|
string | url@2x |
Url for the retina version of the icon. |
|
array | conditions |
Conditions determine whether this glance is shown A mixed array of the following types. |
|
object | [conditions array, option 1] |
An object with the following properties. |
|
boolean | invert |
A flag indicating whether to invert the boolean result of the condition. |
|
object | params |
A map of key/value parameters for a built-in condition. |
|
string | condition |
The identifier of a built-in condition. Valid values: |
|
object | [conditions array, option 2] |
An object with the following properties. |
|
array | conditions |
The conditions to compose using the specific logical operator. A mixed array of the following types. |
|
object | [conditions array, option 1] |
An object with the following properties. |
|
boolean | invert |
A flag indicating whether to invert the boolean result of the condition. |
|
object | params |
A map of key/value parameters for a built-in condition. |
|
string | condition |
The identifier of a built-in condition. Valid values: |
|
object | [conditions array, option 2] |
An object with the following properties. |
|
array | conditions |
The conditions to compose using the specific logical operator. A mixed array of the following types. |
|
object | [conditions array, option 1] |
An object with the following properties. |
|
boolean | invert |
A flag indicating whether to invert the boolean result of the condition. |
|
object | params |
A map of key/value parameters for a built-in condition. |
|
string | condition |
The identifier of a built-in condition. Valid values: |
|
string | type |
Defines what logical operator is used to evaluate the list of conditions. Valid values: |
|
string | type |
Defines what logical operator is used to evaluate the list of conditions. Valid values: |
|
object | name |
The display name of the glance. |
|
string | i18n |
The optional localization key, used to look up the localized value. Valid length range: |
|
string | value |
The default text. Valid length range: |
Type | Property | Description | Required? |
---|---|---|---|
str | int | id |
The unique identifier for the created entity |
|
object | links |
An object with the following properties. |
|
string | self |