Создание приложений для этапа собрания Teams

Совместное использование на этапе позволяет пользователям предоставлять общий доступ к приложению на этапе собрания с боковой панели собрания в текущем собрании. Этот общий доступ является интерактивным и совместным по сравнению с пассивным демонстрацией экрана.

Чтобы вызвать общий доступ к сцене, пользователи могут щелкнуть значок Поделиться на сцену в правом верхнем углу боковой панели собрания. Значок "Поделиться в стадию" является собственным для клиента Teams, и при его выборе все приложение предоставляется на этапе собрания.

Параметры манифеста приложения для приложений на этапе собрания

Чтобы предоставить общий доступ к приложению на этапе собрания, необходимо настроить контекст и разрешения RSC в манифесте приложения:

  1. Обновите context свойство в манифесте приложения следующим образом:

    "context": [
      "meetingSidePanel",
      "meetingStage"
    ]
    
  2. Получите разрешения RSC, настроив authorization свойство и name и type в resourceSpecific поле следующим образом:

    "authorization": {
      "permissions": {
        "resourceSpecific": [
          {
            "name": "MeetingStage.Write.Chat",
            "type": "Delegated"
          }
        ]
      }
    }
    

API-интерфейсы расширенного общего доступа для промежуточного использования

Существует множество сценариев, в которых общий доступ ко всему приложению на стадии собрания не так полезен, как предоставление общего доступа к определенным частям приложения:

  1. Для приложения мозгового штурма или доски пользователю может потребоваться предоставить доступ к определенной доске на собрании, а не ко всему приложению со всеми досками.

  2. Для медицинского приложения, врач может захотеть поделиться только рентгеновским снимок на экране с пациентом, а не делиться всем приложением со всеми записями пациентов или результатами и т. д.

  3. Пользователю может потребоваться предоставить общий доступ к содержимому от одного поставщика содержимого (например, YouTube), а не предоставлять доступ ко всему каталогу видео на сцене.

Чтобы помочь пользователям в таких сценариях, мы выпустили API в клиентской библиотеке JavaScript (TeamsJS) Microsoft Teams, которые позволяют программно вызывать общий доступ к сцене для определенных частей приложения с помощью кнопки на боковой панели собрания.

На следующем рисунке показан параметр "Поделиться на стадию" в классическом клиенте Teams:

Снимок экрана: представление

Используйте следующие API для предоставления общего доступа к определенной части приложения:

Метод Описание Source
Делитесь содержимым приложения на сцене Предоставление доступа к определенным частям приложения на стадии собрания с боковой панели собрания в собрании. Библиотека TeamsJS
Получить состояние обмена сцены содержимого приложения Получить информацию о состоянии общего доступа к приложению на сцене собрания. Библиотека TeamsJS
Получить возможности обмена сцены содержимого приложения Получите возможности приложения для совместного использования на сцене собрания. Библиотека TeamsJS

Поделитесь содержимым приложения на сцене API

API shareAppContentToStage позволяет вам делиться определенными частями вашего приложения на сцене собрания. API доступен через библиотеку TeamsJS.

Предварительное условие

appContentUrl должен быть разрешен массивом validDomains внутри manifest.json, иначе API возвращает ошибку 501.

Параметр запроса

В следующей таблице приведены параметры запроса:

Значение Тип Обязательный Описание
callback String Да Обратный вызов содержит два параметра, ошибку и результат. Ошибка может содержать ошибку типа SdkError или null при успешном использовании общего доступа. Результат может содержать значение true, если общий ресурс успешно выполнен, или значение NULL при сбое общего ресурса.
appContentURL String Да URL-адрес, который будет опубликован на сцене.

Пример

const appContentUrl = "https://www.bing.com/";

microsoftTeams.meeting.shareAppContentToStage((err, result) => {
    if (result) {
        // handle success
    }
    if (err) {
        // handle error
    }
}, appContentUrl);

Коды ответа

В следующей таблице приведены коды ответов:

Код ответа Описание
500 Внутренняя ошибка.
501 API не поддерживается в текущем контексте.
1000 Приложение не имеет необходимых разрешений для предоставления общего доступа к этапу.

Получить состояние обмена сцены содержимого приложения API

getAppContentStageSharingState API позволяет получать сведения о совместном использовании приложений на этапе собрания.

Параметр запроса

В следующей таблице содержится параметр запроса:

Значение Тип Обязательный Описание
callback String Да Обратный вызов содержит два параметра, ошибку и результат. Эта ошибка может содержать ошибку типа SdkError в случае ошибки или значение NULL при успешном использовании общего доступа. Результат может содержать объект, если общий IAppContentStageSharingState ресурс успешно используется, или null в случае ошибки.

Пример

microsoftTeams.meeting.getAppContentStageSharingState((err, result) => {
    if (result.isAppSharing) {
        // Indicates if app is sharing content on the meeting stage.
    }
});

Текст отклика JSON для getAppContentStageSharingState API:

{
  "isAppSharing": true
}

Коды ответа

В следующей таблице приведены коды ответов:

Код ответа Описание
500 Внутренняя ошибка.
501 API не поддерживается в текущем контексте.
1000 Приложение не имеет необходимых разрешений для предоставления общего доступа к этапу.

Получить возможности обмена сцены содержимого приложения API

getAppContentStageSharingCapabilities API позволяет получить возможности приложения для предоставления общего доступа к содержимому приложения на стадии собрания. Приложения должны вызвать getAppContentStageSharingCapabilities API, чтобы включить или отключить настраиваемую кнопку общей папки для этапа для участника собрания на боковой панели собрания. Кнопка "Общий доступ к этапу" должна быть отключена или скрыта, если у участника собрания нет разрешения на предоставление общего доступа к содержимому приложения на стадии собрания.

Возможности общего доступа к приложениям зависят от типа пользователя клиента и ролей участников собрания.

  • Тип пользователя. Участники типа в клиенте, гостевом и внешнем пользователях могут предоставлять общий доступ к приложению на этапе, а также просматривать приложение, к которым предоставляется общий доступ на этапе, и взаимодействовать с ним. Анонимный пользователь не может видеть приложение, к которому предоставляется общий доступ, или взаимодействовать с ним. Дополнительные сведения см. в разделе Типы пользователей на собрании.

  • Роли пользователей. Участники с ролями выступающих и организаторов в собрании могут предоставлять общий доступ к приложению для этапа. У участника не будет включена кнопка "Общий доступ к этапу" и возможность предоставления общего доступа к приложению на этапе. Дополнительные сведения см. в разделе Роли пользователей в собрании Teams.

Параметр запроса

В следующей таблице содержится параметр запроса:

Значение Тип Обязательный Описание
callback String Да Обратный вызов содержит два параметра, ошибку и результат. Ошибка может содержать ошибку типа SdkError или null при успешном использовании общего доступа. Результат может содержать либо объект, если общий IAppContentStageSharingCapabilities ресурс успешно используется, либо значение NULL в случае ошибки.

Пример

microsoftTeams.meeting.getAppContentStageSharingCapabilities((err, result) => {
    if (result.doesAppHaveSharePermission) {
        // Indicates if the meeting participant has permission to share content to the meeting stage.
    }
});

Текст отклика JSON для getAppContentStageSharingCapabilities API:

{
   "doesAppHaveSharePermission":true
} 

Коды ответа

В следующей таблице приведены коды ответов:

Код ответа Описание
500 Внутренняя ошибка.
501 API не поддерживается в текущем контексте.
1000 Приложение не имеет разрешений на разрешение общей папки на стадии.

Создание приложения для подписывания документов на собрании

Вы можете создать приложение на собрании, позволяющее участникам собрания подписывать документы в режиме реального времени. Это упрощает проверку и подписывание документов в одном сеансе. Участники могут подписывать документы с помощью текущего удостоверения клиента.

Приложение для подписи на собрании можно использовать для:

  • Добавление документов для проверки во время собрания.
  • Предоставление общего доступа к документам для проверки на main этапе.
  • Подписывая документы, используя удостоверение подписывателя.

Участники могут просматривать и подписывать документы, такие как соглашения о покупке и заказы на покупку.

Снимок экрана: приложение для подписывания документов на собрании

Во время собрания могут быть задействованы следующие роли участников:

  • Создатель документа. Эта роль может добавлять собственные документы для проверки и подписания.
  • Подписыватель: эта роль может подписывать проверенные документы.
  • Читатель. Эта роль может просматривать документы, добавленные на собрание.

Совместимость функций по типам пользователей

В следующей таблице приведены типы пользователей и перечислены функции, к которым каждый пользователь может получить доступ на собраниях.

Тип пользователя Запланированное собрание или мгновенное собрание по календарю Один-на-один Групповой вызов Запланированное собрание канала
В клиенте Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Guest Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Выступающий или организатор может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Федеративный или внешний Выступающий может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Недоступно Недоступно Выступающий может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Анонимный Выступающий может запускать, просматривать приложение и взаимодействовать с ним на этапе собрания.

Участник может только просматривать и взаимодействовать.
Недоступно Недоступно Недоступно

Пример кода

Название примера Описание .NET Node.js Манифест
Пример сцены собрания В этом примере приложения показана вкладка на этапе собрания для совместной работы. В этом примере также используется пакет SDK live share для совместной работы с представлением этапа. Просмотр Просмотр Просмотр
Уведомление на собрании Демонстрирует реализацию уведомлений о собраниях с помощью бота. Просмотр Просмотр Просмотр
Подписывание документов на собрании В этом примере приложения показано, как реализовать приложение Teams для подписывания документов. Включает предоставление общего доступа к определенному содержимому приложения для этапа, единого входа Teams и пользовательского представления этапа. Просмотр Недоступно Недоступно

Пошаговые инструкции

Следуйте инструкциям из пошагового руководства , чтобы создать приложение для подписывания документов на собрании.

См. также