Функція showKbScreen дозволяє відобразити екран бази знань (KB - Knowledge Base) у вашому застосунку, надаючи користувачам швидкий доступ до статей і ресурсів. Ця функція є гнучкою у налаштуванні та підтримує локалізацію, кастомні опції та зворотні виклики для обробки взаємодії з користувачем.
Сигнатура функції
@JvmStatic
@JvmOverloads
fun showKbScreen(
articleUrl: String,
forceApplyLocaleFromUrl: Boolean = false,
options: HCOptions? = null,
callback: Callback<Any?>? = null
)Параметри
| Параметр | Тип | Дефолтне занчення | Опис |
|---|---|---|---|
| articleUrl | String | Required | URL-адреса статті, яка має відобразитися на екрані Бази знань. |
| forceApplyLocaleFromUrl | Boolean | false | Якщо true, SDK примусово застосує локаль відповідно до зазначеної в articleUrl. |
| options | HCOptions? | null | Опціональна модель HCOptions для кастомізації зовнішнього вигляду та поведінки екрана Бази знань. |
| callback | Callback<Any?>? | null | Опціональний зворотний виклик для обробки подій, пов’язаних із відкриттям екрана Бази знань. |
Приклади використання
Базове використання
Відкриття статті Бази знань без додаткових налаштувань:
HelpCrunch.showKbScreen(
articleUrl = "https://docs.helpcrunch.com/en/android-sdk/add-helpcrunch-android-sdk-to-your-app"
)Застосування локалі на основі URL статті
Примусове відображення статті відповідно до локалі, зазначеної в articleUrl:
HelpCrunch.showKbScreen(
articleUrl = "https://docs.helpcrunch.com/en/android-sdk/add-helpcrunch-android-sdk-to-your-app",
forceApplyLocaleFromUrl = true
)Кастомізація екрана Бази знань за допомогою HCOptions
Подібно до відкриття чату, ви можете налаштувати екран Бази знань за допомогою HCOptions:
val options = HCOptions.build {
setTheme(HCTheme.Builder(HCTheme.Type.DARK).build()) // Apply dark mode
setArticlesLocalizedPreviewEnabled(true) // Enable localized KB previews in chat
}
HelpCrunch.showKbScreen(
articleUrl = "https://docs.helpcrunch.com/en/android-sdk/add-helpcrunch-android-sdk-to-your-app",
options = options
)