In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Use You can use this Snap to perform the following operations upon the specified channel:
Add members
Remove members
List members
Rename channel
...
...
Snap Type
Teams - Channel Operations Snap is a Write-type Snap that performs channel operations like add/remove/list members and updating channel names.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
...
None.
& Known Issues
None.
Snap
...
Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing channel details, member list, team ID, or channel ID. |
Output | Document |
|
| A document containing details of the selected operation's execution. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
...
Info |
---|
|
Field Name | Field Type | Field Dependency | Description | |
---|---|---|---|---|
Label* Default Value: Channel Operations | String | N/A | Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |
Operation* Default Value: Add Members | String | N/A | Select the channel operation to perform. |
Available options |
include:
|
|
|
|
Add/Remove Members You can add or remove members in private channels only. Public channels contain all team members, by default. |
Team ID* Default Value: N/A | String/Expression/Suggestion |
N/A | Specify the ID of the team. Alternatively, click the icon to fetch a list of team IDs associated with the account. |
Channel ID* Default Value: N/A | String/Expression/Suggestion |
N/A | Specify the ID of the target channel that belongs to the selected team. Alternatively, click the icon to fetch a list of channel IDs associated with the specified team. |
Channel ID format Use this format to specify the channel in this field |
: <Channel_Name><space>:<space><Channel_ID> |
Add Members |
Activates when you select the Add Members option in the Operation field.
Use this |
fieldset to add members to the channel. |
Member ID |
Default Value: N/A | String/Expression/Suggestion |
Activates when you select the Add Members option in the Operation field. | Specify the ID of the member to add. Alternatively, click the icon to fetch a list of member IDs associated with the team. You can use each row to specify a member or include multiple members separated by commas, in the same row. |
Add Channel Owners | Use this fieldset to assign owners for the channel. | |||
Owner ID Default Value: N/A |
String/Expression/Suggestion | Activates when you select the Add Members option in the Operation field. |
Use this field set to assign owners for the channel.
This field set contains the Owner ID field.
Specify the ID of the member. Alternatively, click the icon to fetch a list of member IDs associated with the team. |
You can use each row to specify an owner or include multiple owners separated by commas, in the same row. |
Remove Members | Use this fieldset to remove members from the channel. | |||
Member ID Default Value: N/A |
String/Expression/Suggestion | Activates when you select the Remove Members option in the Operation field. |
Use this field set to remove members from the channel.
This field set contains the Member ID field.
Specify the ID of the member to remove. Alternatively, click the icon to fetch a list of member IDs associated with the team. |
You can use each row to specify a member or include multiple members separated by commas, in the same row. |
New Channel Name Default Value: N/A |
Example: New_Contractors | String/Expression | Activates when you select the Rename Channel option in the Operation field. |
Specify the new name for the channel. |
Number of Retries Default Value: 0 | Integer/Expression | Activates when you select the Add Members, Remove Members, or Rename Channel option in the Operation field. |
Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. |
To avoid 502 Bad Gateway error Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. |
Retry Interval (seconds) |
Default Value: 1 | Integer/Expression | Activates when you select the Add Members, Remove Members, or Rename Channel option in the Operation field. |
Specify the time interval in seconds between retry attempts. |
To avoid 502 Bad Gateway error Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. |
Snap Execution Default Value: Execute only | Dropdown list | N/A | Select one of the three following modes in which the Snap executes:
|
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Unsupported Operation | You tried adding members to a public channel. | Verify whether the specified/selected channel is a public channel. |
Examples
Performing Channel Operations
The following example Pipeline demonstrates how you can use the Channel Operations Snap to perform various actions on channels within your Microsoft Teams instance. This example assumes that you have:
Set up your application in Azure Portal with necessary permissions.
Configured the required Snap account with necessary scopes.
Created a public or private channel using the Create Channel Snap.
...
This Pipeline uses the OAuth2 user account (authorization code grant type) to carry out the channel operations on behalf of a signed-in user. It uses five instances of the Channel Operations Snap, each performing one of the following operations on the channel:
Add Members (to the channel)
Rename Channel
Remove Members (from the channel)
List Members (in the channel)
Adding members to the channel
In the Channel Operations Snap's settings, select the Add Members option from the Operation drop-down list. Configure the Snap further by providing the channel details and the member/s to add. You can set one or more channel owners, who need not be members of the channel. Besides the Suggest icons provided, you can also use expressions to specify these details.
Channel Operations Snap to add members to a channel |
Output |
Make a copy of this Snap's output using the Copy Snap to simultaneously use the output in two Snaps.
Copy Snap |
Output |
Renaming a channel
Add a Channel Operations Snap to one of the Copy Snap outputs and choose Rename Channel option as the Operation. Configure the Snap further to provide the channel details and the new name for the channel. Besides the Suggest icons provided, you can also use expressions to specify these details.
Channel Operations Snap to rename a channel |
Output |
Removing members from a channel
Add another Channel Operations Snap to the other Copy Snap output and choose Remove Members option as the Operation. Configure the Snap further to provide the channel details and the new name for the channel. Besides the Suggest icons provided, you can also use expressions to specify these details.
...
...
Removing Members Snap to remove member from channel | Output |
Info |
---|
Removing a channel memberTo remove a channel member without using the Suggest icon in the Member ID field, ensure that you specify/pass the |
...
To retrieve and verify the updated list of channel members, you can add a Channel Operations Snap to either or both the Snaps (Rename Channel and Remove Member). You can also configure these Snaps to perform List members operation.
Channel Operations Snap to retrieve updated list of channel members |
---|
after renaming the channel | Output |
---|---|
Channel Operations Snap to retrieve updated list of channel members |
after removing one |
---|
Output |
---|
Downloads
Note |
---|
Info |
Important Steps to Successfully Reuse Pipelines
|
Attachments | ||
---|---|---|
|
...
Snap Pack History
Expand | ||||
---|---|---|---|---|
|
...
|
...
|
...
|
...