Методы базы знаний
Методы базы знаний
Получение разделов базы знаний:
возвращает массив разделов - [BaseCollection]
Пример:
usedesk.getCollections(connectionStatus: {success, collections, error
})
Получение статьи:
возвращает класс статьи - Article
| Переменная | Тип | Описание |
|---|---|---|
| articleID | Int | идентификатор статьи |
Пример:
usedesk?.getArticle(articleID: id, connectionStatus: { success, article, error
})
Получение результатов поиска статьи:
возвращает класс результата поиска - SearchArticle
| Переменная | Тип | Описание |
|---|---|---|
| collection_ids | [Int] | id разделов через запятую |
| category_ids | [Int] | id категорий через запятую |
| article_ids | [Int] | id статей через запятую |
| count | Int | Количество статей на страницу (максимум: 100, по умолчанию: 20) |
| page | Int | Страница (по умолчанию 1) |
| query | String | Поисковая строка запроса, которая ищет по заголовку и тексту статьи |
| type | TypeArticle(.all .open .close) | выводятся все статьи. Если статья публичная, но находится в приватной категории, то при запросе с type=open она не выведется, т.к будет считаться приватной из-за родительской категории |
| sort | SortArticle (.id .title .category_id .public .created_at) | Параметр, по которому сортируются статьи |
| order | OrderArticle (.asc .desc) | Порядок сортировки по параметру sort. по умолчанию: asc Варианты: asc - по возрастанию, desc - по убыванию |
Пример:
usedesk.getSearchArticles(collection_ids: [collection_ids], category_ids: [category_ids], article_ids: [], query: "searchText", type: .all, sort: .title, order: .asc) { (success, searchArticle, error)
})
Добавление просмотра статье:
| Переменная | Тип | Описание |
|---|---|---|
| articleID | Int | идентификатор статьи |
| count | Int | количество просмотров |
Пример:
usedesk.addViewsArticle(articleID: id, count: 1, connectionStatus: { success, error in
})