Манифест
remeet.json описывает приложение: название, где лежат его страницы и что оно просит. Это JSON-файл на любом https-адресе. JSON Schema для редакторов: sdk.remeet.video/schema/v0/remeet.json.
json
{
"$schema": "https://sdk.remeet.video/schema/v0/remeet.json",
"key": "hello-remeet",
"version": "0.1.0",
"name": { "en": "Hello ReMeet", "ru": "Привет, ReMeet", "ar": "مرحبًا ReMeet" },
"description": {
"en": "Wave to everyone in the meeting and count together on a shared stage.",
"ru": "Помашите всем во встрече и считайте вместе на общей сцене."
},
"art": "https://sdk.remeet.video/hello/art.svg",
"developer": { "name": "ReMeet", "url": "https://sdk.remeet.video" },
"surfaces": {
"panel": { "url": "https://sdk.remeet.video/hello/panel.html" },
"stage": { "url": "https://sdk.remeet.video/hello/stage.html" }
},
"permissions": ["participants.read", "app.broadcast", "badges.write", "stage.start", "storage"]
}Это настоящий манифест примера Hello ReMeet.
Поля
| Поле | Обязательно | Правила |
|---|---|---|
key | да | Уникальный id приложения: 3–40 строчных латинских букв, цифр и дефисов, начинается с буквы или цифры. Не может совпадать с ключом встроенного приложения ReMeet. Не меняется после добавления. |
version | да | Три числа: 0.1.0. Видна в маркетплейсе. |
name | да | Объект с текстами по языкам. en обязателен, ru и ar — по желанию. До 60 символов. |
description | да | Так же, как name, до 300 символов. |
art | нет | https-адрес картинки для маркетплейса. Лучше квадратная, SVG или PNG с прозрачным фоном. |
developer.name | да | Кто сделал приложение, до 80 символов. |
developer.url, developer.email | нет | Ваш сайт (https) и контакт. |
surfaces | да | Хотя бы одно из panel и stage, у каждого https-адрес url. См. где показывается приложение. |
permissions | нет | Что просит приложение. См. Права. |
media | нет | camera и/или microphone, если они нужны самой странице. |
Название и описание человек видит на своём языке, если вы его указали, иначе — на английском.
Где могут лежать страницы
- Только по адресам https.
- Не на самом
remeet.video: приложение — это чужой код, поэтому оно живёт на своём домене. - Сам файл манифеста — до 64 КБ.
Ошибки
Если манифест не прошёл проверку, ReMeet говорит, что именно не так, например:
- «key»: 3–40 строчных латинских букв, цифр и дефисов.
- «version»: три числа, например 0.1.0.
- «surfaces.panel.url» должен быть https-адресом.
- Неизвестные права: read.mind.
- Приложение с ключом wave уже есть.
Обновление приложения
Поменяйте файлы, поднимите version и обновите приложение из манифеста (сейчас — через команду ReMeet; аккаунты разработчиков будут делать это сами). Что меняется у тех, кто уже установил приложение:
- Название, описание, картинка и адреса страниц обновляются у всех сразу.
- Убранное право отбирается у всех сразу.
- Добавленное право автоматически не выдаётся. Те, кто поставил приложение раньше, остаются со старым набором, пока не удалят приложение и не добавят его снова. Перед тем как пользоваться новым правом, проверяйте
app.can('…').