Skip to content

teamstab.md

Latest commit

 

History

History
96 lines (73 loc) · 3.65 KB

teamstab.md

File metadata and controls

96 lines (73 loc) · 3.65 KB
title teamsTab resource type
description Represents a tab pinned (attached) to a channel or a chat.
ms.localizationpriority medium
author AkJo
ms.subservice teams
doc_type resourcePageType
ms.date 04/20/2024

teamsTab resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a tab pinned (attached) to a channel or a chat.

For more information about tabs, see Build tabs for Teams.

Methods

Method Return Type Description
List tabs in channel teamsTab List tabs pinned to a channel.
Get tab in channel teamsTab Get a specific tab pinned to a channel.
Add tab to channel teamsTab Add (pin) a tab to a channel.
Update tab in channel teamsTab Updates the properties of a tab in a channel.
Remove tab from channel None Remove (unpin) a tab from a channel.
List tabs in chat teamsTab List tabs pinned to a chat.
Get tab in chat teamsTab Get a specific tab pinned to a chat.
Add tab to chat teamsTab Add (pin) a tab to a chat.
Update tab in chat teamsTab Update the properties of a tab in a chat.
Remove tab from chat None Remove (unpin) a tab from a chat.

Properties

Property Type Description
id string Identifier that uniquely identifies a specific instance of a channel tab. Read only.
displayName string Name of the tab.
name (deprecated) string Name of the tab.
teamsAppId (deprecated) string App definition identifier of the tab. This value can't be changed after tab creation. Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
sortOrderIndex string Index of the order used for sorting tabs.
webUrl string Deep link URL of the tab instance. Read only.
configuration teamsTabConfiguration Container for custom settings applied to a tab. The tab is considered configured only once this property is set.

Relationships

Relationship Type Description
teamsApp teamsApp The application that is linked to the tab.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "string",
  "displayName": "string",
  "teamsAppId": "string",
  "sortOrderIndex": "string",
  "webUrl": "string",
  "configuration": "teamsTabConfiguration",
  "name": "string"
}

Related content

Configuring the built-in tab types