LTMobileSDK

Superclass:
NSObject
Declared In:

Introduction

WARNING:

Запросы выполняются асинхронно относительно вызывающего потока в параллельном потоке рабочей последовательной очереди SDK (serial queue) с использованием механизма Grand Central Dispatch и библиотеки libdispatch. Блоки success и failure вызываются в GCD-очереди, передаваемой при инициализации объекта SDK с помощью поля callbackQueue класса LTMobileSDKInitializationParams. По умолчанию - это последовательная очередь, ассоциированая с главным потоком и подготавливается вызовом функции библиотеки libdispatch dispatch_get_main_queue()


Methods

-abuseWithAbuse:success:failure:
-closeWithSuccess:failure:
-confirmTextMessageWithId:success:failure:
-createOfflineConversationForVisitor:forDepartmentId:success:failure:
-getDepartmentEmployees:success:failure:
-getDepartments:success:failure:
-getEmployees:success:failure:
-getStateWithSuccess:failure:
-messageHistory:offset:success:failure:
-messageListForConversationId:success:failure:
-offlineConversationsListWithSuccess:failure:
-requestWithDepartment:dialodAttributes:success:failure:
-requestWithDepartment:success:failure:
-requestWithDialogAttributes:success:failure:
-requestWithEmployee:dialodAttributes:success:failure:
-requestWithEmployee:success:failure:
-requestWithSuccess:failure:
-sendMessage:success:failure:
-sendOfflineMessageWithText:conversationId:success:failure:
-setVisitorName:success:failure:
-stop
-typingWithTypingMessage:success:failure:
-uploadFileData:recipientId:success:failure:
-uploadOfflineFileData:conversationId:success:failure:
-voteWithVote:success:failure:

abuseWithAbuse:success:failure:

- (void)abuseWithAbuse:(LTSAbuse *)abuse success:(void(^)())success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
abuse

данные жалобы

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае отсутствия текущего диалога.

Discussion

Жалоба на диалог с собеседником.

closeWithSuccess:failure:

- (void)closeWithSuccess:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае отсутствия текущего диалога.

Discussion

Прекращение диалога с собеседником.

confirmTextMessageWithId:success:failure:

- (void)confirmTextMessageWithId:(LTSTextMessageId)textMessageId 
        success:(void(^)())success failure:(void(^)(NSException *error))failure;
Parameters
textMessageId

индетификатор полученного сообщеиня.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

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

createOfflineConversationForVisitor:forDepartmentId:success:failure:

- (void)createOfflineConversationForVisitor:(LTSOfllineVisitorContacts *)contacts 
        forDepartmentId:(NSString *)depId success:(void(^)(NSString *conversationId))success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
LTSOfllineVisitorContacts

структура контактов для посетителя, поля струткуры опциональны

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

Создание оффлайн обращения с указанием контактных данных.

getDepartmentEmployees:success:failure:

- (void)getDepartmentEmployees:(LTSDepartment *)department 
        success:(void(^)(NSArray *operators))success failure:(void(^)(NSException *error))failure;
Parameters
department

депертамент, операторы которого будут получены

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. operators список операторов для указанного депертамента. ChatException ошибка сервиса чата.

Discussion

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

getDepartments:success:failure:

- (void)getDepartments:(LTSStatus)status success:(void(^)(NSArray *departments))success 
        failure:(void(^)(NSException *error))failure;
Parameters
status

интересующий статус.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. departments список департаментов с указанным статусом. ChatException ошибка сервиса чата.

Discussion

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

getEmployees:success:failure:

- (void)getEmployees:(LTSStatus)status success:(void(^)(NSArray *operators))success 
        failure:(void(^)(NSException *error))failure;
Parameters
status

интересующий статус.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. operators список операторов с указанным статусом. ChatException ошибка сервиса чата.

Discussion

Получение списка операторов с указанным статусом.

getStateWithSuccess:failure:

- (void)getStateWithSuccess:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. state текущее состояние интерфейса клиента сервиса диалога. ChatException ошибка сервиса чата.

Discussion

Получение текущего состояния интерфейса клиента сервиса диалога.

messageHistory:offset:success:failure:

- (void)messageHistory:(int16_t)limit offset:(int16_t)offset 
        success:(void(^)(NSArray *messages))success failure:(void(^)(NSException *ChatException))failure;
Parameters
limit

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

offset

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

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. messages список сообщений истории чата ChatException ошибка сервиса чата.

Discussion

Получение истории сообщений диалога.

messageListForConversationId:success:failure:

- (void)messageListForConversationId:(NSString *)conversationId 
        success:(void(^)(NSArray *messages))success failure:(void(^)(NSException *ChatException))failure;
Parameters
cid

индетификатор оффлайн диалога

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success с параметром messages (список оффлайн сообщений) для оффлайн обращения, тип данных одного элемента LTSOfflineMessage, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

Получение списка оффлайн сообщений для оффлайн обращения.

offlineConversationsListWithSuccess:failure:

- (void)offlineConversationsListWithSuccess:(void(^)(NSArray *conversations))success 
        failure:(void(^)(NSException *ChatException))failure;
Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success с параметром conversations (список оффлайн обращений) для посетителя, тип данных одного элемента LTSOfflineConversation, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

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

requestWithDepartment:dialodAttributes:success:failure:

- (void)requestWithDepartment:(LTSDepartmentId)departmentId 
        dialodAttributes:(LTSDialogAttributes*)atrributes success:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
department

департамент, с оператом которого необходимо начать диалог.

attributes

данные сопутствующие диалогу.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае неверных атрибутов диалога или при указании невалидного депертамента.

Discussion

Запрос диалога с операторами указанного департамента.

requestWithDepartment:success:failure:

- (void)requestWithDepartment:(LTSDepartmentId)departmentId 
        success:(void(^)(LTSDialogState *state))success failure:(void(^)(NSException *ChatException))failure;
Parameters
department

департамент, с оператом которого необходимо начать диалог.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать при указании невалидного депертамента.

Discussion

Запрос диалога с операторами указанного департамента.

requestWithDialogAttributes:success:failure:

- (void)requestWithDialogAttributes:(LTSDialogAttributes*)atrributes 
        success:(void(^)(LTSDialogState *state))success failure:(void(^)(NSException *ChatException))failure;
Parameters
attributes

данные сопутствующие диалогу.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае неверных атрибутов диалога.

Discussion

Запрос диалога с конкретным оператором.

requestWithEmployee:dialodAttributes:success:failure:

- (void)requestWithEmployee:(LTSEmployeeId)employeeId 
        dialodAttributes:(LTSDialogAttributes*)atrributes success:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
mOperator

оператор, к которым необходимо начать диалог.

attributes

данные сопутствующие диалогу.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае неверных атрибутов диалога или при указании невалидного оператора.

Discussion

Запрос диалога с конкретным оператором.

requestWithEmployee:success:failure:

- (void)requestWithEmployee:(LTSEmployeeId)employeeId success:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
mOperator

оператор, к которым необходимо начать диалог.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае неверных атрибутов диалога или при указании невалидного оператора.

Discussion

Запрос диалога с конкретным оператором.

requestWithSuccess:failure:

- (void)requestWithSuccess:(void(^)(LTSDialogState *state))success 
        failure:(void(^)(NSException *ChatException))failure;
Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK.

Discussion

Запрос диалога с конкретным оператором.

sendMessage:success:failure:

- (void)sendMessage:(NSString*)text success:(void(^)(LTSTextMessage *message))success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
message

текст сообщения.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. message созданое сервером сообщение. ChatException ошибка сервиса чата. Может возникать в случае отсутствия текущего диалога.

Discussion

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

sendOfflineMessageWithText:conversationId:success:failure:

- (void)sendOfflineMessageWithText:(NSString *)text 
        conversationId:(NSString *)conversationId success:(void(^)())success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
text

текст сообщения

conversationId

идентификатор оффлайн диалога

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

Отправка оффлайн сообщения для оффлайн обращения.

setVisitorName:success:failure:

- (void)setVisitorName:(NSString *)name success:(void(^)())success 
        failure:(void(^)(NSException *error))failure;
Parameters
name

имя посетителя.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата.

Discussion

Установка имени посетителя.

stop

- (void)stop;
Discussion

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

typingWithTypingMessage:success:failure:

- (void)typingWithTypingMessage:(LTSTypingMessage*)message 
        success:(void(^)())success failure:(void(^)(NSException *ChatException))failure;
Parameters
message

набранное сообщение.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае отсутствия текущего диалога.

Discussion

Оповещение о наборе текста.

uploadFileData:recipientId:success:failure:

- (void) uploadFileData: (LTSFile *) file recipientId: (NSString *) resId 
        success: (void(^)()) success failure: (void(^)(NSException *ChatException)) failure;
Discussion

Отправка файла в режиме онлайн.

uploadOfflineFileData:conversationId:success:failure:

-(void) uploadOfflineFileData:(LTSFile *) file conversationId:(NSString *) resId 
        success:(void(^)()) success failure:(void(^)(NSException *ChatException)) failure;
Discussion

Отправка файла в режиме оффлайн.

voteWithVote:success:failure:

- (void)voteWithVote:(LTSVoteType)vote success:(void(^)())success 
        failure:(void(^)(NSException *ChatException))failure;
Parameters
vote

оценка собеседника.

Return Value

Вызов колбек-блока соответствующего результату. При успешном выполнении запроса вызывается колбек-блок success, параметром у которого является объект типа LTSDialogState - состояние текущего обращения, в противном случае вызывается failure, параметром у которого явлется объект типа NSExeption пойманый при выполнии операции в параллельном потоке очереди SDK. ChatException ошибка сервиса чата. Может возникать в случае отсутствия текущего диалога.

Discussion

ПОценка диалога с собеседником.

Properties

delegate

delegate

@property(nonatomic,
    weak) id <LTMobileSDKNotificationHandlerProtocol> delegate;
Discussion

Делегат для получения уведомлений сервисов offline/online обращений при рабочем состоянии SDK. Делегат должен реализовать методы LTMobileSDKNotificationHandlerProtocol

 

Last Updated: Monday, August 31, 2015