СистемаВзаимодействия

Тип-одиночка
Стд::СистемаВзаимодействия::СистемаВзаимодействия
Базовые типы: Объект

Предоставляет возможность работы с сервером системы взаимодействия.

Сравнение ссылочное

Примеры

метод СозданиеПриложения()
    знч АдресСервера = ПолучитьАдресСервера()
    знч ПутьКФайлуХранилищаСертификата = ПолучитьПутьКФайлуХранилищаСертификата()
    знч ПарольХранилища = "ПарольХранилища"
    знч ПарольКлюча = "ПарольКлюча"
    знч Таймаут = 15с
    знч ПользовательИБ = Ууид(84eb3ebb-95ae-4dea-a025-adfa8961703c)
    знч ИмяПользователя = "Иван"
    знч ПолноеИмяПользователя = "Иванов Иван"
    знч КодАктивации = "123456"
    знч ПочтовыйАдрес = "ivanov@1c.ru"
    знч ИмяПриложения = "myApp"
     
    // 1. Подключение
    СистемаВзаимодействия.Подключиться(АдресСервера, ПутьКФайлуХранилищаСертификата, ПарольХранилища, ПарольКлюча, Таймаут)
     
    // 2.1. Подготовить ключи шифрования
    знч Ключи = новый КлючиПриложения()
     
    // 2.2. Создание приложения
    знч ПараметрыПриложенияСВ = СистемаВзаимодействия.СоздатьПриложение(Ключи, ПользовательИБ, ИмяПользователя, ПолноеИмяПользователя, КодАктивации, ПочтовыйАдрес, ИмяПриложения)
     
    // Ответ от сервера системы взаимодействия (нужно сохранить для последующего использования - подключения пользователей)
    знч ИдентификаторПрилСВ = ПараметрыПриложенияСВ.ИдентификаторПриложения
    знч ОткрытыйКлючПрилСВ = ПараметрыПриложенияСВ.ОткрытыйКлюч
    СистемаВзаимодействия.Отключиться()
     
    // 3. Вход в приложение
    СистемаВзаимодействия.Подключиться(АдресСервера, ПутьКФайлуХранилищаСертификата, ПарольХранилища, ПарольКлюча, Таймаут)
    знч ИдПользователяСВ = СистемаВзаимодействия.Войти(Ключи, ПользовательИБ, ИмяПользователя, ПолноеИмяПользователя, ПараметрыПриложенияСВ)
     
    // 4. Работа с системой взаимодействия
    //
    // ... действия с системой взаимодействия ...
    //
     
    // 5. Отключение
    СистемаВзаимодействия.Отключиться()
;

Методы

Войти(КлючиПриложения: КлючиПриложения, ИдПользователяПриложения: Ууид, ИмяПользователяПриложения: Строка, ПолноеИмяПользователяПриложения: Строка, ПараметрыПриложения: ПараметрыПриложения, ПривилегированныйРежим: Булево = Ложь, Таймаут: Длительность = 15с): Ууид

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

ИдПользователяПриложения - Идентификатор пользователя приложения. ИмяПользователяПриложения - Краткое имя пользователя приложения. ПолноеИмяПользователяПриложения - Полное имя пользователя приложения. ПараметрыПриложения - Специальный объект, в котором содержатся параметры приложения системы взаимодействия. ПривилегированныйРежим - Признак того, что вход должен быть выполнен в привилегированном (Истина) или обычном (Ложь) режиме. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ЗапроситьКодАктивации

ЗапроситьКодАктивации(Ид: Строка, Таймаут: Длительность = 15с): Булево

Запросить код активации приложения. Код будет отправлен на указанный адрес электронной почты. Возвращает Истина, если код был отправлен удачно, иначе - Ложь.

Ид - Адрес электронной почты, на который будет отправлено письмо с кодом активации. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ОбновитьПриложение

ОбновитьПриложение(ИдПриложения: Ууид, КлючиПриложения: КлючиПриложения, ИдПользователяПриложения: Ууид, ИмяПользователяПриложения: Строка, ПолноеИмяПользователяПриложения: Строка, КодАктивации: Строка, АдресЭлектроннойПочты: Строка, ИмяПриложения: Строка, Таймаут: Длительность = 15с): ПараметрыПриложения

Обновляет параметры приложения на сервере системы взаимодействия. Возвращает параметры обновленного приложения.

ИдПриложения - Идентификатор приложения системы взаимодействия. КлючиПриложения - Объект, который хранит открытый и закрытый ключ приложения. ИдПользователяПриложения - Идентификатор пользователя приложения. ИмяПользователяПриложения - Краткое имя пользователя приложения. ПолноеИмяПользователяПриложения - Полное имя пользователя приложения. КодАктивации - Код для активации приложения, полученный от сервера системы взаимодействия. АдресЭлектроннойПочты - Строка с адресом электронной почты пользователя, указанный при регистрации приложения. ИмяПриложения - Имя приложения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Отключиться

Отключиться()

Отключает приложение от сервера системы взаимодействия.

Подключиться

Подключиться(АдресСервера: Строка = “wss://1cdialog.com:443?transport=websocket&version=2”, ПараметрыСоединения: ПараметрыЗащищенногоСоединения, Таймаут: Длительность = 15с)

Перегрузка:
Подключиться(АдресСервера: Строка = “wss://1cdialog.com:443?transport=websocket&version=2”, ФайлХранилища: Строка = “”, ПарольХранилища: Строка = “”, ПарольКлюча: Строка = “”, Таймаут: Длительность = 15с)

Подключает приложение к серверу системы взаимодействия.

АдресСервера - Строка с адресом сервера системы взаимодействия, к которому выполняется подключение. Parameters - Параметры защищенного соединения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Подключиться

Подключиться(АдресСервера: Строка = “wss://1cdialog.com:443?transport=websocket&version=2”, ФайлХранилища: Строка = “”, ПарольХранилища: Строка = “”, ПарольКлюча: Строка = “”, Таймаут: Длительность = 15с)

Перегрузка:
Подключиться(АдресСервера: Строка = “wss://1cdialog.com:443?transport=websocket&version=2”, ПараметрыСоединения: ПараметрыЗащищенногоСоединения, Таймаут: Длительность = 15с)

Подключает приложение к серверу системы взаимодействия.

АдресСервера - Строка с адресом сервера системы взаимодействия, к которому выполняется подключение. ФайлХранилища - Путь к файлу, содержащему сертификат сервера системы взаимодействия. ПарольХранилища - Пароль для доступа к файлу-хранилищу. ПарольКлюча -Пароль для доступа к сертификату системы взаимодействия. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПодключитьсяБезПроверкиСертификата

ПодключитьсяБезПроверкиСертификата(АдресСервера: Строка = “wss://1cdialog.com:443?transport=websocket&version=2”, Таймаут: Длительность = 15с)

Подключает приложение к серверу системы взаимодействия. Проверка сертификата при подключении не выполняется.

АдресСервера - Строка с адресом сервера системы взаимодействия, к которому выполняется подключение. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьНепрочитанныеОбсуждения

ПолучитьНепрочитанныеОбсуждения(Видимые: Булево? = Неопределено, ЛимитОбсуждений: Число = 100, Таймаут: Длительность = 15с): Массив<Ууид>

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

Видимые - Признак для фильтрации по свойству Видимость. ЛимитОбсуждений - Ограничение количества обсуждений, которое может вернуть метод (максимальное значение равно 100). Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьНепрочитанныеСообщения

ПолучитьНепрочитанныеСообщения(ИдОбсуждения: Ууид, ЛимитСообщений: Число = 100, Таймаут: Длительность = 15с): Массив<Сообщение>

Возвращает массив непрочитанных сообщений обсуждения.

ИдОбсуждения - Идентификатор обсуждения. ЛимитСообщений - Ограничение количества сообщений, которое может вернуть метод (максимальное значение равно 100). Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьОбсуждение

ПолучитьОбсуждение(ИдОбсуждения: Строка|Ууид, Таймаут: Длительность = 15с): Обсуждение?

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

ПолучитьОбсуждения

ПолучитьОбсуждения(ИдОбсуждений: ЧитаемыйМассив<Ууид>, Таймаут: Длительность = 15с): Массив<Обсуждение>

Возвращает обсуждения, соответствующие указанным идентификаторам ИдОбсуждений.

Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьСообщение

ПолучитьСообщение(ИдСообщения: Ууид, Таймаут: Длительность = 15с): Сообщение?

Возвращает сообщение системы взаимодействия по его идентификатору. Если сообщение не найдено, будет возвращено Неопределено.

ИдСообщения - Идентификатор сообщения, которое нужно получить. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьСообщения

ПолучитьСообщения(ИдОбсуждения: Ууид, ЛимитСообщений: Число = 100, НачальноеСообщение: Ууид? = Неопределено, Таймаут: Длительность = 15с): Массив<Сообщение>

Возвращает массив сообщений обсуждения. Сообщения возвращаются в порядке от новых к старым.

ИдОбсуждения - Идентификатор обсуждения. ЛимитСообщений - Ограничение количества сообщений, которое может вернуть метод (максимальное значение равно 100). НачальноеСообщение - Сообщения, после которого будут получены сообщения обсуждения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

РедактироватьОбсуждение

РедактироватьОбсуждение(ИдОбсуждения: Ууид, Участники: ЧитаемыйМассив<Ууид>, Название: Строка, Таймаут: Длительность = 15с)

Изменяет обсуждение.

ИдОбсуждения - Идентификатор обсуждения. Участники - Идентификаторы участников обсуждения. Название - Название обсуждения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

РедактироватьСообщение

РедактироватьСообщение(ИдСообщения: Ууид, Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено, ТекстСообщения: Строка? = Неопределено, Данные: Строка? = Неопределено, ТипДанных: Строка? = Неопределено, Таймаут: Длительность = 15с): Сообщение

Отредактировать существующее сообщение.

ИдСообщения - Идентификатор сообщения, которое нужно отредактировать. Получатели - Получатели сообщения. ТекстСообщения - Текст сообщения. Данные - Данные сообщения. ТипДанных - Тип данных сообщения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Исключения:

ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует.
ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.

Особенности:

При редактировании ТипДанных в сообщение это поле не изменится, если не был изменен Данные.
Если какое то из параметров Получатели, ТекстСообщения, Данные или ТипДанных равно Неопределено, то это значение в сообщении не будет изменено.

СоздатьЛичноеОбсуждение

СоздатьЛичноеОбсуждение(Участник: Ууид, ВторойУчастник: Ууид? = Неопределено, Таймаут: Длительность = 15с): Ууид

Создает и возвращает идентификатор обсуждения между двумя участниками. Обсуждение этого типа может быть только одно на приложение.

Участник - Идентификатор участника. ВторойУчастник - Идентификатор второго участника. Если не указано, то будет использован идентификатор текущего пользователя. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

СоздатьОбсуждение

СоздатьОбсуждение(Участники: ЧитаемыйМассив<Ууид>, Название: Строка, Ключ: Строка = “”, Видимость: Булево = Истина, Таймаут: Длительность = 15с): Ууид

Создает и возвращает идентификатор группового обсуждения.

Участники - Идентификаторы участников обсуждения. Название - Название обсуждения. Ключ - Ключ обсуждения. Видимость - Признак видимости обсуждения для интерактивной работы Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

СоздатьПриложение

СоздатьПриложение(КлючиПриложения: КлючиПриложения, ИдПользователяПриложения: Ууид, ИмяПользователяПриложения: Строка, ПолноеИмяПользователяПриложения: Строка, КодАктивации: Строка, АдресЭлектроннойПочты: Строка, ИмяПриложения: Строка, Таймаут: Длительность = 15с): ПараметрыПриложения

Создает приложение в системе взаимодействия. Метод вызывается однократно. После успешного создания приложения оно всегда существует в системе взаимодействия. Возвращает параметры созданного приложения.

КлючиПриложения - Объект, который содержит открытый и закрытый ключи приложения. ИдПользователяПриложения -Идентификатор пользователя приложения. ИмяПользователяПриложения - Краткое имя пользователя приложения. ПолноеИмяПользователяПриложения - Полное имя пользователя приложения. КодАктивации - Код для регистрации приложения, полученный от сервера системы взаимодействия. АдресЭлектроннойПочты - Адрес электронной почты пользователя, создающего приложение. ИмяПриложения - Имя приложения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

СоздатьСообщение

СоздатьСообщение(ИдОбсуждения: Ууид, Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено, ТекстСообщения: Строка = “”, Данные: Строка = “”, ТипДанных: Строка = “”, Таймаут: Длительность = 15с): Ууид

Создает и возвращает идентификатор сообщения в системе взаимодействия.

ИдОбсуждения - Идентификатор обсуждения. Получатели - Идентификаторы получателей сообщения в системе взаимодействия. ТекстСообщения - Текст сообщения. Данные - Сериализованные в строку данные, которые дополнительно передаются в сообщении. ТипДанных - Тип данных, которые дополнительно передаются в сообщении. Например, “1c-application/json.old”. Длина ограничена 255 символами. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Данные и ТипДанных обрабатывает получатель сообщения.

УдалитьСообщение

УдалитьСообщение(ИдСообщения: Ууид, Таймаут: Длительность = 15с)

Удаляет сообщение системы взаимодействия по его идентификатору.

ИдСообщения - Идентификатор сообщения, которое нужно удалить. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Исключения:

ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует.
ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.

УстановитьПоследнееПрочитанноеСообщение

УстановитьПоследнееПрочитанноеСообщение(ИдОбсуждения: Ууид, ИдСообщения: Ууид, Таймаут: Длительность = 15с)

Устанавливает последнее прочитанное сообщение в обсуждении.

ИдОбсуждения - Идентификатор обсуждения. ИдСообщения - Идентификатор сообщения. Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.