Клас HCOptions у Android SDK надає гнучкі можливості для налаштування та кастомізації віджета чату. Розробники можуть використовувати цей клас для точного налаштування поведінки, зовнішнього вигляду та функціональності віджета відповідно до своїх потреб.

Клас HCOptions.Builder допомагає налаштовувати та створювати екземпляр HCOptions у зручний та структурований спосіб. Він використовує патерн Builder, що дозволяє покроково викликати методи для зручного налаштування.

Підтримка типів файлів

Ви можете налаштувати типи файлів, які користувачі можуть надсилати через чат, використовуючи функцію setMimeTypes(mimeTypes: Array<String>).

Типи файлів, що підтримуються за замовчуванням:

• Документи: .doc, .docx, .pdf
• Презентації: .ppt, .pptx
• Таблиці: .xls, .xlsx
• Інші: .zip, .apk та інші

Налаштування форми чату

Налаштуйте форму чату для збору інформації про користувачів перед тим, як вони надішлють перше повідомлення. Використовуйте функцію setPreChatForm(formSettings: HCPreChatForm) для керування цією формою.

Детальніше дивіться у статті: Установіть форму чату для свого віджета

Налаштування теми

Ви можете налаштувати зовнішній вигляд віджета чату, використовуючи функцію setTheme(theme: HCTheme) разом із моделлю HCTheme.

Детальніше дивіться у статті: Налаштуйте віджет чату

Типи відображення чату

Налаштуйте, як віджет чату відображатиме свій початковий стан, за допомогою функції setChatViewType(chatViewType: HcChatViewType). Ця функція визначає, що користувач побачить спершу при відкритті віджета.

Ви можете перевизначити (override) стандартні налаштування застосунку з вашого облікового запису HelpCrunch. Оберіть один із варіантів:

• HcChatViewType.CHAT_ONLY
  Відображає лише екран чату. База знань недоступна.

• HcChatViewType.CHAT_FIRST
  Спочатку відкриває екран чату. База знань доступна, якщо вона існує.

• HcChatViewType.KB_ONLY
  Відображає лише базу знань. Екран чату недоступний.

• HcChatViewType.KB_FIRST
  Спочатку відкриває базу знань (якщо доступна). Екран чату залишається доступним.

Зразок коду

Цей код на Kotlin налаштовує екземпляр HCOptions для кастомізації віджета чату з такими параметрами:

1. Передача файлів: дозволяє лише зображення PNG та файли ZIP.
2. Тема: застосовує світлу тему до інтерфейсу чату.
3. Форма чату: вимагає від користувачів введення Імені та Email перед початком чату.
4. Відображення чату: використовує власне налаштування інтерфейсу, визначене через HcChatViewType.CUSTOM.

val options = HCOptions.build {
    setMimeTypes(arrayOf("image/png", "application/zip")) // Allow PNG and ZIP file uploads
    setTheme(HCTheme.Builder(HCTheme.Type.DARK).build()) // Apply a dark theme to chat
    setPreChatForm(HCPreChatForm.build { 
            withField(
                attributeName = "name",
                hint = "Name",
                isRequired = true
            )
            withField(
                attributeName = "email",
                hint = "Email",
                isRequired = true,
                inputType = InputType.TYPE_TEXT_VARIATION_EMAIL_ADDRESS,
                validationRegex = EMAIL_PATTERN
            )
            withField(
                attributeName = "phone",
                hint = "Phone",
                isRequired = false,
                inputType = InputType.TYPE_CLASS_PHONE,
                validationRegex = PHONE_PATTERN
            )
        })
    setChatViewType(HcChatViewType.KB_FIRST) // Open KB screen by default
}