Категории

Методы Базы Знаний

Методы класса UsedeskKnowledgeBaseSdk

1. Метод установки конфигурации
fun setConfiguration(knowledgeBaseConfiguration: UsedeskKnowledgeBaseConfiguration)

Аргументы:

Название Тип Описание
knowledgeBaseConfiguration UsedeskKnowledgeBaseConfiguration Конфигурация Базы Знаний

Пример:

UsedeskKnowledgeBaseSdk.setConfiguration(knowledgeBaseConfiguration)
2. Метод получения конфигурации
fun requireConfiguration(): UsedeskKnowledgeBaseConfiguration

Пример:

val knowledgeBaseConfiguration= UsedeskKnowledgeBaseSdk.requireConfiguration()
3. Метод инициализации Базы Знаний
fun init(context: Context): IUsedeskKnowledgeBase

Аргументы:

Название Тип Описание
context Context Контекст

Пример:

val usedeskKnowledgeBase = UsedeskKnowledgeBaseSdk.init(requireContext())
4. Метод получения экземпляра Базы Знаний
fun getInstance(): IUsedeskKnowledgeBase

Пример:

val usedeskKnowledgeBase = UsedeskKnowledgeBaseSdk.getInstance()
5. Метод освобождения ресурсов Базы Знаний
fun release()

Пример:

UsedeskKnowledgeBaseSdk.release()

Методы класса IUsedeskKnowledgeBase

1. Получение списка разделов

fun getSections(): List
fun getSectionsRx(): Single>

Пример:

val sections = usedeskKnowledgeBase.getSections()
usedeskKnowledgeBase.getSectionsRx().subscribe({ sections ->
    //loaded
}, { throwable ->
    throwable.printStackTrace()
})
2. Получение списка категорий

fun getCategories(sectionId: Long): List
fun getCategoriesRx(sectionId: Long): Single>

Аргументы:

Название Тип Описание
sectionId Long ID раздела

Пример:

val categories = usedeskKnowledgeBase.getCategories(sectionId)
usedeskKnowledgeBase.getCategoriesRx(sectionId).subscribe({ categories ->
    //loaded
}, { throwable ->
    throwable.printStackTrace()
})
3. Получение списка статей
fun getArticles(categoryId: Long): List
fun getArticlesRx(categoryId: Long): Single>

Аргументы:

Название Тип Описание
categoryId Long ID категории

Пример:

val articles = usedeskKnowledgeBase.getArticles(categoryId)
usedeskKnowledgeBase.getArticlesRx(categoryId).subscribe({ articles ->
    //loaded
}, { throwable ->
    throwable.printStackTrace()
})
4. Поиск статей

fun getArticles(searchQuery: String): List
fun getArticlesRx(searchQuery: String): Single>

Аргументы:

Название Тип Описание
searchQuery String Текстовый поисковой запрос

Пример:

val articles = usedeskKnowledgeBase.getArticles(searchQuery)
usedeskKnowledgeBase.getArticlesRx(searchQuery).subscribe({ articles ->
    //loaded
}, { throwable ->
    throwable.printStackTrace()
})
5. Получить данные статьи
fun getArticle(articleId: Long): UsedeskArticleContent
fun getArticleRx(articleId: Long): Single

Аргументы:

Название Тип Описание
articleId Long ID статьи

Пример:

val article = usedeskKnowledgeBase.getArticle(articleId)
usedeskKnowledgeBase.getArticleRx(articleId).subscribe({ article ->
    //loaded
}, { throwable ->
    throwable.printStackTrace()
})
6. Добавить просмотр статье
fun addViews(articleId: Long)
fun addViewsRx(articleId: Long): Completable

Аргументы:

Название Тип Описание
articleId Long ID статьи

Пример:

usedeskKnowledgeBase.addViews(articleId)
usedeskKnowledgeBase.addViewsRx(articleId).subscribe({
    //completed
}, { throwable ->
    throwable.printStackTrace()
})
7. Поставить оценку статье
fun sendRating(articleId: Long, good: Boolean)
fun sendRatingRx(articleId: Long, good: Boolean): Completable

Аргументы:

Название Тип Описание
articleId Long ID статьи
good Boolean Положительный (true) или отрицательный (false) отзыв

Пример:

usedeskKnowledgeBase.sendRating(articleId, good)
usedeskKnowledgeBase.sendRatingRx(articleId, good).subscribe({
    //completed
}, { throwable ->
    throwable.printStackTrace()
})
8. Оставить отзыв о статье
fun sendRating(articleId: Long, message: String)
fun sendRatingRx(articleId: Long, message: String): Completable

Аргументы:

Название Тип Описание
articleId Long ID статьи
message String Текст отзыва

Пример:

usedeskKnowledgeBase.sendRating(articleId, message)
usedeskKnowledgeBase.sendRatingRx(articleId, message).subscribe({
    //completed
}, { throwable ->
    throwable.printStackTrace()
})