好友接口
此部分接口负责用户好友信息的共享。一个应用更新的好友资料其他应用都能够看到。
添加好友
bool uc_friend_add(integer uid , integer friendid [, string comment])
函数参数
| 参数 | 含义 |
|---|---|
| integer uid | 用户 ID |
| integer friendid | 好友用户 ID |
| string comment | 备注，可为空 |
返回值
| 值 | 含义 |
|---|---|
| bool | 1:成功 0:失败 |
本函数接口用于把 friendid 添加为 uid 的好友。
添加好友示例 (PHP)
删除好友
integer uc_friend_delete(integer uid , array friendids)
函数参数
| 参数 | 含义 |
|---|---|
| integer uid | 用户 ID |
| array friendids | 好友用户 ID 数组 |
返回值
| 值 | 含义 |
|---|---|
| integer | 被删除的好友数 |
本函数接口用于删除指定用户的好友。friendids 参数是一个自由 Key 数组类型，如“ array(1, 2, 3, 4, 5 ...) ”，数组的每一个值均代为好友用户 ID。
删除好友示例 (PHP)
获取好友总数
integer uc_friend_totalnum(integer uid [, integer direction])
函数参数
| 参数 | 含义 |
|---|---|
| integer uid | 用户 ID |
| integer direction | 0:(默认值) 指定用户的全部好友 1:正向，指定用户添加的好友，但没被对方添加 2:反向，指定用户被哪些用户添加为好友，但没被对方添加 3:双向，互相添加为好友 |
返回值
| 值 | 含义 |
|---|---|
| integer | 好友数目 |
本接口函数用于返回指定用户的好友数。
返回好友数示例 (PHP)
获取好友列表
array uc_friend_ls(integer uid [, integer page , integer pagesize , integertotalnum , integer direction])
函数参数
| 参数 | 含义 |
|---|---|
| integer uid | 用户 ID |
| integer page | 当前页编号，默认值 1 |
| integer pagesize | 每页最大条目数，默认值 10 |
| integer totalnum | 好友总数，默认值 10 |
| integer direction | 0:(默认值) 指定用户的全部好友 1:正向，指定用户添加的好友，但没被对方添加 2:反向，指定用户被哪些用户添加为好友（粉丝） 3:双向，互相添加为好友 |
返回值
| 值 | 含义 |
|---|---|
| array | 好友列表数据，其中单条好友数组结构请参看附表 |
附表：单条好友数组结构
| integer ['uid'] | 用户 ID |
|---|---|
| integer ['friendid'] | 好友用户 ID |
| integer ['direction'] | 0:(默认值) 指定用户的全部好友 1:正向，指定用户添加的好友，但没被对方添加 2:反向，指定用户被哪些用户添加为好友（粉丝） 3:双向，互相添加为好友 |
| string ['username'] | 好友用户名 |