wxc_sdk.room_tabs package

Room tabs API

class wxc_sdk.room_tabs.RoomTab(*, id: str | None = None, roomId: str | None = None, roomType: RoomType | None = None, contentUrl: str | None = None, displayName: str | None = None, creatorId: str | None = None, created: datetime | None = None)[source]

Bases: ApiModel

id: str | None

A unique identifier for the Room Tab.

room_id: str | None

A unique identifier for the room.

room_type: RoomType | None

The room type.

content_url: str | None

URL of the Room Tab. Must use https protocol.

display_name: str | None

User-friendly name for the room tab.

creator_id: str | None

The person ID of the person who created this Room Tab.

created: datetime | None

The date and time when the Room Tab was created.

class wxc_sdk.room_tabs.RoomTabsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

A Room Tab represents a URL shortcut that is added as a persistent tab to a Webex room (space) tab row. Use this API to list tabs of any Webex room that you belong to. Room Tabs can also be updated to point to a different content URL, or deleted to remove the tab from the room. Just like in the Webex app, you must be a member of the room in order to list its Room Tabs.

list_tabs(room_id: str, **params) → Generator[RoomTab, None, None][source]

Lists all Room Tabs of a room specified by the roomId query parameter.

Parameters:

room_id (str) – ID of the room for which to list room tabs.

create_tab(room_id: str, content_url: str, display_name: str) → RoomTab[source]

Add a tab with a specified URL to a room.

Parameters:

  • room_id (str) – A unique identifier for the room.

  • content_url (str) – URL of the Room Tab. Must use https protocol.

  • display_name (str) – User-friendly name for the room tab.

tab_details(tab_id: str) → RoomTab[source]

Get details for a Room Tab with the specified room tab ID.

Parameters:

tab_id (str) – The unique identifier for the Room Tab.

update_tab(tab_id: str, room_id: str, content_url: str, display_name: str) → RoomTab[source]

Updates the content URL of the specified Room Tab ID.

Parameters:

  • tab_id (str) – The unique identifier for the Room Tab.

  • room_id (str) – ID of the room that contains the room tab in question.

  • content_url (str) – Content URL of the Room Tab. URL must use https protocol.

  • display_name (str) – User-friendly name for the room tab.

delete_tab(tab_id: str)[source]

Deletes a Room Tab with the specified ID.

Parameters:

tab_id (str) – The unique identifier for the Room Tab to delete.

base = 'room/tabs'