API提供程序参考
API提供程序参考
支持SDK有以下API提供程序:
每个提供程序都有许多方法，可以让您访问票据或帮助中心资源。亚博电脑端
样例应用程序
我们有一些示例应用程序Github上演示了如何以不同的方式使用Zendesk移动sdk。亚博在与API提供程序集成时，它们可以作为有用的参考。
要求供应商
请求提供程序允许您访问支持请求，这些请求在Zendesk中也称为票据。亚博提供程序有以下方法:
- 都会
- getRequestById
- getAllRequestsWithCallback
- getRequestsByStatus
- getCommentsWithRequestId
- addComment
- getTicketFormWithIds}
要创建请求提供程序，请参见ZDKRequestProvider在下面。
ZDKRequestProvider
创建请求提供程序。
斯威夫特
let requestProvider = ZDKRequestProvider()
objective - c
［［ZDKRequestProvider alloc］初始化］；
使用请求提供程序调用本节其余部分中记录的方法。例子:
斯威夫特
provider.createRequest(请求){…}
objective - c
提供者．都会（请求）{．．．}
getRequestById
获取由id指定的请求。
| 名字 | 类型 | 评论 |
|---|---|---|
| requestId | 在Zendesk Support中请求的ID亚博 | |
| 回调 | 返回一个ZDKRequest成功的目标 |
getAllRequestsWithCallback
获取用户打开的所有请求。如果一个访问令牌以前没有被存储，也会获得一个访问令牌。如果您使用匿名身份，它会检查您是否有任何存储的请求id。
| 名字 | 类型 | 评论 |
|---|---|---|
| 回调 | 返回的列表ZDKRequest成功的目标 |
getRequestsByStatus
根据票证状态过滤用户打开的请求。如果一个访问令牌以前没有被存储，也会获得一个访问令牌。
| 名字 | 类型 | 评论 |
|---|---|---|
| 状态 | NSString | 用于筛选结果的以逗号分隔的状态列表 |
| 回调 | 返回的列表ZDKRequestsWithCommentingAgents成功的对象。这包含一个列表ZDKRequests还有一个列表ZDKUsers．这些是对请求发表评论的代理人。 |
getCommentsWithRequestId
获取请求的所有注释。如果之前没有存储过访问令牌，它也会获得访问令牌。
| 名字 | 类型 | 评论 |
|---|---|---|
| requestId | NSString | 票证 |
| 回调 | 成功时返回CommentsResponse模型 |
addComment
向请求添加注释消息。如果一个访问令牌以前没有被存储，也会获得一个访问令牌。
| 名字 | 类型 | 评论 |
|---|---|---|
| 评论 | NSString | 要创建的注释 |
| requestId | NSString | 收到此评论的票证Id |
| 附件 | NSArray | 的列表ZDKUploadResponse对象。可以是零 |
| 回调 | 返回一个ZDKComment成功的目标 |
getTicketFormWithIds
获取指定票据表单的内容。只获取前5个票证表单id。
| 名字 | 类型 | 评论 |
|---|---|---|
| ticketFormIds | NSArray < NSNumber > | 票证表单id的数组 |
| 回调 | 回调要么成功，要么返回错误 |
帮助中心提供商
帮助中心提供程序允许您访问Zendesk指南中的帮助中心资源。亚博电脑端亚博提供程序有以下方法:
- initWithLocale
- getCategoryById
- getSectionById
- getArticleById
- getFlatArticlesWithCallback
- getArticlesByLabels
- getSectionsWithCategoryId
- getArticlesWithSectionId
- searchForArticlesUsingQuery
- searchArticles
- getAttachmentWithArticleId
- submitRecordArticleView
- upvoteArticleWithId
- downvoteArticleWithId
- deleteVoteWithId
要创建帮助中心提供程序，请参见ZDKHelpCenterProvider在下面。
ZDKHelpCenterProvider
创建帮助中心提供程序。
斯威夫特
let helpCenterProvider = ZDKHelpCenterProvider()
objective - c
［［ZDKHelpCenterProvider alloc］初始化］；
使用请求提供程序调用本节其余部分中记录的方法。例子:
斯威夫特
provider.getCategoryById(){…}
objective - c
提供者．getCategoryById（）{．．．}
initWithLocale
创建具有指定区域设置的帮助中心提供程序。
| 名字 | 类型 | 评论 |
|---|---|---|
| 语言环境 | NSString | 帮助中心区域设置，如“de”、“es”或“ja” |
getCategoryById
获取一个类别。
| 名字 | 类型 | 评论 |
|---|---|---|
| 被标记 | NSString | 帮助中心类别的id |
| 回调 | 成功时返回一个类别对象 |
getSectionById
获取一个section。
| 名字 | 类型 | 评论 |
|---|---|---|
| sectionId | NSString | 帮助中心部分的id |
| 回调 | 当请求成功或出现错误时调用的回调 |
getArticleById
获取一篇文章。
| 名字 | 类型 | 评论 |
|---|---|---|
| 正如 | NSString | 帮助中心文章的id |
| 回调 | 成功时返回一个项目对象 |
getFlatArticlesWithCallback
获取FlatArticle对象。
| 名字 | 类型 | 评论 |
|---|---|---|
| 回调 | 返回的列表FlatArticle成功的目标 |
getArticlesByLabels
获取具有给定标签列表的项目列表。文章必须包含所有的标签。
| 名字 | 类型 | 评论 |
|---|---|---|
| 标签 | NSArray | 条目标签的数组 |
| 回调 | 返回成功时的文章列表 |
getSectionsWithCategoryId
获取给定帮助中心类别中的部分。
| 名字 | 类型 | 评论 |
|---|---|---|
| 被标记 | NSString | 帮助中心类别的id |
| 回调 | 返回成功时的节列表 |
getArticlesWithSectionId
获取给定帮助中心部分中的文章。
| 名字 | 类型 | 评论 |
|---|---|---|
| sectionId | NSString | 帮助中心部分的id |
| 回调 | 返回成功时的文章列表 |
searchForArticlesUsingQuery
搜索的文章。您可以按标签筛选结果。该方法加载类别、节和用户。
| 名字 | 类型 | 评论 |
|---|---|---|
| 查询 | NSString | 用于执行搜索的查询文本 |
| andLabels | NSArray | 用于过滤查询的标签数组 |
| 回调 | 返回成功时的文章列表 |
searchArticles
在给定的ZDKHelpCenterSearch模型中搜索由参数过滤的文章。看到搜索帮助中心在帮助中心API文档中。
| 名字 | 类型 | 评论 |
|---|---|---|
| 搜索 | ZDKHelpCenterSearch | 要执行的搜索 |
| 回调 | 返回成功时的文章列表 |
getAttachmentWithArticleId
获取给定项目的附件列表。
| 名字 | 类型 | 评论 |
|---|---|---|
| 正如 | NSString | 帮助中心文章的id |
| 回调 | 返回成功时的文章列表 |
submitRecordArticleView
在Zendesk Su亚博pport中记录客户端正在查看的特定文章。用于在Zendesk支持中报告的目的。亚博
| 名字 | 类型 | 评论 |
|---|---|---|
| 正如 | NSString | 被浏览的帮助中心文章的id |
| 回调 | 一个完成回调。可以是零 |
upvoteArticleWithId
为一篇给定的文章投上一票。如果一个投票已经存在，它将被更新。
| 名字 | 类型 | 评论 |
|---|---|---|
| 正如 | NSString | 帮助中心文章的id |
| 回调 | 成功时返回投票对象 |
downvoteArticleWithId
对给定的文章投否决票。如果一个投票已经存在，它将被更新。
| 名字 | 类型 | 评论 |
|---|---|---|
| 正如 | NSString | 帮助中心文章的id |
| 回调 | 成功时返回投票对象 |
deleteVoteWithId
删除投票。
| 名字 | 类型 | 评论 |
|---|---|---|
| voteId | NSString | 要删除的投票id |
| 回调 | 返回状态码 |