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.
Key for count is used to enumerate between several users that satisfies the given filter. Total amount of selected users is written to the corresponding variable. Further selection can be made by using the Index property of the operation.

Scope Enum

Accessibility scope of value in memory specified by the Key reference. The following values are available.

  • Private – value is available only for the current bot.

  • Internal – value is available for the current thread, i.e. for parent bots, for the current bot and for all children executed bots.

  • Shared – value is available for all bots.

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.

  • Do not order by profile level – order of users is not modified.

  • With the highest profile level (Closer to 0) – order the list of users according to their profile level: 0,1,2, etc.

  • With the lowest profile level (Closer to 9) – order the list of users according to their profile level: 9,8,7, etc.

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.

  • Any value – any text is accepted.

  • Equals – the exact text matching is required.

  • Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options.

  • Contains – the occupation string must contain the specified value.

  • Contains any of the following strings – the occupation string must contain any of the specified values. Use one string per line to separate values

  • Starts with – the occupation string must start with the specified value.

  • Starts with any of the following strings – the occupation string must start with any of the specified values. Use one string per line to separate values.

  • Ends with – the occupation string must end with the specified value.

  • Ends with any of the following strings – the occupation string must end with any of the specified values. Use one string per line to separate values.

  • Not equals – the occupation string must not match the specified value.

  • Not contains – the occupation string must not contain the specified value.

  • Not starts with – the occupation string must not start with the specified value.

  • Not ends with – the occupation string must not end with the specified value.

  • Match regular expression – the occupation string must match the specified regular expression. See this Microsoft article about the Regex Class for further details.

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
  • Order the list of selected users by their distance to the position defined in the Latitude and Longitude properties. The following values are available.

  • Do not order by distance – order of users is not modified.

  • Closest – start with users closest to the specified position.

  • Farthest – start with users farthest from the specified position.

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.

  • Private – value is available only for the current bot.

  • Internal – value is available for the current thread, i.e. for parent bots, for the current bot and for all children executed bots.

  • Shared – value is available for all bots.

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.

  • Display.

  • E-mail.

  • Phone number.

  • Title.

  • Last name.

  • Profile level.

  • Occupation.

  • Availability – free/busy status of the user.

    Runtime property initialized by Scheduler. Note that connected MS Graph plug-in is required to receive this property.
  • Mobile connectivity – specifies if the user is currently connected via Mobile application.

  • Latitude.

  • Longitude

  • Name of the current zone.

  • Description of the current zone.

The Tracking feature is required to receive the position and location related properties.