ChatKit: Пользовательские бизнес-процессы

#warning Внимание: метод setFetchProfilesBlock должен быть реализован, иначе ChatKit не сможет отображать аватары и псевдонимы пользователей. Ниже представлен цикл, который имитирует синхронное получение информации о пользователях по userIds. Этот код должен быть заменен на вызов API вашего приложения для синхронного запроса.
```    [[LCChatKit sharedInstance] setFetchProfilesBlock:^(NSArray<NSString *> *userIds, LCCKFetchProfilesCompletionHandler completionHandler) {
        if (userIds.count == 0) {
            NSInteger code = 0;
            NSString *errorReasonText = @"Пользовательские идентификаторы отсутствуют";
            NSDictionary *errorInfo = @{
                                        @"code" : @(code),
                                        NSLocalizedDescriptionKey : errorReasonText,
                                        };
            NSError *error = [NSError errorWithDomain:@"LCChatKitExample"
                                                 code:code
                                             userInfo:errorInfo];
            !completionHandler ?: completionHandler(nil, error);
            return;
        }
        
        NSMutableArray *users = [NSMutableArray arrayWithCapacity:userIds.count];
#warning Внимание: ниже представлен цикл, который имитирует синхронное получение информации о пользователях по userIds. Этот код должен быть заменен на вызов API вашего приложения для синхронного запроса.```markdown
#warning Важно: блок completionHandler должен быть выполнен после **получения информации о пользователе**. 
        !completionHandler ?: completionHandler([users copy], nil);
    }];

[LCCKUser userWithUserId:user[LCCKProfileKeyPeerId]
          name:user[LCCKProfileKeyName]
          avatarURL:avatarURL
          clientId:clientId];

При взаимодействии ChatKit с сервером используется только ClientId, но для отображения информации о пользователе в интерфейсе требуется информация из вашей системы пользователей. В этом случае ChatKit вызывает `FetchProfilesBlock`, чтобы получить информацию о пользователе, в основном для получения аватара и имени пользователя.
```Например, в коде выше `userIds` соответствуют `ClientIds`, а `LCCKProfileKeyPeerId` — `UserId` системы пользователей приложения. Все `UserId` и `PeerId`, определенные в интерфейсе `ChatKit`, кроме `userId` в `LCCKUserDelegate`, являются `ClientIds` (если это определенно другой пользователь, а не сам пользователь, например, в списке контактов или в диалоге, используется `PeerId` вместо `UserId`). Рекомендуется устанавливать `UserId` системы пользователей приложения напрямую как `ClientId`. Если `UserId` и `ClientId` не совпадают, необходимо добавить шаги преобразования `clientIds` в `userIds` в методе `-setFetchProfilesBlock:`, а затем использовать `userIds` для вызова API системы пользователей приложения для выполнения запросов.## Кэш профиля```При успешном получении пользователем своего аватара и псевдонима, ChatKit кэширует профиль в памяти. В отношении кэширования профиля (локальное кэширование пока не реализовано, см. обсуждение в [issue](https://github.com/leancloud/ChatKit-OC/issues/28)), если пользователь изменил свой аватар или псевдоним, разработчик должен вызвать соответствующий метод очистки кэша ChatKit для получения нового профиля.```Objective-C
- (void)removeCachedProfileForPeerId:(NSString *)peerId;
- (void)removeAllCachedProfiles;

    [[LCChatKit sharedInstance] setOpenProfileBlock:^(NSString *userId, id<LCCKUserDelegate> user, __kindof UIViewController *parentController) {
        if (!userId) {
            [LCCKUtil showNotificationWithTitle:@"Пользователь не найден" subtitle:nil type:LCCKMessageNotificationTypeError];
            return;
        }
        [self exampleOpenProfileForUser:user userId:userId parentController:parentController];
    }];
    
    - (void)exampleOpenProfileForUser:(id<LCCKUserDelegate>)user userId:(NSString *)userId parentController:(__kindof UIViewController *)parentController {
    // Можно выполнять различные действия в зависимости от типа чата
    NSString *currentClientId = [LCChatKit sharedInstance].clientId;
    NSString *title = [NSString stringWithFormat:@"Открыть страницу пользователя\nClientId: %@", userId];
    NSString *subtitle = [NSString stringWithFormat:@"Имя: %@", user.name];
    if ([userId isEqualToString:currentClientId]) {
        title = [NSString stringWithFormat:@"Открыть свою страницу\nClientId: %@", userId];
        subtitle = [NSString stringWithFormat:@"Мое имя: %@", user.name];
    } else if ([parentController isKindOfClass:[LCCKConversationViewController class]]) {
            LCCKConversationViewController *conversationViewController_ = [[LCCKConversationViewController alloc] initWithPeerId:user.clientId ?: userId];
            [[self class] pushToViewController:conversationViewController_];
            return;
    }
    [LCCKUtil showNotificationWithTitle:title subtitle:subtitle type:LCCKMessageNotificationTypeMessage];
}

// LCCKConversationViewController.h
/*!
 * Отправка пользовательского сообщения
 */
- (void)sendCustomMessage:(AVIMTypedMessage *)customMessage;

#pragma mark -
#pragma mark - Переопределение методов

#pragma mark -
#pragma mark - Методы AVIMTypedMessageSubclassing

+ (void)load {
    [self registerSubclass];
}

+ (AVIMMessageMediaType)classMediaType {
    return kAVIMMessageMediaTypeVCard;
}

-------------|-------------|-------------
degrade | Определяет, как отображать пользовательские сообщения, которые не поддерживаются в старых версиях | Добавляется в словарь атрибутов пользовательского сообщения
typeTitle | Заголовок последнего сообщения в списке недавних диалогов, например, если последнее сообщение — это изображение, можно установить это поле как `@"Изображение"`, что будет отображаться как `[Изображение]` | Добавляется в словарь атрибутов пользовательского сообщения
summary | Отображается в уведомлении push | Добавляется в словарь атрибутов пользовательского сообщения, используется для удобства настройки содержимого push-уведомлений, что требует использования облачного сервера
conversationType | Отображается в уведомлении push | Добавляется в словарь атрибутов пользовательского сообщения, тип диалога, используется для отображения в уведомлении push, чтобы добиться такого эффекта: `[Групповой чат] Tom: привет, ребята!` | Определяется с помощью перечисления LCCKConversationType, 0 — для личных сообщений, 1 — для групповыхВсе три поля должны быть добавлены в словарь атрибутов пользовательского сообщения. ChatKit предоставляет метод для удобства добавления `-lcck_setObject:forKey:` , который используется следующим образом:

```Objective-C
/*!
 *  Три обязательных поля:
 *  - degrade Определяет, как отображать пользовательские сообщения, которые не поддерживаются в старых версиях
 *  - typeTitle Заголовок последнего сообщения в списке недавних диалогов, например, если последнее сообщение — это изображение, можно установить это поле как `@"Изображение"`, что будет отображаться как `[Изображение]`.
 *  - summary Отображается в уведомлении push
 * @attention Обязательно добавьте эти три поля, они используются внутри ChatKit.
 */
- (instancetype)initWithClientId:(NSString *)clientId {
    self = [super init];
    if (!self) {
        return nil;
    }
    [self lcck_setObject:@"Бизнес-карта" forKey:LCCKCustomMessageTypeTitleKey];
    [self lcck_setObject:@"Это бизнес-карта, текущая версия слишком старая для отображения, пожалуйста, обновите приложение для просмотра" forKey:LCCKCustomMessageDegradeKey];
    [self lcck_setObject:@"Вам отправили бизнес-карту, пожалуйста, откройте приложение для просмотра" forKey:LCCKCustomMessageSummaryKey];
    [self lcck_setObject:clientId forKey:@"clientId"];
    return self;
}

#pragma mark -
#pragma mark - Методы протокола LCCKChatMessageCellSubclassing

+ (void)load {
    [self registerCustomMessageCell];
}

+ (AVIMMessageMediaType)classMediaType {
    return kAVIMMessageMediaTypeVCard;
}

- (void)setup;
- (void)configureCellWithData:(AVIMTypedMessage *)message;

- (CGSize)sizeThatFits:(CGSize)size {
    return CGSizeMake(size.width, A + B + C + D + E + ...);
}

Для определения нажатия на пользовательский Cell необходимо самостоятельно определить и отреагировать на это в пользовательском Cell. В демо используется добавление тап-геста.

### Пользовательский плагин для ввода
Использование аналогично пользовательскому сообщению и пользовательскому Cell:
Наследуйте `LCCKInputViewPlugin`, следуйте и реализуйте протокол `LCCKInputViewPluginSubclassing`:

```Objective-C
#pragma mark -
#pragma mark - LCCKInputViewPluginSubclassing Method

+ (void)load {
    [self registerCustomInputViewPlugin];
}

+ (LCCKInputViewPluginType)classPluginType {
    return LCCKInputViewPluginTypeVCard;
}

#pragma mark -
#pragma mark - LCCKInputViewPluginDelegate Method

/**
 * Иконка плагина
 */
- (UIImage *)pluginIconImage {
    return [self imageInBundlePathForImageName:@"chat_bar_icons_location"];
}
``````markdown
/**
 * Название плагина
 */
- (NSString *)pluginTitle {
    return @"Визитка";
}

/**
 * Пользовательский интерфейс плагина, который будет загружен на inputView
 */
- (UIView *)pluginContentView {
    return nil;
}

/**
 * Пользовательский интерфейс плагина был выбран и запущен
 */
- (void)pluginDidClicked {
    [super pluginDidClicked];
    [self presentSelectMemberViewController];
}

/**
 * Обработчик отправки пользовательского сообщения
 */
- (LCCKIdResultBlock)sendCustomMessageHandler {
    if (_sendCustomMessageHandler) {
        return _sendCustomMessageHandler;
    }
    LCCKIdResultBlock sendCustomMessageHandler = ^(id object, NSError *error) {
        LCCKVCardMessage *vCardMessage = [LCCKVCardMessage vCardMessageWithClientId:object];
        [self.conversationViewController sendCustomMessage:vCardMessage progressBlock:^(NSInteger percentDone) {
        } success:^(BOOL succeeded, NSError *error) {
            [self.conversationViewController sendLocalFeedbackTextMessage:@"Визитка отправлена"];
        } failed:^(BOOL succeeded, NSError *error) {
            [self.conversationViewController sendLocalFeedbackTextMessage:@"Визитка не отправлена"];
        }];
        // важно: избегайте циклической ссылки!
        _sendCustomMessageHandler = nil;
    };
    _sendCustomMessageHandler = sendCustomMessageHandler;
    return sendCustomMessageHandler;
}

### Удаление персонализированных плагинов, сообщений и ячеек

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

```Objective-C
+ (void)load {
    [self registerCustomInputViewPlugin];
}

+ (void)load {
    [self registerSubclass];
}

+ (void)load {
    [self registerCustomMessageCell];
}

Используя интерфейс `-[LCChatKit setFilterMessagesBlock:]`, можно перехватить новые сообщения, включая реальные сообщения и сообщения из истории.

В демонстрационном примере показано, как реализовать групповые целевые сообщения:```Objective-C
- (instancetype)initWithClientId:(NSString *)clientId conversationType:(LCCKConversationType)conversationType {
    self = [super init];
    if (!self) {
        return nil;
    }
    [self lcck_setObject:@"Визитка" forKey:LCCKCustomMessageTypeTitleKey];
    [self lcck_setObject:@"Это сообщение визитки, текущая версия слишком старая для отображения, попробуйте обновить приложение для просмотра" forKey:LCCKCustomMessageDegradeKey];
    [self lcck_setObject:@"Кто-то отправил вам сообщение визитки, пожалуйста, откройте приложение для просмотра" forKey:LCCKCustomMessageSummaryKey];
    [self lcck_setObject:@(conversationType) forKey:LCCKCustomMessageConversationTypeKey];
    [self lcck_setObject:clientId forKey:@"clientId"];
    //Целевое сообщение для группы, видимо только для части пользователей, необходимо реализовать `-setFilterMessagesBlock:`, подробнее см. LCChatKitExample
    [self lcck_setObject:@[ @"Том", @"Джерри"] forKey:LCCKCustomMessageOnlyVisiableForPartClientIds];
    return self;
}
``````Objective-C
    [[LCChatKit sharedInstance] setFilterMessagesBlock:^(AVIMConversation *conversation, NSArray<AVIMTypedMessage *> *messages, LCCKFilterMessagesCompletionHandler completionHandler) {
        if (conversation.lcck_type == LCCKConversationTypeSingle) {
            completionHandler(messages ,nil);
            return;
        }
        // групповой чат
        NSMutableArray *filterMessages = [NSMutableArray arrayWithCapacity:messages.count];
        for (AVIMTypedMessage *typedMessage in messages) {
            if ([typedMessage.clientId isEqualToString:[LCChatKit sharedInstance].clientId]) {
                [filterMessages addObject:typedMessage];
                continue;
            }
            NSArray *visiableForPartClientIds = [typedMessage.attributes valueForKey:LCCKCustomMessageOnlyVisiableForPartClientIds];
            if (!visiableForPartClientIds) {
                [filterMessages addObject:typedMessage];
            } else if (visiableForPartClientIds.count > 0) {
                BOOL visiableForCurrentClientId = [visiableForPartClientIds containsObject:[LCChatKit sharedInstance].clientId];
                if (visiableForCurrentClientId) {
                    [filterMessages addObject:typedMessage];
                } else {
                    typedMessage.text = @"Это групповое сообщение, видимое только некоторым участникам";
                    typedMessage.mediaType = kAVIMMessageMediaTypeText;
                    [filterMessages addObject:typedMessage];
                }
            }
        }
        completionHandler([filterMessages copy] ,nil);
    }];

    // Замените стиль предварительного просмотра изображений по умолчанию
    [[LCChatKit sharedInstance] setPreviewImageMessageBlock:^(NSUInteger index, NSArray *allVisibleImages, NSArray *allVisibleThumbs, NSDictionary *userInfo) {
        [self examplePreviewImageMessageWithInitialIndex:index allVisibleImages:allVisibleImages allVisibleThumbs:allVisibleThumbs];
    }];
```#### Предварительный просмотр местоположения

Вы можете настроить предварительный просмотр местоположения с помощью метода `[LCChatKit setPreviewLocationMessageBlock:]`:

```Objective-C
[[LCChatKit sharedInstance] setPreviewLocationMessageBlock:^(CLLocation *location, NSString *geolocations, NSDictionary *userInfo) {
    [self examplePreViewLocationMessageWithLocation:location geolocations:geolocations];
}];

// Если используется другой стиль, необходимо реализовать этот блок для установки значка Badge.
[[LCChatKit sharedInstance] setMarkBadgeWithTotalUnreadCountBlock:^(NSInteger totalUnreadCount, UIViewController *controller) {
    [self exampleMarkBadgeWithTotalUnreadCount:totalUnreadCount controller:controller];
}];