Access rights operations
This category consists of operations related to chat access management that can be used in a bot.
Invite a user to a chat
Invites a user with the given name to the current chat. Note that bot agent must have sufficient rights in the chat to be able to invite others. This operation has the following properties.
| Property name | Type | Description |
| Description | String | Displayed name of the operation. This property is only used in the HMI and has no effect at run-time. |
| User name | String |
Name of the user or Smart Bot to invite. This property supports usage of internal bot variables. |
| Access level | String |
Access level for the invited user in this chat. Note that bot agent must have sufficient rights in the chat to be able to configure the access level. |
Remove a user from a chat
Removes a user with the given user name from the current chat. Note that bot agent must have sufficient rights in the chat to be able to remove others. This operation has the following properties.
| Property name | Type | Description |
| Description | String | Displayed name of the operation. This property is only used in the HMI and has no effect at run-time. |
| User name | String |
Name of the user or Smart Bot to remove. Use the current Bot name in order to quit the chat. This property supports usage of internal bot variables. |
Set user occupation
Associates a given occupation string to the user. The occupation string is a run-time property and is not persistent on the disk. This operation has the following properties.
| Property name | Type | Description |
| Description | String | Displayed name of the operation. This property is only used in the HMI and has no effect at run-time. |
| User name | String |
Name of the user whose occupation is to be changed. This property supports usage of internal bot variables. |
| Occupation | String |
Arbitrary string that can be used to find the right user in the list. This property supports usage of internal bot variables. |
Find the right user
Applies the specified filter on the list of chat users and saves the selected user name in Bot agent’s memory along with the total amount of users satisfying the given filtering criteria. This operation has the following properties.
| Property name | Type | Description |
| Description | String | Displayed name of the operation. This property is only used in the HMI and has no effect at run-time. |
| Key | String |
Unique reference to the value in memory. This property supports usage of internal bot variables. |
| Key for count | String |
Unique reference to the value in memory. This property supports usage of internal bot variables. |
| Scope | Enum |
Accessibility scope of value in memory specified by the Key reference. The following values are available.
|
| Index of the user | Integer |
1-based index of the user in the list of selected users, i.e. corresponding to the specified filters. This property supports usage of internal bot variables. |
| Connected | Boolean |
True to select only the users currently connected via a mobile application. |
| Order by profile level | Enum |
Order the list of selected users by their profile level. The following values are available.
|
| Minimum profile level | Integer |
Selects only users with the profile level greater or equal to that specified. |
| Maximum profile level | Integer |
Selects only users with the profile level lower or equal to that specified. |
| Filter by availability | Options |
Selects only users with the checked availability in the chat. Availability is a run-time property of users initialized by the Scheduler from Microsoft Office 365 when it is connected. |
| Filter by occupation | Function |
A function that will be applied to compare the actual user occupation string and the value of the Occupation property. The following functions are available.
|
| Occupation | String |
Text or regular expression verified using the Filter by occupation function. This property supports usage of internal bot variables. |
| Filter by access level | Options |
Selects only users with the checked access level in the chat. |
| Order by distance | Enum |
|
| Latitude | Double |
GPS Latitude (in WGS84) coordinate used for filtering and ordering by distance. This property supports usage of internal bot variables. |
| Longitude | Double |
GPS Longitude (in WGS84) coordinate used for filtering and ordering by distance. This property supports usage of internal bot variables. |
| Minimum distance in meters | Double |
Selects only users with a known position and whose distance to the specified position is greater or equal to the given distance in meters. |
| Maximum distance in meters | Double | Selects only users with a known position and whose distance to the specified position is less or equal to the given distance in meters |
Get information about the user
Saves a specified property of the user in Bot agent’s memory. Only current chat users are available. This operation has the following properties.
| Property name | Type | Description |
| Description | String | Displayed name of the operation. This property is only used in the HMI and has no effect at run-time. |
| Key | String |
Unique reference to the value in memory. This property supports usage of internal bot variables. |
| Scope | Enum |
Accessibility scope of value in memory specified by the Key reference. The following values are available.
|
| User name | String |
Name of the user whose information needs to be read. This property supports usage of internal bot variables. |
| Information to retrieve | Enum |
The property of a given user to read. The following values are available.
The Tracking feature is required to receive the position and location related properties.
|