Методы Базы Знаний
Все методы актуальны для версии 4.7.0.
Методы класса UsedeskKnowledgeBaseSdk
1. Установка конфигурации
fun setConfiguration(knowledgeBaseConfiguration: UsedeskKnowledgeBaseConfiguration)
2. Получение конфигурации
fun requireConfiguration(): UsedeskKnowledgeBaseConfiguration
3. Инициализация Базы знаний
fun init(
context: Context,
configuration: UsedeskKnowledgeBaseConfiguration = requireConfiguration()
): UsedeskKnowledgeBase
Если конфигурация уже установлена через setConfiguration, второй аргумент можно не передавать.
4. Получение экземпляра
fun getInstance(): UsedeskKnowledgeBase?
Возвращает null, если База знаний ещё не инициализирована.
5. Получение экземпляра с проверкой
fun requireInstance(): UsedeskKnowledgeBase
То же, что getInstance(), но бросает исключение, если База знаний не инициализирована.
6. Освобождение ресурсов
fun release()
Методы класса UsedeskKnowledgeBase
Все методы выполняют сетевые запросы и должны быть вызваны не в основном потоке.
Каждый метод возвращает одно из двух значений:
- Done — запрос выполнился успешно, содержит результат;
- Error — запрос выполнился с ошибкой, содержит код ошибки, если он есть.
| Название | Тип | Описание |
|---|---|---|
| getSections() | GetSectionsResponse | Получить список разделов. Done содержит List<UsedeskSection> |
| getArticle(articleId: Long) | GetArticleResponse | Получить статью по идентификатору. Done содержит UsedeskArticleContent |
| getArticles(query: String, page: Long) | GetArticlesResponse | Поиск статей по запросу с постраничной загрузкой. Done содержит List<UsedeskArticleContent> |
| addViews(articleId: Long) | AddViewsResponse | Засчитать просмотр статьи. Done содержит новое количество просмотров |
| sendRating(articleId: Long, good: Boolean) | SendRatingResponse | Оценить статью. Done содержит количество положительных и отрицательных оценок |
| sendReview(subject: String, message: String) | SendReviewResponse | Отправить отзыв о статье |