1. trait
  2. shankesgk2
  3. \
  4. NetEaseIM
  5. \
  6. Traits
  7. \
  8. UserTrait

UserTrait

trait UserTrait (View source)

网易云通信ID 用户名片、设置、关系托管

Methods

array
userCreateUserId(string $accid, string $mobile = '', string $name = '', int $gender = 0, array $props = [], string $icon = '', string $token = '', string $sign = '', string $email = '', string $birth = '', string $ex = '')

创建云信ID 1.第三方帐号导入到云信平台； 2.注意accid，name长度以及考虑管理秘钥token

array|bool
userUpdateUserId(string $accid, string $name = '', array $props = [], string $token = '')

更新云信ID

array
userRefreshToken($accid)

更新并获取新token

bool|array
userBlockUser(string $accId, bool $needKick = false)

封禁网易云通信ID

bool|array
userUnBlockUser(string $accId)

解封网易云通信ID

bool|array
userUpdateUserInfo(string $accId, string $name = null, string $icon = null, string $sign = null, string $email = null, string $birth = null, string $mobile = null, string $gender = null, string $ex = null)

更新用户名片

array
userGetUserInfo(array $accIds)

获取用户名片

bool|array
userSetDonnop(string $accId, bool $donnopOpen = false)

设置桌面端在线时，移动端是否需要推送

bool|array
userMute(string $accid, bool $mute = true)

账号全局禁言 设置或取消账号的全局禁言状态；账号被设置为全局禁言后，不能发送“点对点”、“群”、“聊天室”消息

bool|array
userMuteAv(string $accid, bool $mute = true)

账号全局禁用音视频 账号被设置为禁用音视频后，不能发起点对点音视频、创建多人音视频、发起点对点白板、创建多人白板

bool|array
userAddFriend(string $accId, string $fAccId, string $type, string $msg = '')

添加好友

bool|array
userUpdateFriend(string $accId, string $fAccId, string $alias)

更新好友相关信息

bool|array
userDeleteFriend(string $accId, string $fAccId)

删除好友

array
userGetFriend(string $accId, int $createTime = 0)

获取好友关系

bool|array
userSetSpecialRelation(string $accId, string $targetAcc, int $relationType, int $value)

设置黑名单/静音

array
userListBlackAndMuteList(string $accId)

查看/获取 指定用户的黑名单和静音列表

Details

at line 70
array userCreateUserId(string $accid, string $mobile = '', string $name = '', int $gender = 0, array $props = [], string $icon = '', string $token = '', string $sign = '', string $email = '', string $birth = '', string $ex = '')

创建云信ID 1.第三方帐号导入到云信平台； 2.注意accid，name长度以及考虑管理秘钥token

Parameters

string $accid [云信ID，最大长度32字节，必须保证一个APP内唯一（只允许字母、数字、半角下划线_、@、半角点以及半角-组成，不区分大小写，会统一小写处理）]
string $mobile 用户mobile，最大长度32字符，只支持国内号码
string $name [云信ID昵称，最大长度64字节，用来PUSH推送时显示的昵称]
int $gender 用户性别，0表示未知，1表示男，2女表示女，其它会报参数错误
array $props [json属性，第三方可选填，最大长度1024字节]
string $icon [云信ID头像URL，第三方可选填，最大长度1024]
string $token [云信ID可以指定登录token值，最大长度128字节，并更新，如果未指定，会自动生成token，并在创建成功后返回]
string $sign 用户签名，最大长度256字符
string $email 用户email，最大长度64字符
string $birth 用户生日，最大长度16字符
string $ex 用户名片扩展字段，最大长度1024字符，用户可自行扩展，建议封装成JSON字符串

Return Value

array $result['info'] 或 ['error'=>true,'message'=>$message]

at line 114
array|bool userUpdateUserId(string $accid, string $name = '', array $props = [], string $token = '')

更新云信ID

Parameters

string $accid [云信ID，最大长度32字节，必须保证一个APP内唯一（只允许字母、数字、半角下划线_、@、半角点以及半角-组成，不区分大小写，会统一小写处理）]
string $name [云信ID昵称，最大长度64字节，用来PUSH推送时显示的昵称]
array $props [json属性，第三方可选填，最大长度1024字节]
string $token [云信ID可以指定登录token值，最大长度128字节，并更新，如果未指定，会自动生成token，并在创建成功后返回]

Return Value

array|bool true 或 ['error'=>true,'message'=>$message]

at line 130
array userRefreshToken($accid)

更新并获取新token

Parameters

$accid [云信ID，最大长度32字节，必须保证一个APP内唯一（只允许字母、数字、半角下划线_、@、半角点以及半角-组成，不区分大小写，会统一小写处理）]

Return Value

array $result['info'] 或 ['error'=>true,'message'=>$message]

at line 147
bool|array userBlockUser(string $accId, bool $needKick = false)

封禁网易云通信ID

Parameters

string $accId
bool $needKick 是否踢掉被禁用户, 默认 false

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 163
bool|array userUnBlockUser(string $accId)

解封网易云通信ID

Parameters

string $accId

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 187
bool|array userUpdateUserInfo(string $accId, string $name = null, string $icon = null, string $sign = null, string $email = null, string $birth = null, string $mobile = null, string $gender = null, string $ex = null)

更新用户名片

Parameters

string $accId
string $name 用户昵称，最大长度64字符
string $icon 用户icon，最大长度1024字符
string $sign 用户签名，最大长度256字符
string $email 用户email，最大长度64字符
string $birth 用户生日，最大长度16字符
string $mobile 用户mobile，最大长度32字符，只支持国内号码
string $gender 用户性别，0表示未知，1表示男，2女表示女，其它会报参数错误
string $ex 用户名片扩展字段，最大长度1024字符，用户可自行扩展，建议封装成JSON字符串

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 219
array userGetUserInfo(array $accIds)

获取用户名片

Parameters

array $accIds 最多可以200个

Return Value

array $result['uinfos'] 或 ['error'=>true,'message'=>$message]

at line 236
bool|array userSetDonnop(string $accId, bool $donnopOpen = false)

设置桌面端在线时，移动端是否需要推送

Parameters

string $accId
bool $donnopOpen 桌面端在线时，移动端是否不推送：true:移动端不需要推送，false:移动端需要推送

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 254
bool|array userMute(string $accid, bool $mute = true)

账号全局禁言 设置或取消账号的全局禁言状态；账号被设置为全局禁言后，不能发送“点对点”、“群”、“聊天室”消息

Parameters

string $accid 用户帐号
bool $mute 是否全局禁言：true：全局禁言，false：取消全局禁言

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 272
bool|array userMuteAv(string $accid, bool $mute = true)

账号全局禁用音视频 账号被设置为禁用音视频后，不能发起点对点音视频、创建多人音视频、发起点对点白板、创建多人白板

Parameters

string $accid 用户帐号
bool $mute 是否全局禁用音视频：true：全局禁用音视频，false：取消全局禁用音视频

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 292
bool|array userAddFriend(string $accId, string $fAccId, string $type, string $msg = '')

添加好友

Parameters

string $accId 加好友发起者accid
string $fAccId 加好友接收者accid
string $type 1直接加好友，2请求加好友，3同意加好友，4拒绝加好友
string $msg

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

Exceptions

NetEaseIMException

at line 319
bool|array userUpdateFriend(string $accId, string $fAccId, string $alias)

更新好友相关信息

Parameters

string $accId 发起者accid
string $fAccId 要修改朋友的accid
string $alias 给好友增加备注名，限制长度128

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 336
bool|array userDeleteFriend(string $accId, string $fAccId)

删除好友

Parameters

string $accId 发起者accid
string $fAccId 要删除的好友accid

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

at line 353
array userGetFriend(string $accId, int $createTime = 0)

获取好友关系

Parameters

string $accId 发起者accid
int $createTime 更新时间戳，接口返回该时间戳之后有更新的好友列表

Return Value

array $result 或 ['error'=>true,'message'=>$message]

at line 373
bool|array userSetSpecialRelation(string $accId, string $targetAcc, int $relationType, int $value)

设置黑名单/静音

Parameters

string $accId
string $targetAcc
int $relationType 本次操作的关系类型,1:黑名单操作，2:静音列表操作
int $value 操作值，0:取消黑名单或静音，1:加入黑名单或静音

Return Value

bool|array true 或 ['error'=>true,'message'=>$message]

Exceptions

NetEaseIMException

at line 392
array userListBlackAndMuteList(string $accId)

查看/获取 指定用户的黑名单和静音列表

Parameters

string $accId

Return Value

array $result 或 ['error'=>true,'message'=>$message]