LCCoreService.h

Introduction

Use the links in the table of contents to the left to access the documentation.

Classes

LCConversation
LCDepartment
LCDestination
LCDialogAttributes
LCDialogState
LCEmployee
LCFileMessage
LCMessage
LCMessageAttributes
LCSendMessageResponse
LCTextMessage
LCTouchPoint
LCTyping

Protocols

LCCoreServiceDelegate

Methods

+confirmMessageWithID:completionHandler:: Подтверждение получения сообщения пользователем.
+destinationsWithCompletionHandler:: Получение списка назначений
+initWithURL:appID:appKey:token:deviceToken:callbackQueue:delegateQueue:: Инициализирует и возвращает объект LCCoreService с указанными параметрами
+invalidateService: Аннулирование сервиса и всех его параметров.
+messageHistory:offset:completionHandler:: Получение истории сообщений
+resetService: Сброс сервиса.
+sendFileMessage:completionHandler:: Отправляет файловое сообщение оператору. Оператору сообщение приходит в виде ссылки на объект.
+sendTextMessage:completionHandler:: Отправляет текстовое сообщение оператору
+setDestination:attributes:completionHandler:: Устанавливает на кого будет назначаться обращение пользователя(оператор, точка контакта, департамент)
+setTyping:completionHandler:: Оповещает оператора о наборе текста посетителем
+setVisitor:completionHandler:: Устанавливает имя посетителя
+startServiceWithCompletionHandler:: Запускает работу сервиса
+stateWithCompletionHandler:: Получение текущего состояния диалога

confirmMessageWithID:completionHandler:

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

- (void)confirmMessageWithID:(NSString *)messageID 
        completionHandler:(void (^)(BOOL success, NSError * __nullable error))completionHandler;

Parameters

messageID: Идентификатор сообщения
completionHandler: Блок, который вызывается после выполнения функции

Discussion

В случае успешного выполнения функции вызовется блок completionHandler с параметром "success" равным "true", в противном случае с ошибкой

destinationsWithCompletionHandler:

Получение списка назначений

- (void)destinationsWithCompletionHandler:(void (^)(NSArray<LCDestination *> * __nullable destinations, NSError * __nullable error))completionHandler;

Parameters

completionHandler: Блок, который вызывается после выполнения функции

Discussion

В случае успешного выполнения функции вызовется блок completionHandler с массивом назначений, в противном случае с ошибкой

initWithURL:appID:appKey:token:deviceToken:callbackQueue:delegateQueue:

Инициализирует и возвращает объект LCCoreService с указанными параметрами

- (instancetype)initWithURL:(nonnull NSString *)URL appID:(nonnull NSString *)appID 
        appKey:(nonnull NSString *)appKey token:(nullable NSString *)token 
        deviceToken:(nullable NSString *)deviceToken callbackQueue:(nullable NSOperationQueue *)callbackQueue 
        delegateQueue:(nullable NSOperationQueue *)delegateQueue;

Parameters

URL: Адрес сервера регистрации Livetex
appID: Идентификатор точки контакта
appKey: Ключ приложения
token: Токен системы Livetex
deviceToken: Токен APNS, полученный при регистрации от iOS
callbackQueue: Очередь в которой будут выполняться callback блоки
delegateQueue: Очередь в которой будут выполняться методы LCCoreServiceDelegate

Return Value

Инициализированный объект LCCoreService

Discussion

Все методы объекта LCCoreService выполняются в последовательной очереди. По умолчанию для выполнения callback и delegate методов используется главная очередь, если иное не указано

invalidateService

Аннулирование сервиса и всех его параметров.

- (void)invalidateService;

messageHistory:offset:completionHandler:

Получение истории сообщений

- (void)messageHistory:(NSInteger)limit offset:(NSInteger)offset 
        completionHandler:(void (^)(NSArray<LCMessage *> * __nullable messages, NSError * __nullable error))completionHandler;

Parameters

limit: Количество запрашиваемых сообщений в истории
offset: Количество игнорируемых сообщений в истории
completionHandler: Блок, который вызывается после выполнения функции

Discussion

В случае успешного выполнения функции вызовется блок completionHandler с массивом сообщений, в противном случае с ошибкой

resetService

Сброс сервиса.

+ (void)resetService;

Discussion

Удаление токена последней удачной сессии(startServiceWithCompletionHandler). Каждый раз при работе в системе Livetex сервис использует токен последней удачной сесссии.

sendFileMessage:completionHandler:

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

- (void)sendFileMessage:(NSData *)data completionHandler:(void (^)(LCSendMessageResponse * __nullable response, NSError * __nullable error))completionHandler;

Parameters

data: Данные отправляемого файла
completionHandler: Блок, который вызывается после выполнения функции

Discussion

В случае успешного выполнения функции вызовется блок completionHandler с параметром "response" отличным от nil, в противном случае с ошибкой

sendTextMessage:completionHandler:

Отправляет текстовое сообщение оператору

- (void)sendTextMessage:(NSString *)text completionHandler:(void (^)(LCSendMessageResponse * __nullable response, NSError * __nullable error))completionHandler;

Parameters

text: Текст отправляемого сообщения
completionHandler: Блок, который вызывается после выполнения функции

Discussion

setDestination:attributes:completionHandler:

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

- (void)setDestination:(LCDestination *)destination 
        attributes:(LCDialogAttributes * __nullable)attributes 
        completionHandler:(void (^)(BOOL success, NSError * __nullable error))completionHandler;

Parameters

destination: Назначение
attributes: Атрибуты обращения
completionHandler: Блок, который вызывается после выполнения функции

Discussion

setTyping:completionHandler:

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

- (void)setTyping:(NSString *)text completionHandler:(void (^)(BOOL success, NSError * __nullable error))completionHandler;

Parameters

text: Набираемый текст
completionHandler: Блок, который вызывается после выполнения функции

Discussion

setVisitor:completionHandler:

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

- (void)setVisitor:(NSString *)name completionHandler:(void (^)(BOOL success, NSError * __nullable error))completionHandler;

Parameters

name: Имя посетителя
completionHandler: Блок, который вызывается после выполнения функции

Discussion

startServiceWithCompletionHandler:

Запускает работу сервиса

- (void)startServiceWithCompletionHandler:(void (^)(NSString * __nullable token, NSError * __nullable error))completionHandler;

Parameters

completionHandler: Блок, который вызывается после выполнения функции

Discussion

В случае успешного выполнения функции вызовется блок completionHandler с токеном полученным в системе Livetex, в противном случае с ошибкой

stateWithCompletionHandler:

Получение текущего состояния диалога

- (void)stateWithCompletionHandler:(void (^)(LCDialogState * __nullable state, NSError * __nullable error))completionHandler;

Parameters

completionHandler: Блок, который вызывается после выполнения функции

Discussion

Typedefs

LCTimestamp

LCTimestamp

typedef NSString * LCTimestamp;

Discussion

Количество миллисекунд от начала времен в Unix.

Last Updated: вторник, августа 30, 2016