Overview
The Get Chats activity uses the Microsoft Graph ListChats API to retrieve all the chats the user is a member of (user determined by the connection established via the Microsoft Teams Scope activity).
After performing the search, the activity outputs the chat properties in a Chat[]
object that you can use as input variables in subsequent activities (e.g., Chat.Id
in Get Messages, Send Message, etc.).
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Add the Get Chats activity inside the Microsoft Teams Scope activity.
- Create and enter a
Chat[]
variable for your Output property. - Run the activity.
- Your input property values are sent to the ListChats API.
- The API returns the
Chat[]
value to your output property variable.


Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.


Common
DisplayName
The display name of the activity.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Get Chats |
Allowed values | Enter a |
Notes | N/A |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
Attributes | Details |
---|---|
Type | Checkbox |
Required | No |
Default value | Not Selected |
Allowed values | Selected or Not Selected |
Notes | N/A |
Output
Chats
An array of chats (Chat[]
object) that match the user is a member of.
Attributes | Details |
---|---|
Type |
|
Required | No (required if you plan to use the output data in subsequent activities) |
Default value | Empty |
Allowed values | Enter a |
Notes | The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get Messages, Send Message, etc.)
|
Example
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guides.


Updated 5 months ago