Get Chat Members

Overview

The Get Chat Members activity calls the Microsoft Graph ListConversationMembers API to retrieve the members of a specified chat (ChatId).

After retrieving the members, the activity returns an array of their properties in a ConversationMember[] object (ChatMembers) that you can use as in input variable in subsequent activities.

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 an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).
Add the Get Chat Members activity inside the Microsoft Teams Scope activity.
Enter a value for the Input property.
Create and enter a ConversationMember[] variable for your Output property.
Run the activity.
- Your input property values are sent to the ListConversationMembers API.
- The API returns the ConversationMember[] 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	`String`
Required	Yes
Default value	Get Chat Members
Allowed values	Enter a `String` or `String` variable.
Notes	N/A

Input

ChatId

The Id of the Chat object that you want to retrieve a list of members from.

Attributes	Details
Type	`String`
Required	Yes
Default value	Empty
Allowed values	Enter a `String` or `String` variable.
Notes	To get the `Chat.Id` value, use an external process or activity that includes the `Chat.Id` value in its output (e.g., Get Chats or external API call)

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

ChatMembers

A list of members and their properties (ConversationMember[] object) from the specified chat.

Attributes	Details
Type	`ConversationMember[]`
Required	No (required if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a `ConversationMember[]` variable.
Notes	The variable you create for this property can be used as an input variable in subsequent activities. The `ConversationMember` object includes multiple properties that you can use in other activities. The example image below shows some of the properties that you can return.