Get Channels

Overview

Using your search parameters (QueryOptions) and specified team (TeamId), the Get Channels activity calls the Microsoft Graph ListChannels API to retrieve the channels that match your query .

After retrieving the channels, the activity returns its properties and relationships in a Channel[] object (Channels) that you can use as input variables in subsequent activities (e.g., Channel(0).Id in Get Messages, Send Message, etc.).

How It Works

The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Microsoft Teams Scope activity to your project.
3. Add an activity or run an external process that outputs a Team.Id value (e.g., Get Teams).
4. Add the Get Channels activity inside the Microsoft Teams Scope activity.
5. Enter values for the Input properties.
6. Create and enter a Channel[] variable for your Output property.

7. Run the activity.

   • Your input property values are sent to the ListChannels API.
   • The API returns the Channel[] 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 Channels
Allowed values	Enter a String or String variable.
Notes	N/A

Input

TeamId

The Id of the Team object that you want to retrieve channels from.

Attributes	Details
Type	String
Required	Yes
Default value	Empty
Allowed values	Enter a String or String variable.
Notes	To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (e.g., Get Teams 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

Options

QueryOptions

The search parameters that you want to apply when retrieving your list of channels.

Attributes	Details
Type	QueryOption[] (OData syntax)
Required	No
Default value	Empty
Allowed values	Enter a QueryOption[] or QueryOption variable.
Notes	Enter your value using an OData system query option; the format is as follows: _{New QueryOption("Option", "OptionParameter")}. For example, if you want to apply the $filter option, you would enter "filter" as the first string and then enter a filter parameter as the second string (e.g., {New QueryOption("filter", "displayName ne 'General'")}.

Output

Channels

An array of channels (Channel[] object) that match QueryOptions value.

Attributes	Details
Type	Channel[]
Required	No (required if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a Channel[] variable.
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.). * When using this variable as an input property value, specify the item in the array that you want to use (e.g., createdChannels(0)). The Channel object includes multiple properties and relationships that you can use in other activities.The example image below shows some of the properties that you can return. Note - some properties listed in the designer are not applicable to the Channel object (e.g., Visibility). For a list of the applicable Team properties, visit the links above.

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.