Use_Desk_iOS_SDK 0.0.1

Use_Desk_iOS_SDK 0.0.1

Maintained by Maxim Melikhov.



 
Depends on:
MBProgressHUD>= 0
NYTPhotoViewer= 1.2.0
ProgressHUD>= 0
RCAudioPlayer>= 0
Socket.IO-Client-Swift>= 0
AFNetworking~> 3.1.0
NSDate-Escort>= 0
NSDate+Helpers>= 0
 

  • By
  • Maxim

Use_Desk_iOS_SDK

CI Status Version License Platform

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Installation

Use_Desk_iOS_SDK is available through CocoaPods. To install it, simply add the following line to your Podfile:

Тестовое приложение

Для запуска тестового приложения нужно:

-Клонировать репозиторий

-Запустить терминал

-Перейти в скаченную дирректорию (в папку Example)

-Выполнить команду pod install

Скриншоты Тестового приложения

Добавление библиотеки в проект:

Библиотека Use_Desk_iOS_SDK доступна через систему управления зависимостями CocoaPods.

-Добавьте строчку в Podfile вашего приложения

pod "Use_Desk_iOS_SDK"

-Выполните команду в терминале pod update

-Подключаем библиотеку #import "UseDeskSDK.h"`

Выполняем операцию инициализации чата параметрами:

Переменная Тип Описание
CompanyID NSString идентификатор компании
Email NSString почта клиента
URL NSString адрес сервера с номером порта

Блок возвращает следующие параметры:

Переменная Тип Описание
Success BOOL статус подключения к серверу
Error NSString описание ошибки при неудачном подключении

Пример:

[UDS startWithCompanyID:@”1234567email:@”[email protected]url:@”https:dev.company.ru” port:@”213connectionStatus:^(BOOL success, NSString *error) {

}];

Подключение SDK без графического интерфейса

  • Подключаем библиотеку #import "UseDeskSDK.h"

  • Выполняем операцию инициализации чата параметрами без GUI:

Переменная Тип Описание
CompanyID NSString идентификатор компании
Email NSString почта клиента
URL NSString адрес сервера
Port NSString порт сервера

Пример:

[UDS startWithoutGUICompanyID: :@”1234567email: @”[email protected]url: @”https:dev.company.ru:213connectionStatus:^(BOOL success, NSString *error) {

}];

Блок возвращает следующие параметры:

Переменная Тип Описание
Success BOOL статус подключения к серверу
Error NSString описание ошибки при неудачном подключении

Если тип ошибки noOperators то нет доступных операторов в данный момент времени

Отправка тестового сообщения:

Переменная Тип Описание
Message NSString тест сообщения

Пример:

[UDS sendMessage:@”привет как дела?”];

Отправка тестового сообщения с вложением:

Переменная Тип Описание
Message NSString тест сообщения
FileName NSString имя файла
fileType NSString тип файла (MIMO)
contentBase64 Base64 данные

Пример:

[UDS sendMessage:text withFileName:@"file" fileType:@"image/png" contentBase64:content];

Отправка оффлайн формы на сервер:

Переменная Тип Описание
Message NSString тест сообщения
URL NSString адрес отправки

Пример:

[UDS sendOfflineFormWithMessage:@”привет” url: @”https:dev.cany.ru” callback:^(BOOL success, NSString *error){
}];

Блок возвращает следующие параметры:

Переменная Тип Описание
Success BOOL статус отправки
Error NSString тип ошибки

CallBack – уведомления о действиях

Статус соединия:

Пример:

UDS.connectBlock = ^(BOOL success, NSString *error) {

};

Блок возвращает следующие параметры:

Переменная Тип Описание
Success BOOL статус соединения
Error NSString тип ошибки

Новое входящее сообщение:

Переменная Тип Описание
incoming BOOL флаг входящего сообщения
outgoing BOOL флаг исходящего сообщения
text NSString текст сообщения
picture_image UIImage изображение
Error NSString тип ошибки

Пример:

UDS.newMessageBlock = ^(BOOL success, RCMessage *message) {
if(message.incoming)
[UDAudio playMessageIncoming];
};

Статус соединия:

UDS.errorBlock = ^(NSArray *errors) {
if(errors.count > 0)
hudErrorConnection.label.text = [errors objectAtIndex:0];
[hudErrorConnection showAnimated:YES];
};
  • Операторы завершили разговор

Блок возвращает следующие параметры:

Переменная Тип Описание
Message RCMessage сообщение с type 4 – пользователь завершил разговор

Пример:

UDS.feedbackMessageBlock =^(RCMessage *message) {
};

Author

Maxim, [email protected]

License

Use_Desk_iOS_SDK is available under the MIT license. See the LICENSE file for more info.