配置相关设置
KFConfig.h
注：用于基本属性的配置
属性说明
| 属性名称 | 类型 | 说明 |
|---|---|---|
| user | KFUser | 查看用户信息 |
方法说明
1、 初始化方法
+ (instancetype)instance;
返回值：返回唯一KFConfig实例对象
2、 初始化域名和通信秘钥
+ (void)initializeWithHostName:(NSString *)hostName appId:(NSString *)appId;
| 参数名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| hostName | NSString | 是 | 云客服平台域名 |
| appId | NSString | 是 | 通信秘钥 |
注：用于与您的KF5系统相连接
3、 初始化用户名和密码
- (void)setEmail:(NSString *)email andUserName:(NSString *)userName
PassWord:(NSString *)password WithFailure:(void (^)(id failure))failure;
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| NSString | 是 | 邮箱 | |
| userName | NSString | 否 | 昵称 |
| password | NSString | 是 | 密码 |
| failure | Block | 否 | 密码错误,或网络请求错误的处理 |
注:密码选填,但填写密码相对更安全,而且用户也可以通过邮箱和密码能登录pc端查看问题
4、 初始化用户
- (void)setEmail:(NSString *)email andUserName:(NSString *)userName
WithFailure:(void (^)(id failure))failure;
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| NSString | 是 | 邮箱 | |
| userName | NSString | 否 | 昵称 |
| failure | Block | 否 | 网络请求错误的处理 |
注:不需要密码的初始化方法
5、 获取普通用户可以编辑的自定义字段
- (void)getCustomFiledsWithSuccess:(KFAPISuccess)success failure:(KFAPIError)error;
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| success | Block | 否 | 网络请求成功的处理 |
| failure | Block | 否 | 网络请求错误的处理 |
注:用于在创建工单时使用自定义字段
获取到的JSON数据如下：
{
"ticket_fields": [
{
"enduser_required": 1,
"enduser_title": "自定义字段",
"id": 601,
"name": "field_601",
"type": "int"
},
{
"enduser_required": 0,
"enduser_title": "end_user",
"id": 654,
"name": "field_654",
"type": "dropdownlist"
}
]
}
返回字段说明
| 返回字段名 | 类型 | 说明 |
|---|---|---|
| enduser_required | int | 普通用户是否必填 |
| enduser_title | string | 对普通用户显示的标题 |
| id | int | 自定义字段的id |
| name | string | 自定义字段的键名(关键) |
| type | string | 自定义字段的类型 |
自定义工单类型 type如下：
text(文本), dropdownlist(下拉字段), textarea(文本框), checkbox(复选框), int(数字型) ,
float(浮点型), cascade(级联), date(日期), time(时间)
用户接口
KFUser.h
注：用户个人信息属性说明
属性说明
| 属性名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Id | NSString | 否 | 用户的ID |
| NSString | 否 | 用户邮箱 | |
| userName | NSString | 否 | 用户昵称 |
| appId | NSString | 否 | APP token |
| hostName | NSString | 否 | 云客服平台域名，带kf5的二级域名 |
| appName | NSString | 否 | 用于标示应用的名称 |
| jwtToken | NSString | 否 | jwttoken |
| password | NSString | 否 | 用户密码 |
| expiresTime | NSDate | 否 | jwtToken过期时间(已弃用) |