Перейти к содержанию

Справочник по Webim Mobile SDK для iOS-приложений

Редакция соответствует версии 3.36.0.

класс Webim

Набор статических методов, которые используются при создании объекта сессии и для работы в push-уведомлениями, поступающими от сервиса Webim

метод класса newFAQBuilder()

Метод, необходимый для получения объекта FAQBuilder, который в свою очередь необходим для создания экземпляра класса FAQ.

метод класса newSessionBuilder()

Метод, необходимый для получения объекта SessionBuilder, который в свою очередь необходим для создания экземпляра класса WebimSession

метод класса parse(remoteNotification:visitorId:)

Метод, используемый для конвертирования объекта, представляющего push-уведомление в iOS-приложение, в объект класса WebimRemoteNotification.

Параметр remoteNotification — словарь типа [AnyHashable: Any] (такой же тип словаря передается в метод application(_:didReceiveRemoteNotification:) в параметр userInfo в классе AppDelegate iOS-приложения). В параметр необходимо передать значение параметра userInfo, упомянутого выше метода класса AppDelegate в не измененном виде.

Возвращает объект класса WebimRemoteNotification или nil, если значение параметра remoteNotification не соответствует формату push-уведомления, получаемого от сервиса Webim, или уведомление не содержит полезной нагрузки.

В качестве предварительной проверки, является ли параметр remoteNotification push-уведомлением, полученным от сервиса Webim, может быть вызван метод isWebim(remoteNotification:).

метод класса isWebim(remoteNotification:)

Метод, позволяющий узнать, является ли объект, представляющий push-уведомление в iOS-приложении, push-уведомлением, полученным от сервиса Webim.

Параметр remoteNotification — словарь типа [AnyHashable: Any] (такой же тип словаря передается в метод application(_:didReceiveRemoteNotification:) в параметр userInfo в классе AppDelegate iOS-приложения). В параметр необходимо передать значение параметра userInfo, упомянутого выше метода класса AppDelegate в не измененном виде.

Возвращает булево значение: true — если значение параметра remoteNotification является полученным push-уведомлением от сервиса Webimfalse — если не является.


перечисляемый тип RemoteNotificationSystem

Системы push-уведомлений, которые могут быть переданы в качестве параметра метода экземпляра SessionBuilderset(remoteNotificationSystem:).

случай APNS

Соответствует Apple Push Notification System.

случай NONE

Соответствует ситуации, когда приложению не требуется получать push-уведомления от сервиса Webim.


класс FAQBuilder

Класс, экземпляр которого используется для получения экземпляра класса FAQ. Экземпляр класса получается методом newFAQBuilder() класса Webim.

метод экземпляра set(accountName:)

Метод необходим для задания названия аккаунта в системе Webim при создании блока часто задаваемых вопросов.

Параметр accountName — название аккаунта клиента в системе Webim. Обычно представляет из себя URL -сервера (например, https://demo.webim.ru), но может иметь и вид названия аккаунта одним словом (например, demo), если сервер находится в домене webim.ru.

Возвращает тот же экземпляр класса FAQBuilder, но с установленным названием аккаунта. Для получения экземпляра FAQ вызов метода является обязательным.

метод экземпляра set(application:)

Метод необходим для задания названия приложения в системе Webim при создании блока часто задаваемых вопросов.

Параметр application — название приложения клиента в системе Webim.

Возвращает тот же экземпляр класса FAQBuilder, но с установленным названием аккаунта.

метод экземпляра set(departmentKey:)

Метод необходим для задания ключа отдела в системе Webim при создании блока часто задаваемых вопросов.

Параметр departmentKey — название приложения клиента в системе Webim.

Возвращает тот же экземпляр класса FAQBuilder, но с установленным названием аккаунта.

метод экземпляра set(language:)

Метод необходим для задания языка в системе Webim при создании блока часто задаваемых вопросов.

Параметр language — язык клиента в системе Webim.

Возвращает тот же экземпляр класса FAQBuilder, но с установленным названием аккаунта.

метод экземпляра build()

Метод, который вызывается в заключение перечисленных выше методов для получения экземпляра FAQ.

Возвращает объект FAQ с установленными параметрами с помощью остальных методов экземпляра класса.

Может выбрасывать ошибки типа FAQBuilderError.

Требует вызова метода set(accountName:).


класс SessionBuilder

Класс, экземпляр которого используется для получения экземпляра класса WebimSession. Экземпляр класса получается методом newSessionBuilder() класса Webim.

метод экземпляра set(prechat:)

Метод, с помощью которого можно установить поля с дополнительной информацией, которая будет видна оператору.

Параметр prechat — поля с дополнительной информацией в формате JSON. Тип параметра — String.

Возвращает тот же экземпляр класса SessionBuilder, но с установленными полями. Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(notFatalErrorHandler:)

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

Параметр notFatalErrorHandler — любой класс, реализующий интерфейс NotFatalErrorHandler.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным объектом NotFatalErrorHandler. Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(multivisitorSection:)

Метод, с помощью которого можно установить настройки для получения push-уведомлений от сервиса Webim при запуске нескольких сессий на одном устройстве.

Тип параметра multivisitorSectionString.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным полем.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(accountName:)

Метод необходим для задания названия аккаунта в системе Webim при создании сессии.

Параметр accountName — название аккаунта клиента в системе Webim. Обычно представляет из себя URL сервера (например, https://demo.webim.ru), но может иметь и вид названия аккаунта одним словом (например, demo), если сервер находится в домене webim.ru. Тип параметра — String.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным названием аккаунта.

Для получения экземпляра WebimSession вызов метода является обязательным.

метод экземпляра set(location:)

Метод необходим для задания изначально используемой локации при создании сессии.

Параметр location — локация внутри сервиса Webim, которая будет использоваться при чате. Тип параметра — String. Скорее всего, сразу же можно использовать значения mobile и/или default. Для создания и дальнейшего использования дополнительных локаций необходимо связаться со службой поддержки сервиса Webim.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным названием используемой локации.

Для получения экземпляра WebimSession вызов метода является обязательным.

метод экземпляра set(appVersion:)

Метод используется для задания версии клиентского приложения, если их необходимо различать в контексте сервиса Webim.

Параметр appVersion — версия клиентского приложения или nil. Тип параметра — опциональный String.

Возвращает тот же экземпляр класса SessionBuilder, но с установленной версией клиентского приложения, если параметр appVersion не nil, и не измененный экземпляр класса SessionBuilder, если параметр appVersion — nil.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(visitorFieldsJSONString:)

Метод используется для внутренней авторизации посетителя.

Без вызова этого метода при создании объекта сессии, пользователь будет анонимным, со случайным образом сгенерированным ID. Этот ID сохраняется в настройках приложения, и в случае потери этих настроек (например, при переустановке приложения), все данные (история сообщений) будут потеряны.

Все данные авторизованного пользователя сохраняются и будут доступны при авторизации с любого устройства.

Параметр jsonString — поля авторизационных данных пользователя в JSON-формате, тип — String. Подробную информацию об этих полях (включая, какие из них являются обязательными, и как необходимо их формировать) можно почерпнуть в этой статье.

Возвращает тот же экземпляр класса SessionBuilder, но с установленными авторизационными данными посетителя.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

Данный метод не может быть вызван одновременно с методом set(providedAuthorizationTokenStateListener:providedAuthorizationToken:).

метод экземпляра set(visitorFieldsJSONData jsonData:)

Метод, полностью аналогичный методу set(visitorFieldsJSONString:) за исключением параметра: параметр jsonData имеет тип Data (приведенный от JSON-формата). Какой из двух методов использовать не имеет значения.

метод экземпляра set(providedAuthorizationTokenStateListener:providedAuthorizationToken:)

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

Данный метод передает объект протокола ProvidedAuthorizationTokenStateListener и токен. Токен передавать не обязательно: если опустить второй параметр, токен будет сгенерирован библиотекой.

Возвращает тот же экземпляр класса SessionBuilder, но с установленными объектом ProvidedAuthorizationTokenStateListener и токеном клиентской системы авторизации посетителя.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

Данный метод не может быть вызван одновременно с методами set(visitorFieldsJSONString:) или set(visitorFieldsJSONData:).

метод экземпляра set(pageTitle:)

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

Параметр pageTitle — заголовок чата со стороны оператора. Тип параметра — String.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным заголовком чата со стороны оператора.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(fatalErrorHandler:)

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

Параметр fatalErrorHandler — опциональный; любой класс, подчиняющийся протоколу FatalErrorHandler, или nil, если методы протокола FatalErrorHandler в приложении использоваться не будут.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным объектом FatalErrorHandler.

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(remoteNotificationSystem:)

Метод, с помощью которого при создании сессии можно указать, будет ли приложение получать push-уведомления от сервиса Webim и, если будет, какую систему push-уведомлений приложение будет для этого использовать. (См. перечисляемый тип RemoteNotificationSystem в классе Webim.)

Параметр remoteNotificationSystem — соответствующее значение типа RemoteNotificationSystem класса Webim.

Требует предварительно полученного экземпляра класса SessionBuilder. В случае, если данный метод вызывается, и значение параметра remoteNotificationSystem отлично от NONE, при создании экземпляра сессии вызов метода set(deviceToken:) является обязательным.

Для получения экземпляра класса WebimSession вызов метода не является обязательным. Если при создании сессии метод вызван не был, сервис Webim не будет высылать приложению push-уведомления (аналогично, как при значении параметра remoteNotificationSystem NONE).

метод экземпляра set(deviceToken:)

Метод, с помощью которого при создании сессии можно указать токен устройства для получения приложением push-уведомлений от сервиса Webim.

Параметр deviceToken — токен устройства, использующийся для получения push-уведомлений в приложении. Тип — опциональный String в шестнадцатиричном формате, без служебных символов и пробелов.

Пример приведения значения токена устройства к нужному виду из значения в формате Data, получаемом методом application(_:,didRegisterForRemoteNotificationsWithDeviceToken:) класса AppDelegate приложения:

let deviceToken = deviceToken.map { String(format: «%02.2hhx», $0) }.joined()

Возвращает тот же экземпляр класса SessionBuilder, но с установленным значением токена устройства.

Для получения приложением push-уведомлений сервиса Webim, вызов данного метода не является достаточным: необходим также вызов метода set(remoteNotificationSystem:).

Для получения экземпляра класса WebimSession вызов метода не является обязательным.

метод экземпляра set(isLocalHistoryStoragingEnabled:)

По умолчанию сессия сохраняет на устройстве историю сообщений (в SQLite-хранилище, связанном с приложением). Если для каких-либо целей необходимо отключить данный функционал, используется этот метод со значением параметра isLocalHistoryStoragingEnabled false.

Параметр isLocalHistoryStoragingEnabled — булева переменная, означающая необходимость хранения истории сообщений локально (значение true) или ее (необходимости) отсутствие (значение false).

Возвращает тот же экземпляр класса SessionBuilder, но с установленным вручную значением соответствующей опции.

Для получения экземпляра класса WebimSession вызов метода не является обязательным. Отсутствие вызова метода аналогично его вызову со значением параметра isLocalHistoryStoragingEnabled true.

метод экземпляра set(isVisitorDataClearingEnabled:)

Метод, используемый для удаления всех существующих пользовательских данных во время создания экземпляра сессии.

Параметр isVisitorDataClearingEnabled — булева переменная, означающая необходимость очистить пользовательские данные (значение true) или ее (необходимости) отсутствие (значение false).

Возвращает тот же экземпляр класса SessionBuilder, но с установленным вручную значением соответствующей опции.

Для получения экземпляра класса WebimSession вызов метода не является обязательным. Отсутствие вызова метода аналогично его вызову со значением параметра isVisitorDataClearingEnabled false.

Для получения экземпляра класса WebimSession вызов метода не является обязательным

метод экземпляра set(webimLogger:verbosityLevel:)

Метод, с помощью которого передается объект WebimLogger.

Параметр verbosityLevel — значение WebimLoggerVerbosityLevel (может быть опущен).

метод экземпляра build()

Метод, который вызывается в заключение перечисленных выше методов для получения экземпляра WebimSession.

Возвращает объект WebimSession с установленными параметрами с помощью остальных методов экземпляра класса.

Может выбрасывать ошибки типа SessionBuilderError.

Требует вызова методов set(accountName:) и set(location:) (в любом порядке). Также предварительно могут быть вызваны и любые другие (в любом порядке и сочетании) методы экземпляра класса SessionBuilder.

метод класса set(multivisitorSection:)

Метод используется для получения уведомлений для разных посетителей на одном устройстве.

Параметр multivisitorSectionString.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным вручную значением соответствующей опции.

метод класса set(onlineStatusRequestFrequencyInMillis:)

Метод, с помощью которого можно указать частоту запросов к серверу в миллисекундах.

Параметр onlineStatusRequestFrequencyInMillisInt64.

Возвращает тот же экземпляр класса SessionBuilder, но с установленным вручную значением соответствующей опции.


перечисляемый тип FAQAccessError

Значение типа соответствуют ошибкам, которые могут выбрасываться некоторыми методами протоколов FAQ.

случай invalidThread

Возникает, когда метод был вызван не из потока, в котором был создан экземпляр блока часто задаваемых вопросов.

случай invalidFaq

Возникает при попытке использования методов недействительного экземпляра FAQ (например, после того, как на нем был вызван метод destroy()).


перечисляемый тип FAQBuilderError

Значение типа соответствуют возможным ошибкам, которые могут возникнуть при вызове метода build() класса FAQBuilder.

случай nilAccountName

Возникает, когда при создании блока часто задаваемых вопросов не было передано значение названия аккаунта.


перечисляемый тип FAQGetCompletionHandlerError

Возможные ошибки, которые могут выбрасывать методы протокола FAQ.

случай ERROR

Возникшая ошибка.


перечисляемый тип FileState

Используется для определения состояния файла.

случай error

Возникает, когда при загрузке файла произошла ошибка.

случай ready

Возникает, файл загружен.

случай upload

Возникает, файл загружается.

случай externalChecks

Файл проверяется сервером.


перечисляемый тип ReactionError

Возможные ошибки, которые могут быть переданы в параметр метода onFailure(error:) протокола ReactionCompletionHandler.

случай notAllowed

На сервере отключены реакции.

случай messageNotOwned

Пользователь может оставлять реакции только на сообщения оператора.

случай messageNotFound

Сообщение не найдено.

случай unknown

Неизвестная ошибка.


перечисляемый тип EditMessageError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода EditMessageCompletionHandler.onFailure(messageID:error:).

случай UNKNOWN

Неизвестная ошибка.

случай NOT_ALLOWED

На сервере отключена возможность редактирования сообщений.

случай MESSAGE_EMPTY

Редактируемое сообщение пустое.

случай MESSAGE_NOT_OWNED

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

случай MAX_LENGTH_EXCEEDED

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

случай WRONG_MESSAGE_KIND

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


перечисляемый тип RootType

Возможные типы корня дерева блока часто задаваемых вопросов (см. метод getType() протокола FAQStructure).

случай item

Корень дерева является страницей.

случай category

Корень дерева является категорией.

случай unknown

Корень дерева имеет неизвестный тип для данной версии SDK.


перечисляемый тип UserRate

Страница может быть отмечена пользователем.

случай like

Пользователю понравилась страница.

случай dislike

Пользователю не понравилась страница.

случай noRate

Страница не оценена пользователем.


перечисляемый тип FAQItemSource

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

Статью запрашивают из поиска.

случай tree

Статью запрашивают из структуры или категории.


перечисляемый тип WebimLoggerVerbosityLevel

Определяет степень информативности передаваемых в объект WebimLogger записей.

случай VERBOSE

Вся доступная информация будет передана объекту WebimLogger с максимальным уровнем информативности:

  • параметры настройки сетевых соединений;

  • URL, HTTP-методы и параметры сетевых запросов;

  • HTTP-коды, полученные данные и ошибки ответов на сетевые запросы;

  • SQL-запросы и ошибки, возникающие при этих запросах;

  • полная информация, которая может быть полезна при дебаггинге, и дополнительные заметки.

случай DEBUG

Вся необходимая для дебаггинга информация будет передана объекту WebimLogger с необходимым уровнем информативности:

  • параметры настройки сетевых соединений;

  • URL, HTTP-методы и параметры сетевых запросов;

  • HTTP-коды, полученные данные и ошибки ответов на сетевые запросы;

  • SQL-запросы и ошибки, возникающие при этих запросах;

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

случай INFO

Объекту WebimLogger будет передана справочная информация, а также все предупреждения и ошибки:

  • URL, HTTP-методы и параметры сетевых запросов;

  • HTTP-коды, полученные данные и ошибки ответов на сетевые запросы;

  • SQL-запросы и ошибки, возникающие при этих запросах.

случай WARNING

Объекту WebimLogger будут переданы только предупреждения и ошибки:

  • HTTP-коды, полученные данные и ошибки ответов на сетевые запросы;

  • SQL-запросы и ошибки, возникающие при этих запросах.

случай ERROR

Объекту WebimLogger будут переданы только ошибки:

  • HTTP-коды и ошибки ответов на сетевые запросы, которые не закончились успехом.

перечисляемый тип SessionBuilderError

Значение типа соответствуют возможным ошибкам, которые могут возникнуть при вызове метода build() класса SessionBuilder.

случай NIL_ACCOUNT_NAME

Возникает, когда при создании сессии не было передано значение названия аккаунта (или это значение nil).

случай NIL_LOCATION

Возникает, когда при создании сессии не было передано значение названия локации (или это значение nil).

случай INVALID_AUTHENTICATION_PARAMETERS

Возникает, когда при создании сессии была произведена попытка использовать одновременно стандартную (см. методы set(visitorFieldsJSONString:) и set(visitorFieldsJSONData:)) и собственную (см. метод set(providedAuthorizationTokenStateListener:providedAuthorizationToken:)) системы авторизации посетителя.

случай INVALIDE_HEX

Возникает, когда передается недействительная строка в HEX-формате.

случай INVALID_REMOTE_NOTIFICATION_CONFIGURATION

Возникает, когда при создании сессии возникла неверная конфигурация push-сервиса (был задан сервис для использования при получении push-уведомлений от сервиса Webim, отличный от NONE (см. метод set(remoteNotificationSystem:) класса SessionBuilder, но не было передано значение токена устройства (или значение nil) — см. метод set(deviceToken:) класса SessionBuilder).

случай UNKNOWN

Неизвестная ошибка.


перечисляемый тип AttachmentState

Используется для определения состояния загрузки файла на сервер (см. метод getState() протокола MessageAttachment).

случай error

Во время загрузки файла на сервер произошла ошибка. При этом метод getErrorType() протокола MessageAttachment будет содержать тип ошибки, а getErrorMessage() текст.

случай ready

Файл доступен для загрузки.

случай upload

Файл загружается на сервер.

случай externalChecks

Файл проверяется сервером.


Перечисляемый тип ButtonState

Используется для определения состояния кнопки.

случай showing

Кнопка отображается.

случай showingSelected

Кнопка выбрана.

случай hidden

Кнопка скрыта.


Перечисляемый тип ButtonType

Используется для определения типа кнопки.

случай URL

Кнопка содержит ссылку, по которой перебросит посетителя при нажатии на кнопку.

случай insert

Кнопка содержит текст, который отправится от лица посетителя при нажатии на кнопку.


протокол Configuration

Протокол является абстракцией, представляющей информацию о конфигурации кнопок клавиатуры чат-бота.

метод isActive()

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

Возвращает true, если активна, и false, если нет. Тип — Bool.

метод getButtonType()

Метод, с помощью которого может быть получена информация о типе кнопки.

Возвращает тип кнопки. Тип — ButtonType.

метод getData()

Метод, с помощью которого может быть получена информация о кнопке.

Возвращает информацию о кнопке. Тип — String.

метод getState()

Метод, с помощью которого может быть получена информация состоянии кнопки.

Возвращает информацию о состоянии кнопки. Тип - ButtonState.


протокол FAQ

Протокол, позволяющий производить манипуляции с текущим списком часто задаваемых вопросов. Экземпляр класса FAQ получается с помощью методов класса FAQBuilder.

метод экземпляра resume()

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

Может выбрасывать ошибки типа FAQAccessError. Необходим для полноценного функционирования сервиса в контексте приложения.

метод экземпляра pause()

Метод, который используется для приостановки сетевой активности. Если список часто задаваемых вопросов уже находится в приостановленном состоянии, метод не производит никаких действий.

Может выбрасывать ошибки типа FAQAccessError. Для вызова метода список часто задаваемых вопросов не должен находиться в деактивированном состоянии.

метод экземпляра destroy()

Метод, который используется для деактивации списка часто задаваемых вопросов и экземпляра класса. После вызова данного метода, никакие методы использованы быть не могут.

Может выбрасывать ошибки типа FAQAccessError.

метод экземпляра getCategory(id:completionHandler:)

Метод, который используется для получения объекта класса FAQCategory через completionHandler.

Параметр id — ID категории блока часто задаваемых вопросов. Тип — String.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQCategory, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра getCategoriesForApplication(completionHandler:)

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

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает массив идентификаторов категорий типа String, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра getCachedCategory(id:completionHandler:)

Метод, который используется для получения объекта класса FAQCategory через completionHandler из сохранённого кэша.

Параметр id — ID категории блока часто задаваемых вопросов. Тип — String.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQCategory, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра getItem(id:openFrom:completionHandler:)

Метод, который используется для получения объекта класса FAQItem через completionHandler.

Параметр id — ID страницы блока часто задаваемых вопросов. Тип — String.

Параметр openFrom — запрос статьи из определённого источника. Тип — опциональный FAQItemSource.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQItem, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра getCachedItem(id:openFrom:completionHandler:)

Метод, который используется для получения объекта класса FAQItem через completionHandler из кэша.

Параметр id — ID страницы блока часто задаваемых вопросов. Тип — String.

Параметр openFrom — запрос статьи из определённого источника. Тип — опциональный FAQItemSource.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQItem, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра funcgetStructure(id:completionHandler:)

Метод, который используется для получения объекта класса FAQStructure() через completionHandler.

Параметр id — ID вершины, которая будет корнем дерева (структуры) блока часто задаваемых вопросов. Тип — String.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQStructure(), при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра getCachedStructure(id:completionHandler:)

Метод, который используется для получения объекта класса FAQStructure() через completionHandler из кэша.

Параметр id — ID вершины, которая будет корнем дерева (структуры) блока часто задаваемых вопросов. Тип — String.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQStructure(), при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра func like(item:completionHandler:)

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

Параметр item — страница, которой необходимо поставить оценку. Тип — FAQItem.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQItem, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра dislike(item:completionHandler:)

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

Важно: для правильной работы метода требуется вызов метод resume().

Параметр item — страница, которой необходимо поставить оценку. Тип — FAQItem.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQItem, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().

метод экземпляра search(query:category:limitOfItems:completionHandler:)

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

Параметр query — запрос, по которому осуществляется поиск. Тип — String.

Параметр category — ID категории, в которой осуществляется поиск. Тип — String.

Параметр limitOfItems — число, не больше которого нужно вернуть статей.

Параметр completionHandler — замыкание, которое выполняется после завершения выполнения метода. При успешном завершении работы метода замыкание принимает один параметр типа FAQSearchItem, при неуспешном — параметр типа FAQGetCompletionHandlerError, и не имеет возвращаемого типа.

Для правильной работы метода требуется вызов метода resume().


протокол FAQCategory

Представление категории блока часто задаваемых вопросов. Предоставляет методы получения информации о категории.Объекты FAQCategory могут быть получены с помощью completionHandler в методах getCategory(id:completion:) и getCachedCategory(id:completionHandler:).

метод экземпляра getID()

Возвращает идентификатор категории. Тип — String.

метод экземпляра getTitle()

Возвращает заголовок категории. Тип — String.

метод экземпляра getItems()

Категория содержит страницы блока часто задаваемых вопросов.

Возвращает страницы, принадлежащих категории. Тип — FAQItem.

метод экземпляра getSubcategories()

Категория содержит подкатегории. Для удобства данный метод возвращает информацию о подкатегориях без её страниц и подкатегорий.

Возвращает информацию о подкатегориях, принадлежащих категории. Тип — FAQCategoryInfo.


протокол FAQItem

Представление страницы блока часто задаваемых вопросов. Предоставляет методы получения информации о странице. Объекты FAQItem могут быть получены с completionHandler функции getItem(id:completionHandler:).

метод экземпляра getId()

Возвращает идентификатор страницы. Тип — String.

метод экземпляра getTitle()

Возвращает заголовок страницы. Тип — String.

метод экземпляра getCategories()

Страница может принадлежать нескольким категориям.

Возвращает идентификаторы категорий, которым принадлежит страница. Тип — String.

метод экземпляра getTags()

У страницы есть набор тэгов.

Возвращает список тэгов, которыми отмечена страница. Тип — String.

метод экземпляра getContent()

Возвращает содержание страницы. Тип — String.

метод экземпляра getLikeCount()

Страница содержит количество отметок «Нравится».

Возвращает количество отметок «Нравится» страницы. Тип — Int.

метод экземпляра getDislikeCount()

Страница содержит количество отметок «Не нравится».

Возвращает количество отметок «Не нравится» страницы. Тип — Int.

метод экземпляра getUserRate()

Страница может быть отмечена пользователем.

Возвращает оценку пользователя. Тип — UserRate.


протокол FAQCategoryInfo

Представление информации о категории блока часто задаваемых вопросов. Предоставляет методы получения идентификатора и заголовка категории. Объекты FAQCategoryInfo могут быть получены с помощью метода getSubcategories().

метод экземпляра getID()

Возвращает идентификатор категории. Тип — String.

метод экземпляра getTitle()

Возвращает заголовок категории. Тип — String.


протокол FAQSearchItem

Краткая информация о страницах, полученных в результате поиска по ключевому слову.

метод экземпляра getID()

Возвращает идентификатор страницы. Тип — String.

метод экземпляра getTitle()

Возвращает заголовок страницы. Тип — String.

метод экземпляра getScore()

У страницы есть оценка поиска. Чем больше оценка, тем больше страница подходит под поисковой запрос. Возвращает оценку поиска. Тип — Double.


протокол FAQStructure

Представление дерева (структуры) блока часто задаваемых вопросов. Предоставляет методы получения информации о дереве блока часто задаваемых вопросов.

Объекты FAQStructure могут быть получены с помощью completionHandler метода getStructure(id:completionHandler:).

метод экземпляра getID()

У дерева есть корневой элемент.

Возвращает идентификатор корневого элемента дерева. Тип — String.

метод экземпляра getTitle()

Возвращает заголовок корня. Тип — String.

метод экземпляра getType()

Корень дерева может быть категорией или страницей.

Возвращает тип корневого элемента. Тип — RootType.

метод экземпляра getChildren()

Возвращает поддеревья, корнями которых являются прямые потомки корня дерева (структуры). Тип — FAQStructure.


протокол FileInfo

Содержит информацию о вложениях.

метод getContentType()

Метод, с помощью которого может быть получен MIME-тип вложения.

Возвращает MIME-тип вложения в текстовом виде или nil. Тип — опциональный String.

метод getFileName()

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

Возвращает имя файла вложения в текстовом виде или nil. Тип — String.

метод getImageInfo()

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

Возвращает объект ImageInfo или nil, если вложенный файл не является изображением.

метод getSize()

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

Возвращает размер файла вложения в байтах или nil. Тип — опциональный Int64.

метод getURL()

Метод, с помощью которого может быть получена ссылка для скачивания файла вложения. Ссылка действительна только для текущей сессии.

Возвращает URL файла вложения или nil.

метод getGuid()

Метод, с помощью которого может быть получен guid файла вложения. Возвращает значение в текстовом виде. Тип — String.


протокол HelloMessageListener

Протокол является абстракцией, представляющей приветственное сообщение.

метод helloMessage(message:)

Метод вызывается при получении приветственного сообщения до получения сообщений в чате.

Параметр message — приветственное сообщение. Тип — String.


протокол Keyboard

Протокол является абстракцией, предоставляющей элементы клавиатуры чат-бота.

метод getButtons()

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

Возвращает список кнопок. Тип — KeyboardButton.

метод getState()

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

Возвращает состояние клавиатуры. Тип — KeyboardState.

метод getKeyboardResponse()

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

Возвращает кнопку, выбранную пользователем. Тип — опциональный KeyboardResponse.


протокол KeyboardButton

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

метод getId()

Метод, с помощью которого может быть получен уникальный ID кнопки в клавиатуре чат-бота.

Возвращает ID в текстовом виде. Тип — String. ID кнопки может содержать только латинские буквы, цифры, символы дефиса и нижнего подчёркивания и должен быть не более 24 символов в длину. ID кнопки, генерируемый на стороне Webim, имеет формат UUID4, а ID, генерируемый извне (в т.ч. сторонними ботами), только проверяется на соответствие данным выше критериям.

метод getText()

Метод, с помощью которого может быть получен текст кнопки в клавиатуре чат-бота.

Возвращает название кнопки в текстовом виде. Тип — String.

метод getConfiguration()

Метод, с помощью которого может быть получена конфигурация кнопки в клавиатуре чат-бота. Тип — опциональный Configuration.


протокол KeyboardRequest

Протокол является абстракцией, представляющей информацию о выбранной кнопке в клавиатуре чат-бота.

метод getButton()

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

Возвращает объект KeyboardButton.

метод getMessageId()

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

Возвращает название ID сообщения в текстовом виде. Тип — String.


протокол KeyboardResponse

Протокол является абстракцией, представляющей информацию о выбранной кнопке в клавиатуре чат-бота.

метод getButtonId()

Метод, с помощью которого может быть получен уникальный ID выбранной кнопки в клавиатуре чат-бота.

Возвращает ID в текстовом виде. Тип — String.

метод getMessageId()

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

Возвращает название ID сообщения в текстовом виде. Тип — String.


протокол NotFatalErrorHandler

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

метод on(error:)

Вызывается при возникновении некритической ошибки сервиса Webim.

Параметр error — ошибка сервиса Webim. Тип — WebimNotFatalError.

Внимание!

Данный метод вызывается не из главного потока!

метод connectionStateChanged(connected:)

Вызывается при возникновении ошибки соединения сервиса Webim.

Внимание!

Данный метод вызывается не из главного потока!


протокол Quote

Протокол является абстракцией, представляющей информацию о цитируемом сообщении.

метод getAuthorId()

С помощью этого метода можно получить ID автора цитируемого сообщения.

Возвращает ID сообщения. Тип — опциональный String.

метод getMessageAttachment()

С помощью этого метода можно получить вложение, если это файл, отправленный посетителем или оператором (FILE_FROM_OPERATOR или FILE_FROM_VISITOR).

Возвращает информацию о вложении. Тип — опциональный FileInfo.

метод getMessageTimestamp()

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

Возвращает количество миллисекунд, прошедших с начала эпохи до обработки сообщения сервером. Тип — опциональный Date.

метод getMessageId()

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

Возвращает ID сообщения. Тип — опциональный String.

метод getMessageText()

С помощью этого метода можно получить текст сообщения.

Возвращает текст сообщения. Тип — опциональный String.

метод getMessageType()

С помощью этого метода можно получить тип цитируемого сообщения.

Возвращает опциональное значение перечисляемого типа MessageType.

метод getSenderName()

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

Возвращает имя отправителя сообщения. Тип — опциональный String.

метод getState()

С помощью этого метода можно получить статус цитаты.

Возвращает значение перечисляемого типа QuoteState.


перечисляемый тип QuoteState

Используется для определения состояния цитируемого сообщения.

случай PENDING

Возникает, когда цитата загружается.

случай FILLED

Возникает, когда цитата загружена.

случай NOT_FOUND

Возникает, когда цитируемое сообщение не найдено на сервере.


перечисляемый тип NotFatalErrorType

Соответствует значениям возможных фатальных ошибок, которые могут возникать в работе сервиса Webim (см. метод getErrorType() интерфейса WebimNotFatalError).

случай NO_NETWORK_CONNECTION

Эта ошибка указывает на отсутствие сетевого подключения.

случай SERVER_IS_NOT_AVAILABLE

Эта ошибка возникает, когда сервер недоступен.


перечисляемый тип KeyboardResponseError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода KeyboardResponseCompletionHandler.onFailure(error:).

случай UNKNOWN

Неизвестная ошибка.

случай NO_CHAT

Кнопка из клавиатуры чат-бота отправлена не в тот чат.

случай BUTTON_ID_NOT_SET

Не установлен идентификатор кнопки.

случай REQUEST_MESSAGE_ID_NOT_SET

Не установлен идентификатор сообщения запроса.

случай CAN_NOT_CREATE_RESPONSE

Невозможно создать ответ.


перечисляемый тип KeyboardRequest

Используется для определения состояния цитируемого сообщения.

случай PENDING

Возникает, когда цитата загружается.

случай FILLED

Возникает, когда цитата загружена.

случай NOT_FOUND

Возникает, когда цитируемое сообщение не найдено на сервере.


перечисляемый тип KeyboardState

Используется для определения состояния цитируемого сообщения (см. метод getState() интерфейса Keyboard).

случай PENDING

Возникает, когда клавиатура активна и кнопки могут быть нажаты.

случай CANCELLED

Возникает, когда клавиатура неактивна и кнопки не могут быть нажаты.

случай COMPLETED

Возникает, когда клавиатура неактивна и выбрана одна из кнопок.


протокол EditMessageCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода edit(message:text:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Вызывается при успешном результате вызова метода edit(message:text:completionHandler:) протокола MessageStream.

Параметр messageID — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неуспешном результате вызова метода edit(message:text:completionHandler:) протокола MessageStream.

Параметр messageID — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешному редактированию сообщения. Тип — EditMessageError.


протокол ProvidedAuthorizationTokenStateListener

Если клиент предоставляет собственный механизм авторизации посетителя, это может быть реализовано с помощью передачи специального токена, который используется вместо посетительских полей (см. методы set(visitorFieldsJSONString:) и set(visitorFieldsJSONData:)). В момент генерации (или получения переданного значения) этого токена, вызывается метод update(providedAuthorizationToken:). Это означает, что сервис клиента должен передать данный токен в сервис Webim.

Данный механизм — это не самодостаточная реализация. Клиентский сервис должен поддерживать и реализовывать методы передачи токена и данных посетителя в сервис Webim.

метод экземпляра update(providedAuthorizationToken:)

Метод вызывается в двух случаях:

  1. Токен клиентского механизма авторизации передан или сгенерирован и требуется его отправка в сервис Webim силами клиента.

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


протокол WebimSession

Протокол, позволяющий производить манипуляции с текущей сессией. Экземпляр класса WebimSession получается с помощью методов класса SessionBuilder.

метод экземпляра resume()

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

Может выбрасывать ошибки типа AccessError.

Необходим для полноценного функционирования сервиса в контексте приложения.

В результате ответа сервера могут быть вызваны различные методы MessageListenerChatStateListenerCurrentOperatorChangeListener и LocationSettingsChangeListener.

метод экземпляра pause()

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

Может выбрасывать ошибки типа AccessError.

Для вызова метода сессия не должна находиться в деактивированном состоянии.

метод экземпляра destroy()

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

Может выбрасывать ошибки типа AccessError.

метод экземпляра getStream()

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

Для полноценного использования методов протокола MessageStream сессия не должна быть приостановлена или деактивирована (см. методы resume()pause() и destroy()).

метод экземпляра change(location:)

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

Параметр location — название локации, на которое необходимо сменить текущее значение сессии. Тип — String.

Может выбрасывать ошибки типа AccessError.

Для вызова метода сессия не должна находиться с приостановленном или деактивированном состоянии (см. методы resume()pause() и destroy()).

метод экземпляра set(deviceToken:)

Метод используется для установки токена устрйойства для получения push-уведомлений.

Параметр deviceToken — токен устройства, использующийся для получения push-уведомлений в приложении. Тип — опциональный String в шестнадцатиричном формате, без служебных символов и пробелов.

Пример приведения значения токена устройства к нужному виду из значения в формате Data, получаемом методом application(_:didRegisterForRemoteNotificationsWithDeviceToken:) класса AppDelegate приложения:

let deviceToken = deviceToken.map { String(format: «%02.2hhx», $0) }.joined()

Может выбрасывать ошибки типа AccessError.

Для вызова метода сессия не должна находиться с приостановленном или деактивированном состоянии (см. методы resume()pause() и destroy()).

метод destroyWithClearVisitorData()

Метод, который используется для деактивации сессии и экземпляра класса с удалением информации о пользователе. После вызова данного метода, никакие методы, относящиеся к сессии использованы быть не могут.

Может выбрасывать ошибки типа AccessError.


протокол MessageData

Содержит прикрепленный к сообщению файл.

метод getAttachment()

С помощью этого метода можно получить вложение, если это файл, отправленный посетителем или оператором (MessageType FILE_FROM_OPERATOR или FILE_FROM_VISITOR).

Возвращает экземпляр класса MessageAttachment или nil, если файл находится в процессе отправки.


протокол MessageStream

Экземпляр класса, с помощью которого вызываются методы протокола, в рамках сессии существует только один и получается с помощью метода getStream() экземпляра класса WebimSession. Методы протокола используются непосредственно для взаимодействия с сервисом Webim (таких как отправка и получение сообщений).Для использования методов протокола необходимо, чтобы сессия не находилась в приостановленном или деактивированном виде (см. методы resume()pause() и destroy() класса WebimSession).

метод rateOperatorWith(id:note:rating:completionHandler:)

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

Параметр id — ID оператора, оценку которого необходимо отправить сервису Webim. Тип — String. Опциональный: если передать nil, будет отправлена оценка текущему оператору чата (если есть).

Параметр note — комментарий к оценке оператора, который необходимо отправить сервису Webim. Максимальная длина 2000 символов. Тип — опциональный String.

Параметр rating— оценка оператора, которую необходимо отправить сервису Webim. Оценка должна быть целым числом от 1 до 5 (при указании иного, метод не произведет никаких действий). Тип — Int.

Параметр completionHandler — объект RateOperatorCompletionHandler.

Может выбрасывать ошибки типа AccessError.

Важно!

Реализация механизма оценки оператора в чате остаётся за разработчиками мобильного приложения!

метод startChat(customFields:)

Метод начинает чат с указанными дополнительными полями. В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

Параметр customFields — дополнительные поля в формате JSON. Тип — опциональный String.

В результате может быть вызван метод changed(state previousState:to newState:) протокола ChatStateListener.

метод startChat(firstQuestion:customFields:)

Метод начинает чат с указанными дополнительными полями и одновременно посылает первое сообщение посетителя.

В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

Если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

Параметр firstQuestion — первое сообщение пользователя. Тип — опциональный String.

Параметр customFields — дополнительные поля в формате JSON. Тип — опциональный String.

В результате может быть вызван метод changed(state previousState:to newState:) протокола ChatStateListener.

метод startChat(departmentKey:customFields:)

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

В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, но если текущее состояние VisitSessionState DEPARTMENT_SELECTION, чат необходимо начать именно с помощью данного метода.

В параметр departmentKey передается значение ключа отдела, которое может быть получено методом getKey() протокола Department.

Параметр customFields — дополнительные поля в формате JSON. Тип — опциональный String.

В результате может быть вызван метод changed(state previousState:to newState:) протокола ChatStateListener.

метод startChat(departmentKey:firstQuestion:customFields:)

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

В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, но если текущее состояние VisitSessionState DEPARTMENT_SELECTION, чат необходимо начать именно с помощью данного метода.

В параметр departmentkey передается значение ключа отдела, которое может быть получено методом getKey() протокола Department.

Если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

Параметр firstQuestion — первое сообщение пользователя. Тип — опциональный String.

Параметр customFields — дополнительные поля в формате JSON. Тип — опциональный String.

В результате может быть вызван метод changed(state previousState:to newState:) протокола ChatStateListener.

метод set(prechatFields:)

Отправляет дополнительные поля на сервер.

Может выбрасывать ошибки типа AccessError.

Параметр prechatFields — дополнительные поля. Тип — String.

метод send(message:completionHandler:)

Соответствует методу send(message:isHintQuestion:) с опущенным параметром isHintQuestion.

Параметр completionHandler — объект, реализующий методы протокола SendMessageCompletionHandler. Тип опциональный.

метод sendKeyboardRequest(button:message:completionHandler:)

Метод используется для отправки выбранного элемента в клавиатуре чат-бота в сервис Webim.

Может выбрасывать ошибки типа AccessError.

Параметр button — элемент в клавиатуре чат-бота. Тип — KeyboardButton.

Параметр message — сообщение. Тип — Message.

Параметр completionHandler — объект, реализующий методы протокола SendKeyboardRequestCompletionHandler. Тип опциональный.

метод sendKeyboardRequest(buttonID:messageCurrentChatID:completionHandler:)

Метод используется для отправки выбранного элемента в клавиатуре чат-бота в сервис Webim.

Может выбрасывать ошибки типа AccessError.

Параметр buttonID — ID элемента в клавиатуре чат-бота. Тип — String.

Параметр messageCurrentChatID — ID запрашиваемого сообщения. Тип — Message.

Параметр completionHandler — объект, реализующий методы протокола SendKeyboardRequestCompletionHandler. Тип опциональный.

метод updateWidgetStatus(data:)

Метод используется для обновления статуса виджета.

Может выбрасывать ошибки типа AccessError.

Параметр data — строка в формате JSONс новым статусом виджета. Тип — String.

метод reply(message:repliedMessage:)

Метод используется для цитирования сообщения посетителя в сервис Webim.

Может выбрасывать ошибки типа AccessError.

Параметр message — отправляемое сообщение. Тип — String.

Параметр repliedMessage — цитируемое сообщение. Тип — Message.

Возвращает ID сообщения или nil, если сообщение не может быть цитировано.

Не требует предварительного вызова никаких других методов. Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод added(message:after:) интерфейса MessageListener с новым сообщением со статусом MessageSendStatus.sent.

Максимальная длина сообщения 32000 символов. Сообщения длиннее будут обрезаться.

метод edit(message:text:completionHandler:)

Метод используется для изменения сообщения.

Может выбрасывать ошибки типа AccessError.

Параметр message — изменяемое сообщение. Тип — Message.

Параметр text — текст сообщения. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола EditMessageCompletionHandler. Тип опциональный.

Возвращает true, если сообщение можно редактировать.

Не требует предварительного вызова никаких других методов. Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод changed(oldVersion:newVersion:) интерфейса MessageListener с новым сообщением со статусом MessageSendStatus.sent.

Максимальная длина сообщения 32000 символов. Сообщения длиннее будут обрезаться.

метод delete(message:completionHandler:)

Метод для удаления сообщения.

Может выбрасывать ошибки типа AccessError.

Параметр message — удаляемое сообщение. Тип — Message.

Параметр completionHandler — объект, реализующий методы протокола DeleteMessageCompletionHandler. Тип опциональный.

Возвращает true, если сообщение может быть удалено.

Не требует предварительного вызова никаких других методов. Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод removed(message:) интерфейса MessageListener с новым сообщением со статусом MessageSendStatus.sent.

Максимальная длина сообщения 32000 символов. Сообщения длиннее будут обрезаться.

метод setChatRead()

Метод отправляет сигнал сервису Webim, что посетитель прочитал чат.

метод sendDialogTo(emailAddress:completionHandler:)

Метод используется для отправки текущего диалога на email адрес.

Может выбрасывать ошибки типа AccessError.

Параметр emailAddress — email для отправки. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола SendDialogToEmailAddressCompletionHandler. Тип опциональный.

метод send(surveyAnswer:completionHandler:)

С помощью этого метода можно отправить ответ на текущий вопрос, полученный с помощью метода SurveyListener.on(nextQuestion: SurveyQuestion).

Параметр surveyAnswer — ответ, для вопроса типа 'stars' — ответом будет являться целое число от 1 до 5, определяющее оценку оператора. Для вопроса типа 'radio' ответ — это индекс элемента в массиве options, начиная с 1. Для вопроса типа 'comment' ответ — это строчка, представляющая комментарий пользователя. Тип — String.

Может выбрасывать ошибки типа AccessError.

Параметр completionHandler — объект, реализующий методы протокола SendSurveyAnswerCompletionHandler. Тип опциональный.

метод closeSurvey(completionHandler:)

С помощью данного метода можно закрыть опрос.

Может выбрасывать ошибки типа AccessError.

Параметр completionHandler — объект, реализующий методы протокола SurveyCloseCompletionHandler. Тип опциональный.

метод set(surveyListener:)

С помощью этого метода можно установить объект SurveyListener.

Параметр surveyListener — объект, реализующий интерфейс SurveyListener.

метод set(helloMessageListener:)

С помощью этого метода можно установить приветственное сообщение.

Параметр helloMessageListener — объект, реализующий интерфейс HelloMessageListener.

метод getVisitSessionState()

Возвращает текущее состояние сессии значением типа VisitSessionState.

метод getChatState()

Метод с помощью, которого можно уточнить состояние текущего чата.

Возвращает значение перечислимого типа ChatState.

метод getUnreadByOperatorTimestamp()

Возвращает момент времени (типа Date), после которого все сообщения чата являются непрочитанными оператором (на момент полученного от сервера обновления).

метод getUnreadByVisitorMessageCount()

Возвращает количество непрочитанных сообщений пользователем.

метод getUnreadByVisitorTimestamp()

Возвращает момент времени (типа Date), после которого все сообщения чата являются непрочитанными посетителем (на момент полученного от сервера обновления) или nil, если непрочитанных сообщений нет.

метод getDepartmentList()

Возвращает список отделов массивом объектов типа Department или nil, если отделы не используются или список отделов пока не был получен.

метод getLocationSettings()

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

Возвращает объект класса LocationSettings, соответствующий текущей сессии.

метод getCurrentOperator()

С помощью этого метода можно уточнить информацию об актуальном операторе (если он есть) текущего чата.

Возвращает объект класса Operator или nil, если у чата в данный момент нет оператора.

метод getLastRatingOfOperatorWith(id:)

С помощью этого метода можно уточнить текущий рейтинг (в целых числах от 0 до 5) оператора, зная ID этого оператора (см. метод getID() протокола Operator).

Параметр id — ID оператора, рейтинг которого должен вернуть метод. Тип — String.

Возвращает рейтинг оператора с ID, соответствующему значению параметра id, в целых числах от 1 до 5 или 0, если рейтинг у оператора отсутствует.

метод rateOperatorWith(id:rating:completionHandler:)

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

Параметр id — ID оператора, оценку которого необходимо отправить сервису Webim. Тип — String. Опциональный: если передать nil, будет отправлена оценка текущему оператору чата (если есть).

Параметр rating — оценка оператора, которую необходимо отправить сервису Webim. Оценка должна быть целым числом от 1 до 5 (при указании иного, метод не произведет никаких действий). Тип — Int.

Параметр completionHandler — объект RateOperatorCompletionHandler.

Может выбрасывать ошибки типа AccessError.

Важно!

Реализация механизма оценки оператора остаётся за разработчиками мобильного приложения!

метод respondSentryCall(id:)

С помощью этого метода можно перевести чат на дежурного оператора.

Параметр id — ID сообщения о переводе на дежурного оператора. Тип — String.

Может выбрасывать ошибки типа AccessError.

метод startChat()

Метод начинает чат. В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, поэтому вызов метода не является обязательным. Но, если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

В результате может быть вызван метод changed(state previousState:to newState:)протокола ChatStateListener.

метод startChat(departmentKey:)

Метод начинает чат с указанием определенного отдела. В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, но если текущее состояние VisitSessionState DEPARTMENT_SELECTION, чат необходимо начать именно с помощью данного метода.

При отправке сообщения или файла пользователем, чат начинается автоматически, поэтому вызов метода не является обязательным.

Если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

В параметр departmentKey передается значение ключа отдела, которое может быть получено методом getKey() протокола Department.

В результате может быть вызван метод changed(state previousState:to newState:)протокола ChatStateListener.

метод startChat(firstQuestion:)

Метод начинает чат и одновременно посылает первое сообщение посетителя.

В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, поэтому вызов метода не является обязательным. Но, если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

В результате может быть вызван метод changed(state previousState:to newState:)протокола ChatStateListener.

метод startChat(departmentKey:firstQuestion:)

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

В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на QUEUE.

Может выбрасывать ошибки типа AccessError.

При отправке сообщения или файла пользователем, чат начинается автоматически, но если текущее состояние VisitSessionState DEPARTMENT_SELECTION, чат необходимо начать именно с помощью данного метода.

Если настройки аккаунта предусматривают приветственные сообщения, до начала чата (методами серии startChat или с первым сообщением) приветственные сообщения получены не будут.

В параметр departmentKey передается значение ключа отдела, которое может быть получено методом getKey() протокола Department.

В результате может быть вызван метод changed(state previousState:to newState:)протокола ChatStateListener.

метод closeChat() (@available(*, deprecated))

NB

Метод не рекомендуется к использованию.

Метод отправляет сигнал сервису Webim, что посетитель закончил чат. В терминах сервиса Webim меняет у текущего чата состояние, представленное типом ChatState, на CLOSED_BY_VISITOR.

Может выбрасывать ошибки типа AccessError.

В результате может быть вызван метод changed(state previousState:to newState:) протокола ChatStateListener.

метод setVisitorTyping(draftMessage:)

Метод используется для отправки сигнала сервису Webim, что посетитель вводит сообщение (или прекратил его (сообщения) ввод).

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

Параметр draftMessage — сообщение, которое уже ввёл посетитель в соответствующее поле, но не отправил его. Тип — опциональный String, Значение параметра nil соответствует ситуации, когда посетитель прекратил ввод сообщения либо стёр написанное из поля ввода.

Может выбрасывать ошибки типа AccessError.

метод send(message:data:completionHandler:)

Метод используется для отправки сообщения посетителя в сервис Webim.

Параметр message — отправляемое сообщение. Тип — String.

Максимальная длина сообщения — 32000 символов. Более длинные сообщения будут обрезаны сервером при их получении.

Параметр data используется для передачи произвольного словаря с параметрами сообщения на сервер (если версия сервера поддерживает данный функционал). Ключи словаря должны быть типа String, значения — любого «стандартного» типа.

Параметр completionHandler — объект DataMessageCompletionHandler либо nil.

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

Может выбрасывать ошибки типа AccessError.

Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод added(newMessage:previousMessage:) протокола MessageListener с новым сообщением со статусом SENDING перечислимого типа MessageSendStatus.

метод send(message:isHintQuestion:)

Метод используется для отправки сообщения посетителя в сервис Webim.

Параметр message — отправляемое сообщение. Тип — String.

Максимальная длина сообщения — 32000 символов. Более длинные сообщения будут обрезаны сервером при их получении.

Параметр isHintQuestion используется, если приложение обладает собственным механизмом показа подсказок пользователю. Тип — опциональный Bool. В случае, если посетитель не ввел сообщение вручную, а выбрал одну из предлагаемых подсказок, значение параметра должно быть true, и false — в обратном случае. Параметр не обязательный для использования и может быть опущен.

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

Может выбрасывать ошибки типа AccessError.

Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод added(newMessage:previousMessage:) протокола MessageListener с новым сообщением со статусом SENDING перечислимого типа MessageSendStatus.

метод send(message:)

Полностью соответствует методу send(message:isHintQuestion:) с опущенным параметром isHintQuestion.

метод send(file:filename:mimeType:completionHandler:)

Метод используется для отправки файла от посетителя оператору.

Параметр file — сам файл в формате Data.

Параметр filename — название файла вместе с расширением. Тип — String.

Параметр mimeType — MIMЕ-тип передаваемого файла. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола SendFileCompletionHandler. Тип опциональный.

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

Может выбрасывать ошибки типа AccessError.

Если существуют объекты MessageTracker и MessageListener, отправка сообщения вызовет метод added(newMessage:previousMessage:)протокола MessageListener с новым сообщением со статусом SENDING перечислимого типа MessageSendStatus.

метод newMessageTracker(messageListener:)

Метод используется для получения экземпляра класса MessageTracker.

Параметр messageListener — объект класса, реализующего методы протокола MessageListener.

Возвращает экземпляр класса MessageTracker, соответствующий текущему объекту MessageStream.

Может выбрасывать ошибки типа AccessError.

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

метод set(visitSessionStateListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола VisitSessionStateListener.

Параметр chatStateListener — объект, реализующий методы протокола VisitSessionStateListener.

метод set(chatStateListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола ChatStateListener.

Параметр chatStateListener — объект, реализующий методы протокола ChatStateListener.

метод set(currentOperatorChangeListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола CurrentOperatorChangeListener.

Параметр currentOperatorChangeListener — объект, реализующий методы протокола CurrentOperatorChangeListener.

метод set(departmentListChangeListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола DepartmentListChangeListener.

Параметр currentOperatorChangeListener — объект, реализующий методы протокол DepartmentListChangeListener.

метод set(operatorTypingListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола OperatorTypingListener.

Параметр operatorTypingListener — объект, реализующий методы протокола OperatorTypingListener.

метод set(locationSettingsChangeListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола LocationSettingsChangeListener.

Параметр locationSettingsChangeListener — объект, реализующий методы протокола LocationSettingsChangeListener.

метод set(onlineStatusChangeListener:)

Метод передает в SDK ссылку на объект, реализующий методы протокола SessionOnlineStatusChangeListener.

Параметр sessionOnlineStatusChangeListener — объект, реализующий методы протокола SessionOnlineStatusChangeListener.

метод set(unreadByOperatorTimestampChangeListener:)

Передает объект UnreadByOperatorTimestampChangeListener.

метод set(unreadByVisitorMessageCountChangeListener:)

Передает объект UnreadByVisitorTimestampMessageCountListener.

метод set(unreadByVisitorTimestampChangeListener:)

Передает объект UnreadByVisitorTimestampChangeListener.

метод send(uploadedFiles:completionHandler:)

Метод, с помощью которого можно отправить отправить файлы на сервер Webim. Тип — UploadedFile.

Параметр uploadedFile — список файлов которые необходимо отправить.

Параметр completionHandler — объект, реализующий методы интерфейса SendFilesCompletionHandler. Тип опциональный.

метод uploadFilesToServer(file:filename:mimeType:completionHandler:)

Параметр file — сам файл в формате Data.

Параметр filename — название файла. Тип — String.

Параметр mimeType — MIMЕ-тип передаваемого файла. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола UploadFileToServerCompletionHandler. Тип опциональный.

метод deleteUploadedFiles(fileGuid:completionHandler:)

Метод, с помощью которого можно удалить файлы с сервера Webim.

Параметр fileGuid — id удаляемого файла. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола DeleteUploadedFileCompletionHandler. Тип опциональный.

метод sendSticker(withId:completionHandler:)

С помощью этого метода можно отправить стикер в чат.

Параметр withId — ID стикера, который необходимо отправить сервису Webim. Тип — int.

Параметр completionHandler — объект, реализующий интерфейс SendStickerCompletionHandler. Тип опциональный.

метод searchStreamMessagesBy(query:completionHandler:)

Метод используется поиска сообщения в истории по запросу.

Может выбрасывать ошибки типа AccessError.

Параметр query — запрос для поиска. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола SearchMessagesCompletionHandler. Тип опциональный.

метод getRawConfig(forLocation:completionHandler:)

Метод используется для получения конфигурации для местоположения.

Может выбрасывать ошибки типа AccessError.

Параметр forLocation — название текущего местоположения. Тип — String.

Параметр completionHandler — объект, реализующий методы протокола RawLocationConfigCompletionHandler. Тип опциональный.

метод react(message:reaction:completionHandler:)

Метод используется для отправки реакции пользователя на сообщение.

Может выбрасывать ошибки типа AccessError.

Параметр message — сообщение для реакции. Тип — Message.

Параметр reaction — реакция пользователя. Тип — ReactionString.

Параметр completionHandler — объект, реализующий методы протокола ReactionCompletionHandler. Тип опциональный.

метод clearHistory()

Метод вызывается, когда пользователь очищает историю.


протокол DataMessageCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода send(message:data:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Метод вызывается при успешной отправке сообщения и обработке сервером переданного словаря data (если не nil) методом send(message:data:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неудачной обработке сервером переданного словаря data (если не nil) методом send(message:data:completionHandler:) протокола MessageStream. Само сообщение в этом случае сервером будет обработано.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — DataMessageError.


протокол DeleteMessageCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода send(message:data:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Вызывается при успешном результате вызова метода delete(message:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неуспешном результате вызова метода delete(message:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешному удалению сообщения. Тип — DeleteMessageError.


протокол DeleteUploadedFileCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода deleteUploadedFiles(fileGuid:completionHandler:) протокола MessageStream.

метод onSuccess()

Метод вызывается при успешном удалении файла методом deleteUploadedFiles(fileGuid:completionHandler:) протокола MessageStream.

метод onFailure(error:)

Вызывается при неудачном удалении файла методом deleteUploadedFiles(fileGuid:completionHandler:) протокола MessageStream.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — DeleteUploadedFileError.


протокол RawLocationConfigCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода getRawConfig(forLocation:completionHandler:) протокола MessageStream.

метод onSuccess(rawLocationConfig:)

Метод вызывается при успешном запросе методом getRawConfig(forLocation:completionHandler:) протокола MessageStream.

Параметр rawLocationConfig — конфигурация местоположения. Тип — [String: Any?].

метод onFailure()

Вызывается при неудачном запросе метода getRawConfig(forLocation:completionHandler:).


протокол ReactionCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода react(message:reaction:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Метод вызывается при успешном запросе методом react(message:reaction:completionHandler:) протокола MessageStream.

Параметр messageid — ID сообщения. Тип — String.

метод onFailure(error:)

Вызывается при неудачном запросе метода react(message:reaction:completionHandler:).

Параметр error — ошибка, воспрепятствовавшая успешному вызову метода. Тип — ReactionError.


протокол SearchMessagesCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода searchStreamMessagesBy(query:completionHandler:) протокола MessageStream.

метод onSearchMessageSuccess(query:messages:)

Метод вызывается при успешном запросе истории методом searchStreamMessagesBy(query:completionHandler:) протокола MessageStream.

Параметр query — запрос. Тип — String.

Параметр messages — сообщения по запросу. Тип — [String].

метод onSearchMessageFailure(query:)

Вызывается при неудачном запросе истории методом searchStreamMessagesBy(query:completionHandler:) протокола MessageStream.

Параметр query — запрос. Тип — String.


протокол SendDialogToEmailAddressCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода sendDialogTo(emailAddress:completionHandler:) протокола MessageStream.

метод onSuccess()

Вызывается при успешном результате вызова метода sendDialogTo(emailAddress:completionHandler:) протокола MessageStream.

метод onFailure(error:)

Вызывается при неуспешном результате вызова метода sendDialogTo(emailAddress:completionHandler:) протокола MessageStream.

Параметр error — ошибка, воспрепятствовавшая успешному вызову метода. Тип — SendDialogToEmailAddressError.


перечисляемый тип SendDialogToEmailAddressError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода SendDialogToEmailAddressCompletionHandler.onFailure(error:).

случай NO_CHAT

Чата не существует.

случай SENT_TOO_MANY_TIMES

Превышен лимит попыток отправки.

случай UNKNOWN

Неизвестная ошибка.


протокол SendFileCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода send(file:filename:mimeType:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Метод вызывается при успешной отправке файла методом send(file:filename:mimeType:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неудачной отправке файла методом send(file:filename:mimeType:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — SendFileError.


протокол SendFilesCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода send(uploadedFiles:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Метод вызывается при успешной отправке файлов методом send(uploadedFiles:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неудачной отправке файлов методом send(uploadedFiles:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — SendFilesError.


протокол SendKeyboardRequestCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода sendKeyboardRequest протокола MessageStream.

метод onSuccess(messageID:)

Вызывается при успешном результате вызова метода sendKeyboardRequest протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

метод onFailure(messageID:error:)

Вызывается при неуспешном результате вызова метода sendKeyboardRequest протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешному вызову метода. Тип — KeyboardResponseError.


протокол SendMessageCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода send(message:completionHandler:) протокола MessageStream.

метод onSuccess(messageID:)

Вызывается при успешном результате вызова метода send(message:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.


протокол SendStickerCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода send(message:completionHandler:) протокола MessageStream.

метод onSuccess()

Метод вызывается при успешной отправке стикера методом sendSticker(withId:completionHandler:) протокола MessageStream.

метод onFailure(error:)

Вызывается при неудачной отправке стикера методом send(message:completionHandler:) протокола MessageStream.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — SendStickerError.


протокол SendSurveyAnswerCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода send(surveyAnswer:completionHandler:) протокола MessageStream.

метод onSuccess()

Вызывается при успешном результате вызова метода send(surveyAnswer:completionHandler:) протокола MessageStream.

метод onFailure(error:)

Вызывается при неуспешном результате вызова метода send(surveyAnswer:completionHandler:) протокола MessageStream.

Параметр error — ошибка, воспрепятствовавшая успешному вызову метода. Тип — SendSurveyAnswerError.


перечисляемый тип SendFilesError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(messageID:error:) протокола SendFilesCompletionHandler.

случай fileNotFound

Файл не найден.

случай maxFilesCountPerMessage

Максимальное число файлов для сообщения.

случай unknown

Неизвестная ошибка.


перечисляемый тип SendSurveyAnswerError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода SendSurveyAnswerCompletionHandler.onFailure(error:).

случай incorrectRadioValue

Возникает, когда был передан неправильный ответ на вопрос типа 'radio'.

случай incorrectStarsValue

Возникает, когда был передан неправильный ответ на вопрос типа 'stars'.

случай incorrectSurveyID

Возникает, когда при попытке отправить ответ на вопрос был передан неверный ID опроса.

случай maxCommentLength_exceeded

Возникает, когда был отправлен ответ на вопрос типа 'comment', превосходящий максимально разрешенную длину.

случай noCurrentSurvey

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

случай questionNotFound

Вопрос не найден.

случай surveyDisabled

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

случай unknown

Неизвестная ошибка.


перечисляемый тип SurveyCloseError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода SurveyCloseCompletionHandler.onFailure(error:).

случай incorrectSurveyID

Возникает, когда при попытке закрыть опрос был передан неверный ID опроса.

случай noCurrentSurvey

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

случай surveyDisabled

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

случай unknown

Неизвестная ошибка.


перечисляемый тип SurveyType

Типы, которые можно получить в результате вызова метода getType() у объекта типа SurveyQuestion.

случай stars

Вопрос, в котором ответ — это оценка.

случай radio

Вопрос, в котором ответ — это вариант из списка возможных вариантов.

случай comment

Вопрос, в котором ответ — это комментарий пользователя.


протокол Sticker

метод getStickerId()

С помощью этого метода можно получить ID стикера.

Возвращает ID стикера. Тип — Int.


протокол Survey

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

метод getConfig()

С помощью этого метода можно получить конфигурацию опроса.

Возвращает значение типа SurveyConfig.

метод getID()

С помощью этого метода можно получить id опроса.

Возвращает значение типа String.

метод getCurrentQuestionInfo()

С помощью этого метода можно получить информацию о текущем вопросе.

Возвращает значение типа SurveyCurrentQuestionInfo.


протокол SurveyCloseCompletionHandler

Объект, реализующий данный протокол, может быть передан в параметр completionHandler метода closeSurvey(completionHandler:) протокола MessageStream.

метод onSuccess()

Вызывается при успешном результате вызова метода closeSurvey(completionHandler:) протокола MessageStream.

метод onFailure(error:)

Вызывается при неуспешном результате вызова метода closeSurvey(completionHandler:) протокола MessageStream.

Параметр error — ошибка, воспрепятствовавшая успешному вызову метода. Тип — SurveyCloseError.


протокол SurveyConfig

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

метод getID()

С помощью этого метода можно получить id конфигурации опроса.

Возвращает значение типа Int.

метод getDescriptor()

С помощью этого метода можно получить объект дескриптора данного опроса.

Возвращает значение типа SurveyDescriptor.

метод getVersion()

С помощью этого метода можно получить информацию о версии текущей конфигурации опроса.

Возвращает значение типа String.


протокол SurveyCurrentQuestionInfo

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

метод getFormID()

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

Возвращает значение типа Int.

метод getQuestionID()

С помощью этого метода можно получить индекс текущего вопроса в списке вопросов начиная с 0, возвращаемых методом getQuestions().

Возвращает значение типа Int.


протокол SurveyDescriptor

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

метод getForms()

С помощью этого метода можно получить список форм текущего опроса.

Возвращает значение типа SurveyForm].


протокол SurveyForm

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

метод getID()

С помощью этого метода можно получить id формы.

Возвращает значение типа Int.

метод getQuestions()

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

Возвращает значение типа SurveyQuestion].


протокол SurveyListener

Объект, реализующий протокол, может быть передан в параметре surveyListener метода set(surveyListener:) протокола MessageStream.

метод on(survey:)

Данный метод вызывается в момент, когда с сервера приходит новый опрос.

Параметр survey — объект опроса. Тип — Survey.

метод on(nextQuestion:)

Данный метод вызывается в двух случаях: при получении опроса сразу после вызова on(survey:) и при успешном ответе на предыдущий вопрос текущего опроса.

Параметр nextQuestion — первый/следующий вопрос. Тип — SurveyQuestion.

метод onSurveyCancelled()

Данный метод вызывается, когда опрос закрывается на сервере.


протокол SurveyQuestion

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

метод getType()

С помощью этого метода можно узнать тип данного вопроса.

Возвращает значение типа SurveyType.

метод getText()

С помощью этого метода можно получить текст вопроса.

Возвращает значение типа String.

метод getOptions()

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

Возвращает опциональное значение типа [String].


протокол RateOperatorCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода rateOperatorWith(id:rating:completionHandler:) протокола MessageStream.

метод onSuccess()

Метод вызывается при успешном результате вызова метода rateOperatorWith(id:rating:completionHandler:) протокола MessageStream.

метод onFailure(error:)

Метод вызывается при неуспешном результате вызова метода rateOperatorWith(id:rating:completionHandler:) протокола MessageStream.

Параметр error — возникшая ошибка. Тип — RateOperatorError.


протокол VisitSessionStateListener

Протокол, адаптация которого позволяет отслеживать изменения VisitSessionState.

метод changed(state:to:)

Метод вызывается при изменении VisitSessionState.

В параметры метода передаются старое и новое значения.


протокол DepartmentListChangeListener

Протокол, адаптация которого позволяет отслеживать изменения списка отделов.

метод received(departmentList:)

Метод вызывается при получении нового списка отделов.

В параметр метода передается массив объектов Department.


протокол LocationSettings

Экземпляр класса, подчиняющегося протоколу, может быть получен методом getLocationSettings() объекта MessageStream. С помощью методов данного протокола могут быть получены специфические настройки текущей локации.

метод areHintsEnabled()

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

Возвращает true, если подсказки необходимо показывать, и false — в противном случае. Тип — Bool.


протокол ChatStateListener

Протокол, методы которого реализуются каким-либо классом приложения. Объект, подчиняющийся протоколу, может быть передан в параметре chatStateListener метода set(chatStateListener:) протокола MessageStream. Используется для отслеживания изменений состояния текущего чата.

метод changed(state previousState:to newState:)

Метод вызывается, когда состояние текущего чата изменилось.

Параметр previousState — предыдущее состояние чата. Тип — ChatState.

Параметр newState — новое состояние чата. Тип — ChatState.


протокол CurrentOperatorChangeListener

Протокол, методы которого реализуются каким-либо классом приложения. Объект, подчиняющийся протоколу, может быть передан в параметре currentOperatorChangeListener метода set(currentOperatorChangeListener:) протокола MessageStream.Используется для отслеживания изменения оператора текущего чата.

метод changed(operator previousOperator:to newOperator:)

Метод вызывается, когда оператор текущего чата изменился (или оператора не стало).

Параметр previousOperator — предыдущий оператор. Тип — Operator.

Параметр newOperator — новое состояние чата. Тип — опциональный Operator. Принимает значение nil в случае, если оператор покинул чат.


протокол OperatorTypingListener

Объект, подчиняющийся протоколу, может быть передан в параметре operatorTypingListener метода set(operatorTypingListener:) протокола MessageStream.Используется для оповещения, когда оператор начинает вводить сообщение.

метод onOperatorTypingStateChanged(isTyping:)

Метод вызывается, когда оператор текущего чата начал вводить сообщение.

Параметр isTyping true, если оператор вводить сообщение, и false — в противном случае. Тип — Bool.


протокол LocationSettingsChangeListener

Протокол, методы которого реализуются каким-либо классом мобильного приложения. Объект класса, подчиняющийся протоколу, может быть передан в параметре locationSettingsChangeListener метода set(locationSettingsChangeListener:) протокола MessageStream. Используется для отслеживания изменений в текущих настройках локации.

метод changed(locationSettings previousLocationSettings:to newLocationSettings:)

Метод вызывается, когда настройки текущей локации изменились.

Параметр previousLocationSettings — предыдущее значение настроек текущей локации. Тип — LocationSettings.

Параметр newLocationSettings — новое значение настроек текущей локации. Тип — LocationSettings.


протокол OnlineStatusChangeListener

Протокол адаптируется сущностями мобильного приложения. Объект класса, адаптировавшего протокол может быть передан в параметре sessionOnlineStatusChangeListener метода set(onlineStatusChangeListener:) протокола MessageStream. Используется для получения оповещений при изменении статуса сессии. Статус сессии описан в значениях перечисляемого типа OnlineStatus.

метод changed(onlineStatus previousOnlineStatus:to newOnlineStatus:)

Метод вызывается при изменении статуса сессии.

Параметр previousSessionOnlineStatus — предыдущее состояние сессии. Тип — OnlineStatus.

Параметр newSessionOnlineStatus — новое (полученное) состояние сессии. Тип — OnlineStatus.

Метод вызывается в результате полученного уведомления от сервиса Webim.


протокол UnreadByOperatorTimestampChangeListener

Протокол, предоставляющий методы для обработки изменений параметра, возвращаемого методом getUnreadByOperatorTimestamp(). Объект, адаптирующий протокол, передается с помощью метода set(unreadByOperatorTimestampChangeListener:).

метод changedUnreadByOperatorTimestampTo(newValue:)

Метод, который вызывается при изменении параметра, возвращаемого методом getUnreadByOperatorTimestamp().

Параметр newValue — новое значение, возвращаемое методом getUnreadByOperatorTimestamp(). Тип — опциональный Date.


протокол UnreadByVisitorMessageCountChangeListener

Протокол, предоставляющий методы для обработки изменений параметра, возвращаемого методом getUnreadByVisitorMessageCount().Объект, адаптирующий протокол, передается с помощью метода set(unreadByVisitorMessageCountChangeListener:).

NB

Объект класса, реализующий данный протокол, может быть получен только после старта сессии методом resume(). Данный объект увеличивает значение количества непрочитанных сообщений, посылая каждые 30 секунд соответствующие запросы на сервер.

метод changedUnreadByVisitorMessageCountTo(newValue:)

Метод, который вызывается при изменении параметра, возвращаемого методом getUnreadByVisitorMessageCount().

Параметр newValue — новое значение, возвращаемое методом getUnreadByVisitorMessageCount(). Тип — Int.


протокол UnreadByVisitorTimestampChangeListener

Протокол, предоставляющий методы для обработки изменений параметра, возвращаемого методом getUnreadByVisitorTimestamp(). Объект, адаптирующий протокол, передается с помощью метода set(unreadByVisitorTimestampChangeListener:).

метод changedUnreadByVisitorTimestampTo(newValue:)

Метод, который вызывается при изменении параметра, возвращаемого методом getUnreadByVisitorTimestamp().

Параметр newValue — новое значение, возвращаемое методом getUnreadByVisitorTimestamp(). Тип — опциональный Date.


протокол UploadFileToServerCompletionHandler

Объект, подчиняющийся протоколу, может быть передан в параметре completionHandler метода uploadFilesToServer(file:filename:mimeType:completionHandler:) протокола MessageStream.

метод onSuccess(id:uploadedFile:)

Метод вызывается при успешной загрузке файла методом uploadFilesToServer(file:filename:mimeType:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр uploadedFile — загруженный на сервер файл. Тип — UploadedFile.

метод onFailure(messageID:error:)

Вызывается при неудачной загрузке файла методом uploadFilesToServer(file:filename:mimeType:completionHandler:) протокола MessageStream.

Параметр messageid — ID соответствующего сообщения. Тип — String.

Параметр error — ошибка, воспрепятствовавшая успешной отправке файла. Тип — SendFileError.


протокол UploadedFile

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

метод getSize()

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

Возвращает размер файла вложения в байтах. Тип — Int64.

метод getGuid()

Метод, с помощью которого может быть получен guid файла вложения.

Возвращает значение в текстовом виде. Тип — String.

метод getFileName()

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

Возвращает имя файла вложения в текстовом виде. Тип — String.

метод getContentType()

Метод, с помощью которого может быть получен MIME-тип вложения.

Возвращает MIME-тип вложения в текстовом видe. Тип — опциональный String.

метод getVisitorId()

Метод, с помощью которого может быть получен id отправителя файла.

Возвращает значение в текстовом виде. Тип — String.

метод getClientContentType()

Метод, с помощью которого может быть получен MIME-тип вложения.

Возвращает MIME-тип вложения в текстовом видe. Тип — String.

метод getImageInfo()

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

Возвращает информацию об изображении. Тип — опциональный ImageInfo.


перечисляемый тип ChatState

Возможные варианты состояния чата (см. метод getChatState() протокола MessageStream). Начальное состояние — NONE. Если вызван метод startChat() или один из методов отправки сообщений протокола MessageStream,состояние изменяется на QUEUE. Когда оператор принимает чат в обработку, его (чата) состояние изменяется на CHATTING. Когда вызывается метод closeChat() протокола MessageStream, состояние чата изменяется на CLOSED_BY_VISITOR. Если чат был закрыт оператором — на CLOSED_BY_OPERATOR. После того, как чат был закрыт и посетителем, и оператором, его состояние возвращается в NONE. Также это происходит после долгого отсутствия активности в чате. Также чат может быть заново начат и оператором: в этом случае состояние чата принимает значение INVITATION, а после того, как посетитель напишет что-либо в ответ, состояние чата принимает значение CHATTING.

случай CHATTING

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

Из этого состояния чат может перейти либо в CLOSED_BY_OPERATOR, либо в CLOSED_BY_VISITOR, либо в NONE.

случай CHATTING_WITH_ROBOT

Состояние чата, когда либо бот ответил в инициированном посетителем чате.

Из этого состояния чат может перейти либо в CHATTING, либо в CLOSED_BY_VISITOR, либо в NONE.

случай CLOSED_BY_OPERATOR

Состояние чата, когда тот был закрыт оператором, но еще не закрыт посетителем.

Из этого состояния чат может перейти либо в NONE, либо в QUEUE, если посетитель напишет что-либо еще.

случай CLOSED_BY_VISITOR

Состояние чата, когда тот был закрыт посетителем, но еще не закрыт оператором.

Из этого состояния чат может перейти либо в NONE, либо в QUEUE, если посетитель напишет что-либо еще.

случай INVITATION

Состояние чата, когда тот был инициирован оператором.

Из этого состояния чат может перейти либо в NONE, либо в CHATTING.

случай NONE

Означает отсутствие чата.

Из этого состояния чат может перейти либо в INVITATION, либо в QUEUE.

случай QUEUE

Состояние чата, когда тот был инициирован посетителем.

Из этого состояния чат может перейти либо в NONE, либо в CHATTING, либо в CLOSED_BY_OPERATOR.

случай UNKNOWN

Данное состояние принимает чат при создании сессии до первого обновления состояния чата, полученного от сервера.

Также это состояние может быть получено, если SDK не может его идентифицировать (например, на сервере появились новые значения состояния чата, которые текущая версия SDK не умеет обрабатывать).


перечисляемый тип OnlineStatus

Возможные статусы онлайн.Могут быть получены с помощью метода changed(onlineStatus previousOnlineStatus:to newOnlineStatus:) протокола SessionOnlineStatusChangeListener.

случай BUSY_OFFLINE

Офлайн-состояние с превышенным количеством лимита чатов.

Означает, что посетитель не может отправлять сообщения вообще.

случай BUSY_ONLINE

Онлайн-состояние с превышенным количеством лимита чатов.

Означает, что посетитель может отправлять сообщения в офлайн-зону, но сервер может их отклонить и вернуть ошибку.

случай OFFLINE

Означает, что посетитель может отправлять сообщения в офлайн-зону.

случай ONLINE

Означает, что посетитель может отправлять сообщения без каких-либо ограничений.

случай UNKNOWN

Означает, что либо SDK пока не получил первое обновление статуса сессии от сервиса Webim, либо статус сессии не поддерживается в текущей версии SDK.


перечисляемый тип VisitSessionState

Возможные статусы сессии.

случай CHAT

Состояние чата.

случай DEPARTMENT_SELECTION

Означает, что была произведена попытка начать чат без выбора отдела, а на сервере установлено, что выбор отделов обязателен.

Сессия ожидает начало чата с помощью метода startChat(departmentKey:).

случай IDLE

Сессия активна, но чат пока не был начат.

случай IDLE_AFTER_CHAT

Сессия активна, но чат был уже закрыт.

случай OFFLINE_MESSAGE

Офлайн.

случай UNKNOWN

Статус еще не был получен или не поддерживается текущей версией WebimClientLibrary.


перечисляемый тип DataMessageError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(messageID:error:).

случай UNKNOWN

Полученный код ошибки не поддерживается данной версией WebimClientLibrary.

случай QUOTED_MESSAGE_CANNOT_BE_REPLIED

Процитированное сообщение не отмечено флагом canBeReplied или флаг не стоит в значении true.

случай QUOTED_MESSAGE_FROM_ANOTHER_VISITOR

Отправленный ID сообщения соответствует другому посетителю.

случай QUOTED_MESSAGE_MULTIPLE_IDS

Отправленный ID сообщения соответствует нескольким сообщениям (скорее всего, имеет место ошибка в базе данных).

случай QUOTED_MESSAGE_REQUIRED_ARGUMENTS_MISSING

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

случай QUOTED_MESSAGE_WRONG_ID

Был отправлен неверный ID процитированного сообщения.


перечисляемый тип SendFileError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(messageID:error:) протокола SendFileCompletionHandler.

случай FILE_SIZE_EXCEEDED

Означает, что размер файла превышает максимальный размер, установленный в настройках сервера.

случай FILE_TYPE_NOT_ALLOWED

Означает, что тип файла не входит в число разрешенных типов, установленных в настройках сервера.

случай UPLOADED_FILE_NOT_FOUND

Означает, что файл был передан неправильным способом.

случай UNKNOWN

Неизвестная ошибка.

случай UNAUTHORIZED

Неизвестная ошибка.


перечисляемый тип SendStickerError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(error:) протокола SendStickerCompletionHandler.

случай noChat

Чат не найден.

случай noStickerId

ID стикера не установлен.


перечисляемый тип RateOperatorError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(error:) протокола RateOperatorCompletionHandler.

случай NO_CHAT

Возникает при попытке отправить оценку оператора, когда чата не существует.

случай WRONG_OPERATOR_ID

Возникает, когда при попытке отправить оценку оператора был передан ID оператора, не принадлежащего текущему чату.

случай NOTE_IS_TOO_LONG

Слишком длинный комментарий. Максимальная длина 2000 символов.


протокол MessageTracker

Экземпляр класса, подчиняющегося протоколу, может быть получен с помощью метода new(messageTracker:) протокола MessageStream. Методы протокола используются для манипуляций с сообщениями, существующими в истории сообщений.

метод getLastMessages(byLimit:completion:)

Метод используется для запроса сообщений с начала истории сообщений.

Параметр limitOfMessages — количество следующих сообщений, не более которого должен запросить метод. Тип — Int, значение может быть любым положительным больше 1 (если передано значение меньше 1, метод не выполнит никакой работы).

Параметр completion — замыкание, которое выполняется после завершения выполнения метода. Замыкание содержит один параметр типа массив Message и не имеет возвращаемого типа. Как правило, в параметр передается ожидаемый набор сообщений из истории сообщений. Если параметр не содержит ни одного объекта типа Message (массив пуст) — это означает, что достигнут конец истории сообщений. Если при выполнении метод не выбросил никакую ошибку, переданное замыкание будет выполнено гарантированно (с пустым или нет результатом).

Каждый последующий вызов данного метода может быть совершен только после того, как предыдущий запрос был завершен (было вызвано замыкание).

Может выбрасывать ошибки типа AccessError.

Метод не выполнит никакой работы, если соответствующий объект MessageTracker был деактивирован (см. метод destroy()).

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

метод getNextMessages(byLimit:completion:)

Метод используется для запроса сообщений из истории сообщений, которая еще не отображается в текущей ленте сообщений.

Параметр limitOfMessages — количество следующих сообщений, не более которого должен запросить метод. Тип — Int, значение может быть любым положительным больше 1 (если передано значение меньше 1, метод не выполнит никакой работы).

Параметр completion — замыкание, которое выполняется после завершения выполнения метода. Замыкание содержит один параметр типа массив Message и не имеет возвращаемого типа. Как правило, в параметр передается ожидаемый набор сообщений из истории сообщений. Если параметр не содержит ни одного объекта типа Message(массив пуст) — это означает, что достигнут конец истории сообщений. Если при выполнении метод не выбросил никакую ошибку, переданное замыкание будет выполнено гарантированно (с пустым или нет результатом).

Каждый последующий вызов данного метода может быть совершен только после того, как предыдущий запрос был завершен (было вызвано замыкание).

Может выбрасывать ошибки типа AccessError.

Метод не выполнит никакой работы, если соответствующий объект MessageTracker был деактивирован (см. метод destroy()).

метод getAllMessages(completion:)

Метод используется для запроса сразу всей истории сообщений.

Параметр completion — замыкание, которое выполняется после завершения выполнения метода. Замыкание содержит один параметр типа массив Message и не имеет возвращаемого типа. Как правило, в параметр передается ожидаемый набор сообщений из истории сообщений. Если параметр не содержит ни одного объекта типа Message(массив пуст) — это означает, что достигнут конец истории сообщений. Если при выполнении метод не выбросил никакую ошибку, переданное замыкание будет выполнено гарантированно (с пустым или нет результатом).

Может выбрасывать ошибки типа AccessError.

Метод не выполнит никакой работы, если соответствующий объект MessageTracker был деактивирован (см. метод destroy()).

метод resetTo(message:)

Объект MessageTracker хранит текущий диапазон сообщений. Вызов данного метода может «сбросить» предел, до которого объект хранит историю сообщений, до определенного сообщения.

Параметр message — сообщение, до которого необходимо «сбросить» предел хранимой истории сообщений. Тип — Message.

Может выбрасывать ошибки типа AccessError.

Метод может быть вызван только после того, как предыдущее обращение к объекту MessageTracker вернуло результат, иначе метод не выполнит никакой работы.

метод destroy()

Деактивирует текущий объект MessageTracker, после чего никакие методы протокола не могут быть использованы.

Может выбрасывать ошибки типа AccessError.


протокол MessageListener

Протокол должен быть адаптирован каким-либо классом приложения. Методы протокола вызываются при изменениях в ленте сообщений.

метод added(newMessage:previousMessage:)

Метод вызывается при добавлении сообщений в текущую ленту. Важно, что вызов метода не является признаком получения именно нового сообщения: это логическая вставка сообщений в ленту. Например, при первом успешном соединении с сервером, SDK получает всю историю сообщений. Если она содержит сообщения, находящиеся в уже отображаемом в ленте временном промежутке, на каждое такое сообщение также будет вызван этот метод.

Параметр newMessage — полученное сообщение. Тип — Message.

Параметр previousMessage — сообщение, после которого необходимо вставить полученное сообщение. Тип — опциональный Message. Если значение данного параметра nil, полученное сообщение необходимо вставить в конце списка.

метод removed(message:)

Метод вызывается при удалении сообщения из ленты.

Параметр message — удаленное сообщение. Тип — Message.

метод removedAllMessages()

Метод вызывается при удалении всех сообщений из ленты.

метод changed(oldVersion:newVersion:)

Метод вызывается при изменении какого-либо сообщения.

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

Параметр oldVersion — прежний объект сообщения. Тип — Message.

Параметр newVersion — новый объект сообщения. Тип — Message.


протокол Message

Протокол является абстракцией, представляющей отдельное сообщение внутри SDK. Объекты Message могут быть получены в вызовах методов протокола MessageListener.

Объекты Message — неизменяемые. Изменения каких-либо его полей создает новый объект. На идентичность полей два объекта Message можно проверить методом isEqual(to:). Логическое соответствие объектов сообщения можно проверить, сравнив их ID (см. метод getID()).

метод getRawData()

С помощью этого метода можно получить произвольный словарь, формируемый сервером, при использовании MessageType ACTION_REQUEST.

Возвращает словарь типа [String: Any?] или nil, если он отсутствует.

метод getData()

Сообщения типа FILE_FROM_OPERATOR или FILE_FROM_VISITOR могут содержать вложенные файлы. С помощью этого метода можно получить файл.

Возвращает экземпляр класса MessageData или nil, если файл находится в процессе отправки.

метод getCurrentChatID()

С помощью этого метода можно получить уникальный ID текущего чата.

Возвращает ID чата. Тип — String или nil, если ID отсутствует.

метод getKeyboard()

С помощью этого метода можно получить элемент клавиатуры чат-бота.

Возвращает клавиатуру с кнопками. Тип — опциональный Keyboard.

метод getKeyboardRequest()

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

Возвращает элемент клавиатуры, выбранный пользователем. Тип — опциональный KeyboardRequest.

метод getQuote()

С помощью этого метода можно получить информацию о цитируемом сообщении.

Возвращает цитированное сообщение. Тип — класса опциональный Quote.

метод isReadByOperator()

С помощью этого метода можно получить информацию о статусе сообщения. Прочитано ли оно оператором или нет.

Возвращает true, если сообщение прочитано оператором, и false, если нет. Тип — Bool.

метод canBeEdited()

С помощью этого метода можно получить информацию о том, может ли сообщение быть изменено или удалено.

Возвращает true, если может, и false, если нет. Тип — Bool.

Чтобы метод мог возвращать true в принципе, соответствующая методу функциональность (редактирование и удаление сообщений) должна быть активна на аккаунте. В данном случае значение параметра настроек аккаунта (account config) visitor_message_editing должно быть true. В противном случае, метод всегда будет возвращать false.

метод canBeReplied()

С помощью этого метода можно получить информацию о том, можно ли ответить на данное сообщение.

Возвращает true, если можно, и false, если нет. Тип — Bool.

Чтобы метод мог возвращать true в принципе, соответствующая методу функциональность (цитирование сообщений) должна быть активна на аккаунте. В данном случае значение параметра настроек аккаунта (account config) web_and_mobile_quoting должно быть true. В противном случае, метод всегда будет возвращать false.

метод getID()

С помощью этого метода можно получить уникальный ID cообщения.

Возвращает ID сообщения. Тип — String.

метод getOperatorID()

С помощью этого метода можно получить ID оператора, отправившего сообщение.

Возвращает ID оператора или nil, если сообщение было отправлено не оператором. Тип — опциональный String.

метод getSenderAvatarFullURL()

С помощью этого метода можно получить URL для загрузки аватара отправителя сообщения (если есть).

Возвращает полный URL аватара отправителя сообщения или nil, если аватар отсутствует. Тип — опциональный URL.

метод getSenderName()

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

Возвращает имя отправителя сообщения. Тип — String.

метод getSendStatus()

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

Возвращает значение перечисляемого типа MessageSendStatus.

метод getText()

С помощью этого метода можно получить текст сообщения.

Возвращает текст сообщения. Тип — String.

метод getTime()

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

Тип — Date.

метод getType()

С помощью этого метода можно получить тип сообщения.

Возвращает значение перечисляемого типа MessageType.

метод isEqual(to message:)

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

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

if messageOne.isEqual(to: messageTwo) { /* ... */ }

Где messageOne и messageTwo — любые экземпляры типа Message.

Параметр message — сообщение, с которым сравнивается сообщение, на котором вызывается метод. Тип — Message.

Возвращает true, если поля сообщений идентичны, и false — если это не так. Тип — Bool.

метод getSticker()

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

Возвращает стикер. Тип — опциональный Sticker.

метод isEdited()

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

Возвращает true, если сообщение было изменено, и false, если нет. Тип — Bool.

метод canVisitorReact()

С помощью этого метода можно получить информацию о том, можно ли посетителю оставить реакцию на данное сообщение.

Возвращает true, если можно, и false, если нет. Тип — Bool.

метод getVisitorReaction()

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

Возвращает реакцию посетителя. Тип — опциональный String.

метод canVisitorChangeReaction()

С помощью этого метода можно получить информацию о том, можно ли посетителю изменить реакцию на данное сообщение.

Возвращает true, если можно, и false, если нет. Тип — Bool.


протокол MessageAttachment

Протокол является абстракцией, представляющей файловое вложение в сообщение. Объект MessageAttachment может быть получен в помощью метода getAttachment() Message.

метод getFileInfo()

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

Возвращает информацию о файле. Тип — FileInfo.

метод getState()

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

Возвращает информацию о состоянии загрузки файла. Тип — AttachmentState.

метод getDownloadProgress()

Метод, с помощью которого можно получить процент загрузки файла на сервер.

Возвращает процент загрузки файла. Тип — опциональный Int64.

метод getErrorType()

Метод, с помощью которого можно получить тип ошибки, из-за которой возникли проблемы с загрузкой файла.

Возвращает тип ошибки. Тип — опциональный String.

метод getErrorMessage()

Метод, с помощью которого можно получить текст ошибки из-за которой возникли проблемы с загрузкой файла.

Возвращает текст ошибки. Тип — опциональный String.

метод getFilesInfo()

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

Возвращает информацию о файлах. Тип — FileInfo.


протокол ImageInfo

Протокол является абстракцией, представляющей информацию о вложении, если оно является изображением. Объект ImageInfo может быть получен с помощью метода getImageInfo() протокола MessageAttachment.

метод getThumbURL()

Метод позволяет получить URL для скачивания превью изображения. Максимальные размеры по вертикали и горизонтали — 300 пикселей, но могут быть изменены на сервере. Для того, чтобы узнать точные размеры превью до тех пор, пока изображение еще не загружено, можно использовать следующий код:

let THUMB_SIZE = 300

var width = imageInfo.getWidth()

var height = imageInfo.getHeight()

if (height > width) {

width = (THUMB_SIZE * width) / height

height = THUMB_SIZE

} else {

height = (THUMB_SIZE * height) / width

width = THUMB_SIZE

}

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

метод getHeight()

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

Возвращает высоту изображения в пикселях или nil. Тип — опциональный Int.

метод getWidth()

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

Возвращает ширину изображения в пикселях или nil. Тип — опциональный Int.


перечисляемый тип MessageType

Используется для определения типа сообщения (см. метод getType() протокола Message).

случай ACTION_REQUEST

Сообщение, содержащее словарь с произвольными данными, который будет обработан приложением исходя из определяемой клиентом логики (см. метод getData()протокола Message).

случай CONTACTS_REQUEST

Сообщение, которое поступает после того, как оператор нажал кнопку запроса контактных данных. В данный момент автоматической поддержки данного функционала нет, всякая полезная нагрузка данного и ответного сообщения пересылается в тексте сообщения (см. метод getText() протокола Message).

случай FILE_FROM_OPERATOR

Файл, отправленный оператором.

случай FILE_FROM_VISITOR

Файл, отправленный посетителем.

случай INFO

Автоматически сгенерированное на сервере системное сообщение (например, приветствие в начале чата).

случай KEYBOARD

Сообщение, отправленное чат-ботом.

случай KEYBOARD_RESPONSE

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

случай OPERATOR

Текстовое сообщение от оператора.

случай OPERATOR_BUSY

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

случай VISITOR

Текстовое сообщение от посетителя.

случай stickerVisitor

Стикер от посетителя.


Перечисляемый тип MessageSendStatus

Используется для определения статуса отправки сообщения (см. метод getSendStatus() протокола Message).

случай SENDING

Означает любое состояние сообщения до тех пор, пока оно не будет получено, обработано и отправлено всем получателям сервером.

случай SENT

Означает любое состояние сообщения после событий, перечисленных в описании значения SENDING.


протокол Department

Представление одного отдела. Предоставляет методы получения информации об отделе.Объекты Department могут быть получены с помощью адаптации протокола DepartmentListChangeListener либо в результате вызова метода getDepartmentList() протокола MessageStream.

метод getKey()

Ключ отдела необходим для начала чата с определенным отделом метод (startChat(departmentKey:) метод MessageStream).

Тип возвращаемого значения — String.

метод getName()

Возвращает публичное имя отдела.

Тип возвращаемого значения — String.

метод getDepartmentOnlineStatus()

Возвращает онлайн-статус отдела.

Тип возвращаемого значения — DepartmentOnlineStatus.

метод getOrder()

Возвращает номер, представляющий порядок вывода отдела в списке. Более высокое число означает более высокий приоритет вывода отдела в списке.

Тип возвращаемого значения — Int.

метод getLocalizedNames()

Возвращает словарь локализованных имен отдела, если таковой существует.

Тип возвращаемого значения — опциональный [String: String]. Ключ — название локали, значение — соответствующее локали название отдела.

метод getLogoURL()

Возвращает URL логотипа отдела (если таковой существует).

Тип возвращаемого значения — опциональный URL.


перечисляемый тип DepartmentOnlineStatus

Возможные статусы отдела. Могут быть получены в результате вызова метода getDepartmentOnlineStatus() протокола Department.

случай BUSY_OFFLINE

Офлайн, лимит чатов превышен.

случай BUSY_ONLINE

Онлайн, лимит чатов превышен.

случай OFFLINE

Посетитель может отправлять офлайн-сообщения.

случай ONLINE

Посетитель может отправлять онлайн-сообщения.

случай UNKNOWN

Текущий статус не поддерживается данной версией WebimClientLibrary.


перечисляемый тип DeleteMessageError

Возможные ошибки, которые могут быть переданы в параметр error при вызове метода DeleteMessageCompletionHandler.onFailure(messageID:error:).

случай UNKNOWN

Неизвестная ошибка.

случай NOT_ALLOWED

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

случай MESSAGE_NOT_OWNED

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

случай MESSAGE_NOT_FOUND

Выбранное сообщение не найдено.


перечисляемый тип DeleteUploadedFileError

Возможные ошибки, которые могут быть переданы в параметр error метода onFailure(error:) протокола DeleteUploadedFileCompletionHandler.

случай fileNotFound

Файл не найден.

случай fileHasBeenSent

Файл был отправлен.

случай unknown

Неизвестная ошибка.


протокол Operator

Объект протокола — это абстрактное представление каждого конкретного оператора чата. Объекты протокола Operator могут быть получены в методах протокола CurrentOperatorChangeListener и методом getCurrentOperator() протокола MessageStream.

метод getID()

Метод позволяет получить ID конкретного оператора.

Возвращает ID конкретного оператора. Тип — String.

метод getName()

Метод позволяет получить имя конкретного оператора.

Возвращает имя конкретного оператора. Тип — String.

метод getAvatarURL()

Метод позволяет получить URL для скачивания аватара конкретного оператора (если есть).

Возвращает URL  для скачивания аватара конкретного оператора или nil.

метод getTitle()

Метод позволяет получить заголовок сотрудника.

Возвращает заголовок сотрудника. Тип — опциональный String.

метод getInfo()

Метод позволяет получить дополнительную информацию о конкретном операторе.

Возвращает дополнительную информацию о конкретном операторе. Тип — опциональный String.


протокол WebimRemoteNotification

Объект протокола — это абстрактное представление конкретного push-уведомления, полученного приложением от сервиса Webim. Объекты протокола WebimRemoteNotification могут быть получены с помощью метода parse(remoteNotification:) класса Webim.

метод getType()

С помощью этого метода можно уточнить полезную информацию конкретного объекта WebimRemoteNotification.

Возвращает значение перечисляемого типа NotificationType.

метод getEvent()

С помощью этого метода можно уточнить предполагаемое действие, которое подразумевает получение данного конкретного объекта WebimRemoteNotification.

Возвращает значение перечисляемого типа NotificationEvent или nil.

метод getParameters()

С помощью этого метода можно уточнить полезную нагрузку конкретного объекта WebimRemoteNotification, зависящую от его типа и содержащуюся в массиве.

Возвращает массив типа String. Возможные варианты содержания массива — см. в описании перечисляемого типа NotificationType.

метод getLocation()

Метод может быть вызван для получения местоположение чата.

Возвращает опциональное значение типа String.

метод getUnreadByVisitorMessagesCount()

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

Возвращает количество сообщений. Тип — Int.


перечисляемый тип NotificationType

Значения типа указывают на тип полезной информации, заключающейся в конкретном push-уведомлении — могут быть получены с помощью метода getType() протокола WebimRemoteNotification.

случай CONTACT_INFORMATION_REQUEST

Означает событие, когда оператор выслал посетителю запрос контактных данных.

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае пустой.

случай OPERATOR_ACCEPTED

Означает событие, когда оператор подключился к чату.

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае содержит только одно значение — имя оператора.

случай OPERATOR_FILE

Означает событие, когда оператор прислал файл в чат.

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае содержит два значения — имя оператора и название файла.

случай OPERATOR_MESSAGE

Означает событие, когда оператор прислал сообщение в чат.

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае содержит два значения — имя оператора и текст сообщения.

случай WIDGET

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

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае пустой.

случай rateOperator

Означает событие, когда оператор выслал посетителю запрос оценки оператора.

Словарь параметров (см. метод getParameters() протокола WebimRemoteNotification) в этом случае пустой.


перечисляемый тип NotificationEvent

Означает событие, которое подразумевает тип действия, ожидаемого от приложения при получении данного конкретного push-уведомления — могут быть получены с помощью метода getEvent() протокола WebimRemoteNotification.

случай ADD

Добавление информации, содержащейся в данном push-уведомлении (см. методы getType() и getParameters() протокола WebimRemoteNotification).

случай DELETE

Удаление информации, содержащейся в данном push-уведомлении (см. методы getType() и getParameters() протокола WebimRemoteNotification).


протокол FatalErrorHandler

Методы протокола вызываются при необходимости обработке ошибок, которые может возвращать сервис Webim в процессе работы. Описания ошибок см. в значениях перечисляемого типа FatalErrorType

метод on(error:)

Вызывается при получении ошибки сервиса Webim. В параметр передается объект протокола WebimError.

Внимание!

Метод вызывается не из главного потока!


перечисляемый тип FatalErrorType

Соответствует значениям возможных ошибок, которые могут возникать в работе сервиса Webim (см. метод getErrorType() протокола WebimError). Большинство из них являются фатальными и вызывают уничтожение объекта сессии.

случай ACCOUNT_BLOCKED

Означает, что аккаунт клиент в сервисе Webim заблокирован (например, за неуплату).

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

Вызывает уничтожение сессии.

случай PROVIDED_VISITOR_FIELDS_EXPIRED

Означает, что предоставленные при создании сессии пользовательские данные (см. методы set(visitorFieldsJSONString:) и set(visitorFieldsJSONData:) класса SessionBuilder) более недействительны.

Предлагаемое поведение приложения — генерирование новых пользовательских данных и создание нового экземпляра сессии.

Вызывает уничтожение сессии.

случай UNKNOWN

Означает возникновение какой-либо неожиданной и недокументированной ошибки.

Вызывает уничтожение сессии.

случай VISITOR_BANNED

Возникает, когда пользователь с переданными данными (см. методы set(visitorFieldsJSONString:) и set(visitorFieldsJSONData:) класса SessionBuilder) был по какой-либо причине заблокирован оператором.

Вызывает уничтожение сессии.

случай WRONG_PROVIDED_VISITOR_HASH

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

Вызывает уничтожение сессии.


протокол WebimError

Объекты WebimError передаются в параметр error метода on(error:) протокола FatalErrorHandler.Методы протокола предназначены для обработки фатальных ошибок, которые могут возникать при работе с сервисом Webim.

метод getErrorType()

Метод предназначен для получения конкретного типа возникшей ошибки.

Возвращает значение перечисляемого типа FatalErrorType.

метод getErrorString()

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

Возвращает текстовое представление возникшей ошибки. Тип — String.


протокол WebimNotFatalError

Объекты WebimNotFatalError передаются в параметр error метода onError(error:) протокола NotFatalErrorHandler.

метод getErrorType()

Метод предназначен для получения конкретного типа возникшей ошибки.

Возвращает значение типа NotFatalErrorType.

метод getErrorString()

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

Возвращает текстовое представление возникшей ошибки. Тип — String.


перечисляемый тип AccessError

Значение типа соответствуют ошибкам, которые могут выбрасываться некоторыми методами протоколов WebimSessionMessageStream и MessageTracker.

случай INVALID_THREAD

Возникает, когда метод был вызван не из потока, в котором был создан экземпляр сессии.

случай INVALID_SESSION

Возникает при попытке использования методов недействительного экземпляра сессии (например, после того, как на нем был вызван метод destroy()).


протокол WebimLogger

Протокол, предоставляющий методы для реализации «логирования» сетевой активности WebimClientLibrary. Механизм может быть полезен, например, при дебаггинге продуктовых-релизов, в которых не доступны DEBUG-логи.

метод log(entry:)

Метод, который вызывается автоматически при выходе новой записи для лога сетевой активности WebimClientLibrary.

Новая запись передается в параметре entry (тип — String).


Возвращаемые HTTP-коды ошибок

Категория Код ошибки Значение и возможный путь решения
Общие ошибки
account-blocked Аккаунт клиента в сервисе Webim заблокирован (например, за неуплату). Обратитесь за помощью в техподдержку сервиса Webim
chat-required Ответ на действие в чате без чата
content_type_not_recognized MIME-тип вложения не распознан. Проверьте, не повреждён ли отправляемый вами файл. Также удостоверьтесь, что его содержимое соответствует одному из MIME-типов
domain-not-from-whitelist Домен не находится в белом списке
max_file_size_exceeded Размер загружаемого файла слишком велик. Попробуйте уменьшить размер файла или увеличить лимит на вес загружаемых файлов
file_size_too_small Размер загружаемого файла слишком мал. Возможно, вы пытаетесь загрузить пустой файл
not_allowed_file_type Загрузка файла данного формата запрещена или не поддерживается. Измените параметр, отвечающий за допустимые к загрузке типы файлов в настройках сервера
not_allowed_mime_type Загрузка файла данного MIME-типа запрещена или не поддерживается. Измените параметр, отвечающий за допустимые к загрузке MIME-типы файлов в настройках сервера
no_previous_chats Отсутствуют предыдущие чаты
no-sticker-id Для данного ID не существует привязанного к нему стикера. Проверьте свой запрос на предмет ошибок
not_matching_magic_numbers Магические числа не совпадают
max_files_count_per_chat_exceeded Достигнуто максимальное количество отправляемых в один чат файлов
provided-visitor-expired Представленные при создании сессии пользовательские данные более недействительны. Эта ошибка разрешается автоматически путём реинициализации
reinit-required Необходима реинициализация — вероятнее всего, устарел AuthToken. Эта ошибка разрешается автоматически путём реинициализации
setting_disabled Запрашиваемая настройка отключена
server-not-ready Сервер не готов ответить на запрос. Эта ошибка появляется при попытке обратиться к серверу до его полного включения. Попробуйте немного подождать
session_not_found Искомая сессия не найдена
unathorized Попытка неавторизованного доступа. Необходима авторизация
uploaded-file-not-found Загруженный файл не найден
visitor_banned Посетитель был заблокирован оператором
wrong-argument-value Ошибка возникает при поступлении на сервер запроса с неверным типом аргумента (например, String вместо int)
wrong-provided-visitor-hash-value Ошибка возникает при попытке авторизации посетителя с невалидной подписью
Ошибки цитирования сообщений в чате
quoting-message-that-cannot-be-replied Сообщение не может быть процитировано — оно не отмечено флагом canBeReplied или флаг не стоит в значении true
quoting-message-from-another-visitor Отправленный ID сообщения соответствует другому посетителю
corrupted-quoted-message-id Неверный ID цитируемого сообщения
multiple-quoted-messages-found Отправленный ID сообщения соответствует нескольким сообщениям (скорее всего, имеет место ошибка в базе данных)
quoted-message-not-found Отправленный ID не соответствует какому-либо сообщению в базе данных
required-quote-args-missing Один или более аргумент реализованной на сервере системы цитирования не был отправлен
Ошибки, связанные с аутентификацией
provided-auth-token-not-found Токен аутентификации не найден на сервере. Данная ошибка возникает только в случае использования кастомного клиентского механизма аутентификаци через токен. Вероятнее всего, токен ещё не дошёл до сервиса Webimс клиентского сервера и надо немного подождать
Ошибки, связанные с отправкой, редактированием и удалением сообщений
message_empty Попытка отправить пустое сообщение
max-message-length-exceeded Достигнута максимально допустимая длина сообщения
message_not_found Сообщение с искомым ID не найдено
not_allowed На сервере отключена возможность редактирования/удаления сообщений
message_not_owned Посетитель пытается редактировать/удалить сообщение оператора или указанный идентификатор принадлежит другому сообщению
wrong_message_kind Посетитель пытается отредактировать нетекстовое сообщение
Ошибки оценки операторов
no-chat Возникает при попытке отправить оценку оператора, когда чата не существует
operator-not-in-chat Возникает, когда при попытке отправить оценку оператора был передан ID оператора, не принадлежащего текущему чату
note-is-too-long Превышен лимит максимальной длины комментария — 2000 символов
Ошибки ответов клавиатуры
button-id-not-set Не установлен идентификатор кнопки
requset-message-id-not-set Не установлен идентификатор сообщения запроса
can-not-create-response Невозможо создать ответ
Ошибки отправки диалогов по электронной почте
chat-history-sent-too-many-times История переписки была отправлена слишком много раз
Ошибки опросов
survey_disabled Возникает при попытке отправить ответ на вопрос при выключенной возожности опросов на сервере
no-current-survey Возникает при попытке отправить ответ на вопрос, когда текущий опрос на сервере уже был закрыт или ещё не был начат
incorrect-survey-id Возникает при попытке отправить ответ на вопрос, передавая неверный ID опроса
incorrect-stars-value Возникает, когда был передан неправильный ответ на вопрос типа 'stars'
incorrect-radio-value Возникает, когда был передан неправильный ответ на вопрос типа 'radio'
max-comment-length-exceeded Возникает, когда был отправлен ответ на вопрос типа 'comment', превосходящий максимально разрешенную длину
question-not-found Вопрос не найден
Ошибки удаления файлов
file-has-been-sent Файл прикреплён к сообщению и не может быть удалён
file-not-found Файл не найден