question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
|---|---|---|---|---|
好友管理接口 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
好友管理接口
# 好友管理接口
最近更新时间: 2021-06-29 09:48:15
# 好友管理接口
## 拒绝好友申请
### 基本信息
**Path：** /roster/decline
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
reason| string| 非必须| | 拒绝的原因|
user_id| integer| 必须| | 拒绝的用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 从黑名单移除
### 基本信息
**Path：** /roster/unblock
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 删除好友
### 基本信息
**Path：** /roster/delete
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 删除好友
### 基本信息
**Path：** /roster/delete
**Method：** DELETE
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 同意好友申请
### 基本信息
**Path：** /roster/accept
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 同意好友申请
### 基本信息
**Path：** /roster/accept
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 好友列表
### 基本信息
**Path：** /roster/list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
cursor | 否 | | cursor
limit | 否 | | limit
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|
data| integer []| 非必须| | 结果数据| item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
version| integer| 非必须| | 版本| format: int64
## 好友申请列表
### 基本信息
**Path：** /roster/apply/list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
cursor | 否 | | cursor
limit | 否 | | limit
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|
data| object []| 非必须| | 结果数据| item 类型: object
├─ expired_time| integer| 非必须| | 过期时间| format: int64
├─ reason| string| 非必须| | 申请描述|
├─ status| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 发起加好友申请的用户ID| format: int64
message| string| 非必须| | 错误信息，如果成功，该项为null|
version| integer| 非必须| | 版本| format: int64
## 好友详情列表
### 基本信息
**Path：** /roster/list
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
list| integer []| 非必须| | | item 类型: integer
├─ | | 非必须| | |
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object []| 非必须| | 结果数据| item 类型: object
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 批量添加好友
### 基本信息
**Path：** /roster/apply/batch
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
| object []| 非必须| | | item 类型: object
├─ alias| string| 非必须| | 备注名称|
├─ reason| string| 非必须| | 申请描述|
├─ user_id| integer| 必须| | 被申请用户 ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 批量添加好友返回结果|
├─ fails| object []| 非必须| | | item 类型: object
├─ reason| string| 非必须| | 失败原因|
├─ user_id| integer| 非必须| | 用户ID| format: int64
├─ success| integer []| 非必须| | | item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 拒绝好友申请
### 基本信息
**Path：** /roster/decline
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
reason| string| 非必须| | 拒绝的原因|
user_id| integer| 必须| | 拒绝的用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 从黑名单移除
### 基本信息
**Path：** /roster/unblock
**Method：** DELETE
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 是否允许发消息
### 基本信息
**Path：** /roster/may_message
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
roster_id | 是 | | roster_id
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 更新好友扩展信息
### 基本信息
**Path：** /roster/ext
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
ext| string| 非必须| | 扩展信息|
mute_notification| boolean| 非必须| | 是否接收消息提醒|
user_id| integer| 必须| | 好友用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 更新好友扩展信息
### 基本信息
**Path：** /roster/ext
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
ext| string| 非必须| | 扩展信息|
mute_notification| boolean| 非必须| | 是否接收消息提醒|
user_id| integer| 必须| | 好友用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 添加黑名单
### 基本信息
**Path：** /roster/block
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 添加黑名单
### 基本信息
**Path：** /roster/block
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用ID搜索用户
### 基本信息
**Path：** /roster/id
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | 用户ID
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用手机号搜索用户
### 基本信息
**Path：** /roster/mobile
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
mobile | 是 | | mobile
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用用户名搜索用户
### 基本信息
**Path：** /roster/name
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
username | 是 | | username
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 申请加好友
### 基本信息
**Path：** /roster/apply
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
auth_answer| string| 非必须| | 问题答案|
reason| string| 非必须| | 申请描述|
user_id| integer| 必须| | 被申请用户 ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 黑名单列表
### 基本信息
**Path：** /roster/blocked_list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| integer []| 非必须| | 结果数据| item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
好友管理接口
# 好友管理接口
最近更新时间: 2021-06-29 09:48:15
# 好友管理接口
## 拒绝好友申请
### 基本信息
**Path：** /roster/decline
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
reason| string| 非必须| | 拒绝的原因|
user_id| integer| 必须| | 拒绝的用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 从黑名单移除
### 基本信息
**Path：** /roster/unblock
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 删除好友
### 基本信息
**Path：** /roster/delete
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 删除好友
### 基本信息
**Path：** /roster/delete
**Method：** DELETE
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 同意好友申请
### 基本信息
**Path：** /roster/accept
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 同意好友申请
### 基本信息
**Path：** /roster/accept
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 好友列表
### 基本信息
**Path：** /roster/list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
cursor | 否 | | cursor
limit | 否 | | limit
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|
data| integer []| 非必须| | 结果数据| item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
version| integer| 非必须| | 版本| format: int64
## 好友申请列表
### 基本信息
**Path：** /roster/apply/list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
cursor | 否 | | cursor
limit | 否 | | limit
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|
data| object []| 非必须| | 结果数据| item 类型: object
├─ expired_time| integer| 非必须| | 过期时间| format: int64
├─ reason| string| 非必须| | 申请描述|
├─ status| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 发起加好友申请的用户ID| format: int64
message| string| 非必须| | 错误信息，如果成功，该项为null|
version| integer| 非必须| | 版本| format: int64
## 好友详情列表
### 基本信息
**Path：** /roster/list
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
list| integer []| 非必须| | | item 类型: integer
├─ | | 非必须| | |
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object []| 非必须| | 结果数据| item 类型: object
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 批量添加好友
### 基本信息
**Path：** /roster/apply/batch
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
| object []| 非必须| | | item 类型: object
├─ alias| string| 非必须| | 备注名称|
├─ reason| string| 非必须| | 申请描述|
├─ user_id| integer| 必须| | 被申请用户 ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 批量添加好友返回结果|
├─ fails| object []| 非必须| | | item 类型: object
├─ reason| string| 非必须| | 失败原因|
├─ user_id| integer| 非必须| | 用户ID| format: int64
├─ success| integer []| 非必须| | | item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 拒绝好友申请
### 基本信息
**Path：** /roster/decline
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
reason| string| 非必须| | 拒绝的原因|
user_id| integer| 必须| | 拒绝的用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 从黑名单移除
### 基本信息
**Path：** /roster/unblock
**Method：** DELETE
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 是否允许发消息
### 基本信息
**Path：** /roster/may_message
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
roster_id | 是 | | roster_id
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 更新好友扩展信息
### 基本信息
**Path：** /roster/ext
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
ext| string| 非必须| | 扩展信息|
mute_notification| boolean| 非必须| | 是否接收消息提醒|
user_id| integer| 必须| | 好友用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 更新好友扩展信息
### 基本信息
**Path：** /roster/ext
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
ext| string| 非必须| | 扩展信息|
mute_notification| boolean| 非必须| | 是否接收消息提醒|
user_id| integer| 必须| | 好友用户ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 添加黑名单
### 基本信息
**Path：** /roster/block
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 添加黑名单
### 基本信息
**Path：** /roster/block
**Method：** PUT
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | user_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用ID搜索用户
### 基本信息
**Path：** /roster/id
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
user_id | 是 | | 用户ID
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用手机号搜索用户
### 基本信息
**Path：** /roster/mobile
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
mobile | 是 | | mobile
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 用用户名搜索用户
### 基本信息
**Path：** /roster/name
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
username | 是 | | username
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 好友列表|
├─ alias| string| 非必须| | |
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32
├─ auth_question| string| 非必须| | 验证问题|
├─ avatar| string| 非必须| | 头像|
├─ description| string| 非必须| | 描述信息|
├─ ext| string| 非必须| | |
├─ mute_notification| boolean| 非必须| | |
├─ nick_name| string| 非必须| | 昵称或名称|
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|
├─ relation| integer| 非必须| | | format: int32
├─ user_id| integer| 非必须| | 好友用户ID| format: int64
├─ username| string| 非必须| | 用户名|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 申请加好友
### 基本信息
**Path：** /roster/apply
**Method：** POST
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
alias| string| 非必须| | 备注名称|
auth_answer| string| 非必须| | 问题答案|
reason| string| 非必须| | 申请描述|
user_id| integer| 必须| | 被申请用户 ID| format: int64
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 黑名单列表
### 基本信息
**Path：** /roster/blocked_list
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| integer []| 非必须| | 结果数据| item 类型: integer
├─ | | 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,282 |
群操作 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
群操作
# 群操作
最近更新时间: 2023-07-06 14:23:57
# 创建群
## 基本信息
POST /group/create
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
创建群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"type": <type>, //群类型 0表示私有群, 2表示聊天室
"name":"<name>", //群名称
"description":"", //群描述
"avatar":"<url>", //头像URL
"user_list"[<userid>, <userid>] //邀请入群的用户id列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 解散群
## 基本信息
POST /group/destroy
DELETE /group/destroy
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
解散指定的群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 转让群
## 基本信息
POST /group/transfer
PUT /group/transfer
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
转让群主身份给另外一个用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"new_owner":<userid> //群的新群主用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"user_id":<userid>, //用户ID
"result":"success", //success 成功，fail 失败
"reason":"" //失败原因
}
}
# 获取群信息
## 基本信息
GET /group/info
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群ID，查询群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 批量获取群信息
## 基本信息
POST /group/info/batch
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据group id，批量获取群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_list":[<groupid>, <groupid>], //群ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"group_id":<groupid>, //群ID
"owner":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"count":<count>, //群成员容量，可以加入的成员最大数
"capacity":<capacity>, //当前群成员数量
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0 //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
}]
}
# 获取群设置
## 基本信息
GET /group/settings
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的设置信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 更新群名称
## 基本信息
POST /group/info/name
PUT /group/info/name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群名称。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群名称
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群头像
## 基本信息
POST /group/info/avatar
PUT /group/info/avatar
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的头像信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群头像URL
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群描述
## 基本信息
POST /group/info/description
PUT /group/info/description
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群描述信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群描述信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群扩展信息
## 基本信息
POST /group/info/ext
PUT /group/info/ext
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的扩展信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //扩展信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–群成员是否可修改群信息
## 基本信息
POST /group/settings/allow_member_modify
PUT /group/settings/allow_member_modify
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
修改群设置，设置群成员是否可以修改群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<group id>, //群ID
"value": true //true 允许；false 不允许
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–新成员是否可见群历史聊天记录
## 基本信息
POST /group/settings/history_visible
PUT /group/settings/history_visible
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群设置。设置新成员进群，是否课件历史聊天记录。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 允许查看；false 不允许查看
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–是否允许成员邀请
## 基本信息
POST /group/settings/allow_member_invitation
PUT /group/settings/allow_member_invitation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群设置。设置是否允许群成员邀请其他用户进群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 允许；false 不允许
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–是否开启群消息已读功能
## 基本信息
POST /group/settings/enable_read_ack
PUT /group/settings/enable_read_ack
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群是否开启消息已读功能。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 开启；false 不开启
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 设置群消息屏蔽模式
## 基本信息
POST /group/msg/mute_mode
PUT /group/msg/mute_mode
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群消息的屏蔽模式。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"msg_mute_mode":<mode> //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 设置群消息推送模式
## 基本信息
POST /group/msg/push_mode
PUT /group/msg/push_mode
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群消息的推送模式。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"msg_push_mode":<mode> //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–群申请是否需要管理员审批
## 基本信息
POST /group/settings/require_admin_approval
PUT /group/settings/require_admin_approval
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置进群申请，是否需要管理员审批。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"apply_approval":0 //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 申请入群
## 基本信息
POST /group/apply
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
用户申请加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"reason":"" //申请入群原因
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"user_id":<userid>, //用户ID
"result":"success", //success 成功；fail 失败
"reason":"" //失败原因
}
}
# 获取群申请列表
## 基本信息
POST /group/application_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
查询群申请列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | cursor
limit | integer | 否 | 返回列表的最大条数
### Body
{
"group_list":[<groupid>, <groupid>] //群id 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [{
"group_id":<groupid>, //群ID
"applicant_id":<apply id>, //申请ID
"status":<status>, //状态 0 - 待处理，1 - 同意，2 - 拒绝
"reason":"", //原因
"expired_time":<timestamp>. //过期时间（毫秒）
}]
}
# 管理员处理入群申请
## 基本信息
POST /group/apply/handle
PUT /group/apply/handle
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
管理员处理进群申请。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"approval":true //true 同意；false 拒绝。
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 邀请入群
## 基本信息
POST /group/invite
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
邀请用户加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"reason":"", //邀请理由说明
”user_list:[<userid>, <userid>] //带邀请的用户ID 列表。
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"user_id":<userid>, //用户ID
"result":"success", //success 成功，fail 失败
"reason":"" //失败原因
}]
}
# 获取群邀请二维码信息
## 基本信息
GET /group/qrcode/sign
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群邀请二维码。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"qr_info":"", //二维码信息
"created_at":<timestamp>, //创建时间，毫秒时间戳
"expire_at":<timestamp> //过期时间，毫秒时间戳
}
}
# 二维码邀请入群
## 基本信息
POST /group/qrcode/invite
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
通过群二维码进群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"qr_info":"<qr code>", //二维码内容，通过扫描群二维码获得
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群邀请列表
## 基本信息
GET /group/invitation_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群邀请列表信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 是否 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 翻页游标
limit | integer | 否 | 返回最大数量
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"group_id":<groupid>, //群ID
"inviter_id":<userid>, //发起邀请的用户ID
"invitee_id":<userid>, //被邀请的用户ID
"status":0, //0 - 待处理，1 - 用户同意，2 - 用户拒绝
"reason":"", //原因
"expired_time":<timestamp>, //超时时间，毫秒时间戳
"updated_at":<timestamp> //更新时间
}
]
}
# 用户处理入群邀请
## 基本信息
POST /group/invite/handle
PUT /group/invite/handle
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
用户处理收到的进群邀请。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"approval":true //true 同意邀请进群；false 拒绝邀请
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 成员退出群
### 基本信息
POST /group/leave
DELETE /group/leave
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
指定的用户，主动退群。
## 请求参数
### Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | group_id
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群成员列表
## 基本信息
GET /group/member_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群ID，获取群成员列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 分页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回列表的最大条数
## 返回数据
{
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"cursor":"", //分页游标
"data": [{
"user_id":<userid>, //用户ID
"display_name":"", //群成员名片
"join_time":<timestamp>, //群成员进群时间，毫秒时间戳
"expired_time":<timestamp> //禁言过期时间，毫秒时间戳
}]
}
# 将成员踢出群
## 基本信息
POST /group/kick
DELETE /group/kick
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将群成员踢出群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取用户的群组列表
## 基本信息
GET /group/user_joined
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取用户加入的群组列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [<groupid>] //用户加入的群组ID 列表
}
# 将用户加入黑名单
## 基本信息
POST /group/block
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将用户加入黑名单。群黑名单，不允许加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取黑名单列表
## 基本信息
GET /group/blocked_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群黑名单列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 分页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回列表的最大条数
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"created_at":<timestamp> //创建时间，毫秒时间戳
}
]
}
# 从黑名单移除用户
## 基本信息
POST /group/unblock
DELETE /group/unblock
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
从群黑名单中，移除用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 上传群文件
## 基本信息
POST /group/file/upload
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
上传群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<group id>, //群ID
"name":"<name>", //文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"url":"<url>" //文件URL
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<group id>, //群ID
"file_id":<file id>, //共享文件ID
"name":"<name>", //共享文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"uploader":<userid>, //上传者用户ID
"url":"<url>", //共享文件URL
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp> //更新时间，毫秒时间戳
}
}
# 删除群文件
## 基本信息
POST /group/file/delete
DELETE /group/file/delete
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除指定的群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"file_list":[ //文件id列表
<fileid>,
<fileid>
]
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"file_id":<fileid>, //文件ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 更新群文件名称
## 基本信息
POST /group/file/update_name
PUT /group/file/update_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群文件的名称。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"file_id":<fileid>, //群文件ID
"value":"" //群文件新名称
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群文件列表
## 基本信息
GET /group/file/list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群文件列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
### 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"group_id":<group id>, //群ID
"file_id":<file id>, //共享文件ID
"name":"<name>", //共享文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"uploader":<userid>, //上传者用户ID
"url":"<url>", //共享文件URL
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp> //更新时间，毫秒时间戳
}]
}
# 下载群文件
## 基本信息
GET /group/file
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
下载群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
file_id | integer | 是 | 文件ID
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"file_id":<fileid>, //文件ID
"name":"", //文件名
"type":"", //文件类型
"size":123, //文件大小
"url":"<url>", //文件URL
"uploader":<userid>, //文件上传者
"created_at":<timestamp>, //创建时间，毫秒级时间戳
"updated_at":<timestamp> //更新时间，毫秒级时间戳
}
}
# 将用户禁言
## 基本信息
POST /group/ban
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将用户禁言。禁言后，用户不能在群里发消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"duration":<minute>, //禁言时间，单位：分钟
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 从禁言列表移除用户
## 基本信息
POST /group/unban
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
从禁言列表移除用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取禁言列表
## 基本信息
GET /group/banned_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群组的禁言用户列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 是否 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 翻页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回最大数量
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"user_id":<userid>, //群成员用户ID
"display_name":"", //成员群名片
"join_time":<timestamp>, //进群时间，毫秒时间戳
"expired_time":<timestamp> //禁言过期时间，毫秒时间戳
}
]
}
# 全员禁言，只允许管理员发消息
## 基本信息
POST /group/settings/ban_all
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
群内全员禁言，只允许管理员发消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"duration":<minute> //禁言时间，单位：分钟
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data":
{
"ban_expire_time": 0 //全员禁言过期时间（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
}
}
# 取消全员禁言
## 基本信息
POST /group/settings/unban_all
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
取消全员禁言。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid> //群ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true // true 成功；false 失败
}
# 批量获取群成员的群名片
## 基本信息
POST /group/members/display_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
批量获取群成员的群名片。
## 请求参数
### Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 更新群名片
## 基本信息
POST /group/display_name
PUT /group/display_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的群名片信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群名片
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 添加群管理员
## 基本信息
POST /group/admin/add
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
添加用户为群管理员。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //待添加为管理员的用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 移除群管理员
## 基本信息
POST /group/admin/remove
DELETE /group/admin/remove
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
群主删除群管理员。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //待添加为管理员的用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取群管理员列表
## 基本信息
GET /group/admin_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群管理员列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"user_id":<userid>, //用户ID
"display_name":"", //成员群名片
"expired_time":<timestamp>. //用户进群时间（毫秒）
}]
}
# 编辑群公告
## 基本信息
POST /group/announcement/edit
PUT /group/announcement/edit
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
编辑群公告。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"title":"", //公告标题
"content":"" //公告内容
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 删除公告
## 基本信息
POST /group/announcement/delete
DELETE /group/announcement/delete
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除群的群公告。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
announcement_id | integer | 是 | 公告ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群公告列表
## 基本信息
GET /group/announcement/list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的公告列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 获取最新一条群公告详情
## 基本信息
GET /group/announcement/last
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的最新一条公告详情信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 根据群id和公告id获取群公告详情
## 基本信息
GET /group/announcement
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群id和公告id获取群公告详情
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 示例 | 备注
---|---|---|---
announcement_id | integer | 是 | 群公告ID
group_id | integer | 是 | 群ID
## 返回数据
{
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"content":"", //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
群操作
# 群操作
最近更新时间: 2023-07-06 14:23:57
# 创建群
## 基本信息
POST /group/create
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
创建群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"type": <type>, //群类型 0表示私有群, 2表示聊天室
"name":"<name>", //群名称
"description":"", //群描述
"avatar":"<url>", //头像URL
"user_list"[<userid>, <userid>] //邀请入群的用户id列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 解散群
## 基本信息
POST /group/destroy
DELETE /group/destroy
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
解散指定的群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 转让群
## 基本信息
POST /group/transfer
PUT /group/transfer
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
转让群主身份给另外一个用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"new_owner":<userid> //群的新群主用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"user_id":<userid>, //用户ID
"result":"success", //success 成功，fail 失败
"reason":"" //失败原因
}
}
# 获取群信息
## 基本信息
GET /group/info
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群ID，查询群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 批量获取群信息
## 基本信息
POST /group/info/batch
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据group id，批量获取群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_list":[<groupid>, <groupid>], //群ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"group_id":<groupid>, //群ID
"owner":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"count":<count>, //群成员容量，可以加入的成员最大数
"capacity":<capacity>, //当前群成员数量
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0 //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
}]
}
# 获取群设置
## 基本信息
GET /group/settings
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的设置信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"owner_id":<userid>, //群主用户ID
"name":"", //群名称
"avatar":"", //群头像URL
"description":"", //群描述
"ext":"", //群扩展信息
"type":0, //群类型 0表示私有群, 2表示聊天室
"status":0, //群状态, 0：正常, 1：已解散
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp>, //更新时间，毫秒时间戳
"apply_approval":0, //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
"ban_expire_time":<timestamp>, //全员禁言过期时间时间戳（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
"history_visible":true, //新成员是否可见历史聊天记录
"member_invite":true, //群成员是否可以邀请用户进群
"member_modify":true, //群成员是否可以修改群信息
"msg_mute_mode":0, //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
"msg_push_mode":0, //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
"read_ack":true //群消息已读功能是否开启
}
}
# 更新群名称
## 基本信息
POST /group/info/name
PUT /group/info/name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群名称。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群名称
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群头像
## 基本信息
POST /group/info/avatar
PUT /group/info/avatar
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的头像信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群头像URL
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群描述
## 基本信息
POST /group/info/description
PUT /group/info/description
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群描述信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群描述信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群扩展信息
## 基本信息
POST /group/info/ext
PUT /group/info/ext
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的扩展信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //扩展信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–群成员是否可修改群信息
## 基本信息
POST /group/settings/allow_member_modify
PUT /group/settings/allow_member_modify
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
修改群设置，设置群成员是否可以修改群信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<group id>, //群ID
"value": true //true 允许；false 不允许
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–新成员是否可见群历史聊天记录
## 基本信息
POST /group/settings/history_visible
PUT /group/settings/history_visible
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群设置。设置新成员进群，是否课件历史聊天记录。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 允许查看；false 不允许查看
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–是否允许成员邀请
## 基本信息
POST /group/settings/allow_member_invitation
PUT /group/settings/allow_member_invitation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群设置。设置是否允许群成员邀请其他用户进群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 允许；false 不允许
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–是否开启群消息已读功能
## 基本信息
POST /group/settings/enable_read_ack
PUT /group/settings/enable_read_ack
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群是否开启消息已读功能。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":true //true 开启；false 不开启
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 设置群消息屏蔽模式
## 基本信息
POST /group/msg/mute_mode
PUT /group/msg/mute_mode
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群消息的屏蔽模式。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"msg_mute_mode":<mode> //群消息屏蔽模式： 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息，不接收消息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 设置群消息推送模式
## 基本信息
POST /group/msg/push_mode
PUT /group/msg/push_mode
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置群消息的推送模式。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"msg_push_mode":<mode> //群消息推送类型： 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 更新群设置–群申请是否需要管理员审批
## 基本信息
POST /group/settings/require_admin_approval
PUT /group/settings/require_admin_approval
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
设置进群申请，是否需要管理员审批。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"apply_approval":0 //入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 申请入群
## 基本信息
POST /group/apply
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
用户申请加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"reason":"" //申请入群原因
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"user_id":<userid>, //用户ID
"result":"success", //success 成功；fail 失败
"reason":"" //失败原因
}
}
# 获取群申请列表
## 基本信息
POST /group/application_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
查询群申请列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | cursor
limit | integer | 否 | 返回列表的最大条数
### Body
{
"group_list":[<groupid>, <groupid>] //群id 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [{
"group_id":<groupid>, //群ID
"applicant_id":<apply id>, //申请ID
"status":<status>, //状态 0 - 待处理，1 - 同意，2 - 拒绝
"reason":"", //原因
"expired_time":<timestamp>. //过期时间（毫秒）
}]
}
# 管理员处理入群申请
## 基本信息
POST /group/apply/handle
PUT /group/apply/handle
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
管理员处理进群申请。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"approval":true //true 同意；false 拒绝。
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 邀请入群
## 基本信息
POST /group/invite
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
邀请用户加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"reason":"", //邀请理由说明
”user_list:[<userid>, <userid>] //带邀请的用户ID 列表。
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"user_id":<userid>, //用户ID
"result":"success", //success 成功，fail 失败
"reason":"" //失败原因
}]
}
# 获取群邀请二维码信息
## 基本信息
GET /group/qrcode/sign
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群邀请二维码。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"qr_info":"", //二维码信息
"created_at":<timestamp>, //创建时间，毫秒时间戳
"expire_at":<timestamp> //过期时间，毫秒时间戳
}
}
# 二维码邀请入群
## 基本信息
POST /group/qrcode/invite
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
通过群二维码进群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"qr_info":"<qr code>", //二维码内容，通过扫描群二维码获得
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群邀请列表
## 基本信息
GET /group/invitation_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群邀请列表信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 是否 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 翻页游标
limit | integer | 否 | 返回最大数量
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"group_id":<groupid>, //群ID
"inviter_id":<userid>, //发起邀请的用户ID
"invitee_id":<userid>, //被邀请的用户ID
"status":0, //0 - 待处理，1 - 用户同意，2 - 用户拒绝
"reason":"", //原因
"expired_time":<timestamp>, //超时时间，毫秒时间戳
"updated_at":<timestamp> //更新时间
}
]
}
# 用户处理入群邀请
## 基本信息
POST /group/invite/handle
PUT /group/invite/handle
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
用户处理收到的进群邀请。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"approval":true //true 同意邀请进群；false 拒绝邀请
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 成员退出群
### 基本信息
POST /group/leave
DELETE /group/leave
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
指定的用户，主动退群。
## 请求参数
### Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | group_id
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群成员列表
## 基本信息
GET /group/member_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群ID，获取群成员列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 分页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回列表的最大条数
## 返回数据
{
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"cursor":"", //分页游标
"data": [{
"user_id":<userid>, //用户ID
"display_name":"", //群成员名片
"join_time":<timestamp>, //群成员进群时间，毫秒时间戳
"expired_time":<timestamp> //禁言过期时间，毫秒时间戳
}]
}
# 将成员踢出群
## 基本信息
POST /group/kick
DELETE /group/kick
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将群成员踢出群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取用户的群组列表
## 基本信息
GET /group/user_joined
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取用户加入的群组列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [<groupid>] //用户加入的群组ID 列表
}
# 将用户加入黑名单
## 基本信息
POST /group/block
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将用户加入黑名单。群黑名单，不允许加入群。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取黑名单列表
## 基本信息
GET /group/blocked_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群黑名单列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 分页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回列表的最大条数
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"group_id":<groupid>, //群ID
"user_id":<userid>, //用户ID
"created_at":<timestamp> //创建时间，毫秒时间戳
}
]
}
# 从黑名单移除用户
## 基本信息
POST /group/unblock
DELETE /group/unblock
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
从群黑名单中，移除用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 上传群文件
## 基本信息
POST /group/file/upload
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
上传群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<group id>, //群ID
"name":"<name>", //文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"url":"<url>" //文件URL
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<group id>, //群ID
"file_id":<file id>, //共享文件ID
"name":"<name>", //共享文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"uploader":<userid>, //上传者用户ID
"url":"<url>", //共享文件URL
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp> //更新时间，毫秒时间戳
}
}
# 删除群文件
## 基本信息
POST /group/file/delete
DELETE /group/file/delete
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除指定的群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"file_list":[ //文件id列表
<fileid>,
<fileid>
]
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"file_id":<fileid>, //文件ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 更新群文件名称
## 基本信息
POST /group/file/update_name
PUT /group/file/update_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群文件的名称。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"file_id":<fileid>, //群文件ID
"value":"" //群文件新名称
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群文件列表
## 基本信息
GET /group/file/list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群文件列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
### 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"group_id":<group id>, //群ID
"file_id":<file id>, //共享文件ID
"name":"<name>", //共享文件名称
"type":"<type>", //文件类型
"size":<size>, //文件大小
"uploader":<userid>, //上传者用户ID
"url":"<url>", //共享文件URL
"created_at":<timestamp>, //创建时间，毫秒时间戳
"updated_at":<timestamp> //更新时间，毫秒时间戳
}]
}
# 下载群文件
## 基本信息
GET /group/file
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
下载群文件。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
file_id | integer | 是 | 文件ID
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"file_id":<fileid>, //文件ID
"name":"", //文件名
"type":"", //文件类型
"size":123, //文件大小
"url":"<url>", //文件URL
"uploader":<userid>, //文件上传者
"created_at":<timestamp>, //创建时间，毫秒级时间戳
"updated_at":<timestamp> //更新时间，毫秒级时间戳
}
}
# 将用户禁言
## 基本信息
POST /group/ban
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
将用户禁言。禁言后，用户不能在群里发消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"duration":<minute>, //禁言时间，单位：分钟
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 从禁言列表移除用户
## 基本信息
POST /group/unban
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
从禁言列表移除用户。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取禁言列表
## 基本信息
GET /group/banned_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群组的禁言用户列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 是否 | 必须 | 备注
---|---|---|---
cursor | string | 否 | 翻页游标
group_id | integer | 是 | 群ID
limit | integer | 否 | 返回最大数量
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"total":<totalcount>, //禁言用户总数
"cursor":"", //游标，用于翻页。返回结果中缺失 cursor，表示已经返回最后一页
"data": [
{
"user_id":<userid>, //群成员用户ID
"display_name":"", //成员群名片
"join_time":<timestamp>, //进群时间，毫秒时间戳
"expired_time":<timestamp> //禁言过期时间，毫秒时间戳
}
]
}
# 全员禁言，只允许管理员发消息
## 基本信息
POST /group/settings/ban_all
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
群内全员禁言，只允许管理员发消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"duration":<minute> //禁言时间，单位：分钟
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data":
{
"ban_expire_time": 0 //全员禁言过期时间（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
}
}
# 取消全员禁言
## 基本信息
POST /group/settings/unban_all
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
取消全员禁言。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid> //群ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true // true 成功；false 失败
}
# 批量获取群成员的群名片
## 基本信息
POST /group/members/display_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
批量获取群成员的群名片。
## 请求参数
### Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //用户ID 列表
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 更新群名片
## 基本信息
POST /group/display_name
PUT /group/display_name
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
更新群的群名片信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"value":"" //群名片
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 添加群管理员
## 基本信息
POST /group/admin/add
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
添加用户为群管理员。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //待添加为管理员的用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 移除群管理员
## 基本信息
POST /group/admin/remove
DELETE /group/admin/remove
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
群主删除群管理员。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"user_list":[<userid>, <userid>] //待添加为管理员的用户ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"user_id":<userid>, //用户ID
"result":"<result>", //success 成功；fail 失败
"reason":"" //失败原因
}
]
}
# 获取群管理员列表
## 基本信息
GET /group/admin_list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群管理员列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [{
"user_id":<userid>, //用户ID
"display_name":"", //成员群名片
"expired_time":<timestamp>. //用户进群时间（毫秒）
}]
}
# 编辑群公告
## 基本信息
POST /group/announcement/edit
PUT /group/announcement/edit
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
编辑群公告。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"group_id":<groupid>, //群ID
"title":"", //公告标题
"content":"" //公告内容
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 删除公告
## 基本信息
POST /group/announcement/delete
DELETE /group/announcement/delete
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除群的群公告。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
announcement_id | integer | 是 | 公告ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 获取群公告列表
## 基本信息
GET /group/announcement/list
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的公告列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 获取最新一条群公告详情
## 基本信息
GET /group/announcement/last
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取群的最新一条公告详情信息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
group_id | integer | 是 | 群ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"id":<id>, //公告ID
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"title":" ", //公告标题
"content":"" //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
]
}
# 根据群id和公告id获取群公告详情
## 基本信息
GET /group/announcement
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
根据群id和公告id获取群公告详情
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 示例 | 备注
---|---|---|---
announcement_id | integer | 是 | 群公告ID
group_id | integer | 是 | 群ID
## 返回数据
{
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"group_id":<groupid>, //群ID
"author":<userid>, //公告发布者用户ID
"content":"", //公告内容
"created_at":<timestamp> //公告发布时间，毫秒时间戳
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,320 |
消息处理 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
消息处理
# 消息处理
最近更新时间: 2022-07-26 09:19:37
# 取指定用户的最近会话列表
## 基本信息
GET /message/unread
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取用户最近的会话列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"conversation_id": { //会话ID 信息
"uid":1, //会话ID。若是用户会话，则是用户id；若是群会话，则是群ID。
"device_sn":123 //设备ID
},
"num":3 //未读计数
}
]
}
# 删除用户的指定会话
## 基本信息
DELETE /message/conversation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除用户指定的会话。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
conversation_id | integer | 是 | 会话ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 取指定会话的消息
## 基本信息
GET /message/conversation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
取指定会话的历史消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
opposite_id | integer | 是 | 会话ID
msg_id_start | integer | 否 | 从哪条消息开始拉取：传0表示最新的一条消息
limit | integer | 否 | 最多拉取多少条
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"is_last":false, //是否是最后一条消息: true - 表示后面没有消息了， false - 后面还有消息
"next_msg_id", //继续拉取需要设置的消息ID, 将此消息ID设置到请求参数的msg_id_start即可继续拉取消息
"messages": [
{
"msg_id":12345678, //消息ID,
"ctype":"TEXT", //消息内容类型: TEXT - 文本, IMAGE - 图片, AUDIO - 语音, VIDEO - 视频, FILE - 文件, LOCATION - 位置, COMMAND - 自定义， FORWARD 转发消息
"content":"", //消息内容
"attachment":"", //消息附件: 消息类型为图片/语音/视频/文件时，此字段会包括文件地址
"config":"", //SDK层使用的扩展字段
"timestamp":1658745473000, //消息发送时间戳（毫秒）
"status":"READ", //消息状态：UNREAD- 未读 ，DELIVERED - 已投递 ， READ - 已读
"from_xid":{ //消息发送者
"uid": 123 //发送者userId
"device_sn":123, //设备序号
},
"to_xid":{ //消息接受者
"uid":456 //接受者用户ID，或者群ID
"device_sn":123, //设备序号
}
}
]
}
}
# 发送已读回执
## 基本信息
GET /message/ack
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送已读消息回执。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
conversation_id | integer | 是 | 会话ID
device_sn | integer | 是 | 设备SN
msg_id | integer | 是 | 消息ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 发送消息
## 基本信息
POST /message/send
PUT /message/send
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送消息
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"transaction_id ":12345, //请求ID，用于消息去重， 如果短时间内收到2个相同transaction_id的请求，第二次请求不会被执行。 如果不设置就不会被去重
"type":1, //目标类型，1 - 普通用户，2 - 群组
"from_user_id":1, //发送者的用户ID
"targets":[123,456], //接受者的用户ID，或者群ID 列表。
"content_type":0, //消息类型 TEXT = 0;IMAGE = 1;AUDIO = 2;VIDEO = 3;FILE = 4;LOCATION = 5;COMMAND = 6;FORWARD = 7;
"content":"<content>"，//消息内容
"ext":"<ext info>", //扩展信息
"config":"<config info>", //SDK 使用的配置信息
"attachment":"<attachment>" //附件信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 发送系统通知
### 基本信息
POST /message/notify
PUT /message/notify
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送系统通知。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"transaction_id ":12345, //请求ID，用于消息去重， 如果短时间内收到2个相同transaction_id的请求，第二次请求不会被执行。 如果不设置就不会被去重
"type":1, //目标类型，1 - 普通用户，2 - 群组
"from_user_id":1, //发送者的用户ID
"targets":[123,456], //接受者的用户ID，或者群ID 列表。
"content_type":0, //消息类型 TEXT = 0;IMAGE = 1;AUDIO = 2;VIDEO = 3;FILE = 4;LOCATION = 5;COMMAND = 6;FORWARD = 7;
"content":"<content>"，//消息内容
"ext":"<ext info>", //扩展信息
"config":"<config info>", //SDK 使用的配置信息
"attachment":"<attachment>" //附件信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 撤回消息
### 基本信息
POST /message/recall
PUT /message/recall
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
撤回消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"conversation_id":12345, //会话ID
"msg_id":1 //消息ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
消息处理
# 消息处理
最近更新时间: 2022-07-26 09:19:37
# 取指定用户的最近会话列表
## 基本信息
GET /message/unread
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
获取用户最近的会话列表。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": [
{
"conversation_id": { //会话ID 信息
"uid":1, //会话ID。若是用户会话，则是用户id；若是群会话，则是群ID。
"device_sn":123 //设备ID
},
"num":3 //未读计数
}
]
}
# 删除用户的指定会话
## 基本信息
DELETE /message/conversation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
删除用户指定的会话。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
conversation_id | integer | 是 | 会话ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 取指定会话的消息
## 基本信息
GET /message/conversation
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
取指定会话的历史消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
opposite_id | integer | 是 | 会话ID
msg_id_start | integer | 否 | 从哪条消息开始拉取：传0表示最新的一条消息
limit | integer | 否 | 最多拉取多少条
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": {
"is_last":false, //是否是最后一条消息: true - 表示后面没有消息了， false - 后面还有消息
"next_msg_id", //继续拉取需要设置的消息ID, 将此消息ID设置到请求参数的msg_id_start即可继续拉取消息
"messages": [
{
"msg_id":12345678, //消息ID,
"ctype":"TEXT", //消息内容类型: TEXT - 文本, IMAGE - 图片, AUDIO - 语音, VIDEO - 视频, FILE - 文件, LOCATION - 位置, COMMAND - 自定义， FORWARD 转发消息
"content":"", //消息内容
"attachment":"", //消息附件: 消息类型为图片/语音/视频/文件时，此字段会包括文件地址
"config":"", //SDK层使用的扩展字段
"timestamp":1658745473000, //消息发送时间戳（毫秒）
"status":"READ", //消息状态：UNREAD- 未读 ，DELIVERED - 已投递 ， READ - 已读
"from_xid":{ //消息发送者
"uid": 123 //发送者userId
"device_sn":123, //设备序号
},
"to_xid":{ //消息接受者
"uid":456 //接受者用户ID，或者群ID
"device_sn":123, //设备序号
}
}
]
}
}
# 发送已读回执
## 基本信息
GET /message/ack
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送已读消息回执。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Query
参数名称 | 类型 | 必须 | 备注
---|---|---|---
conversation_id | integer | 是 | 会话ID
device_sn | integer | 是 | 设备SN
msg_id | integer | 是 | 消息ID
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 发送消息
## 基本信息
POST /message/send
PUT /message/send
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送消息
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"transaction_id ":12345, //请求ID，用于消息去重， 如果短时间内收到2个相同transaction_id的请求，第二次请求不会被执行。 如果不设置就不会被去重
"type":1, //目标类型，1 - 普通用户，2 - 群组
"from_user_id":1, //发送者的用户ID
"targets":[123,456], //接受者的用户ID，或者群ID 列表。
"content_type":0, //消息类型 TEXT = 0;IMAGE = 1;AUDIO = 2;VIDEO = 3;FILE = 4;LOCATION = 5;COMMAND = 6;FORWARD = 7;
"content":"<content>"，//消息内容
"ext":"<ext info>", //扩展信息
"config":"<config info>", //SDK 使用的配置信息
"attachment":"<attachment>" //附件信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 发送系统通知
### 基本信息
POST /message/notify
PUT /message/notify
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
发送系统通知。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"transaction_id ":12345, //请求ID，用于消息去重， 如果短时间内收到2个相同transaction_id的请求，第二次请求不会被执行。 如果不设置就不会被去重
"type":1, //目标类型，1 - 普通用户，2 - 群组
"from_user_id":1, //发送者的用户ID
"targets":[123,456], //接受者的用户ID，或者群ID 列表。
"content_type":0, //消息类型 TEXT = 0;IMAGE = 1;AUDIO = 2;VIDEO = 3;FILE = 4;LOCATION = 5;COMMAND = 6;FORWARD = 7;
"content":"<content>"，//消息内容
"ext":"<ext info>", //扩展信息
"config":"<config info>", //SDK 使用的配置信息
"attachment":"<attachment>" //附件信息
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
# 撤回消息
### 基本信息
POST /message/recall
PUT /message/recall
Host: <api-endpoint>
Content-Type: application/json
### 接口描述
撤回消息。
## 请求参数
### Headers
参数名称 | 参数类型 | 必填 | 备注
---|---|---|---
access-token | string | 否 | 令牌
app_id | int64 | 是 | 应用ID
group_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### Body
{
"conversation_id":12345, //会话ID
"msg_id":1 //消息ID
}
## 返回数据
{
"code": 200, //返回码，200 表示成功
"message": "<error message>", //错误信息。如果成功，该字段为空。
"data": true //返回结果，true 成功
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,406 |
文件操作接口 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
文件操作接口
# 文件操作接口
最近更新时间: 2021-06-29 09:50:10
# 文件操作接口
## 下载头像
### 基本信息
**Path：** /file/download/avatar
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
image_type | 否 | | 图片类型，1: 原图，2: 缩略图, 3: 封面图
object_name | 是 | | 对象名
sdk_sign | 否 | | SDK的签名
store_token | 否 | | 文件token
thumbnail_strategy | 否 | | 缩略图生成策略, 1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
## 下载聊天文件
### 基本信息
**Path：** /file/download/chat
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_sign | 是 | | 文件签名
format | 否 | | 需要下载的音频文件格式amr/mp3 默认为amr
image_type | 否 | | 图片类型，1: 原图，2: 缩略图, 3: 封面图
sdk_sign | 否 | | SDK的签名
source | 否 | | 请求来源, miniprogram - 小程序，默认值是 ‘’
store_token | 否 | | 文件token
thumbnail_strategy | 否 | | 缩略图生成策略, 1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
## 获取上传用户头像URL
### 基本信息
**Path：** /file/upload/avatar/user
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取上传群头像URL
### 基本信息
**Path：** /file/upload/avatar/group
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
group_id | 是 | | group_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取上传聊天文件的URL
### 基本信息
**Path：** /file/upload/chat
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_type | 是 | | 文件类型 100: 普通聊天文件, 101: 语音聊天文件(amr格式),102: 图片聊天文件, 103: 视频聊天文件, 104: 语音聊天文件(mp3格式)200: 普通共享文件, 201: 语音共享文件, 202: 图片共享文件, 203: 视频共享文件
to_id | 是 | | to_id
to_type | 否 | | 1: 用户，2: 群组
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取聊天文件转发的URL
### 基本信息
**Path：** /file/upload/forward
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_sign | 是 | | 文件签名
to_id | 是 | | to_id
to_type | 否 | | 1: 用户，2: 群组
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| string| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
文件操作接口
# 文件操作接口
最近更新时间: 2021-06-29 09:50:10
# 文件操作接口
## 下载头像
### 基本信息
**Path：** /file/download/avatar
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
image_type | 否 | | 图片类型，1: 原图，2: 缩略图, 3: 封面图
object_name | 是 | | 对象名
sdk_sign | 否 | | SDK的签名
store_token | 否 | | 文件token
thumbnail_strategy | 否 | | 缩略图生成策略, 1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
## 下载聊天文件
### 基本信息
**Path：** /file/download/chat
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_sign | 是 | | 文件签名
format | 否 | | 需要下载的音频文件格式amr/mp3 默认为amr
image_type | 否 | | 图片类型，1: 原图，2: 缩略图, 3: 封面图
sdk_sign | 否 | | SDK的签名
source | 否 | | 请求来源, miniprogram - 小程序，默认值是 ‘’
store_token | 否 | | 文件token
thumbnail_strategy | 否 | | 缩略图生成策略, 1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
## 获取上传用户头像URL
### 基本信息
**Path：** /file/upload/avatar/user
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取上传群头像URL
### 基本信息
**Path：** /file/upload/avatar/group
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
group_id | 是 | | group_id
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取上传聊天文件的URL
### 基本信息
**Path：** /file/upload/chat
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_type | 是 | | 文件类型 100: 普通聊天文件, 101: 语音聊天文件(amr格式),102: 图片聊天文件, 103: 视频聊天文件, 104: 语音聊天文件(mp3格式)200: 普通共享文件, 201: 语音共享文件, 202: 图片共享文件, 203: 视频共享文件
to_id | 是 | | to_id
to_type | 否 | | 1: 用户，2: 群组
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | |
├─ download_url| string| 非必须| | |
├─ oss_body_param| object| 非必须| | |
├─ upload_url| string| 非必须| | |
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取聊天文件转发的URL
### 基本信息
**Path：** /file/upload/forward
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
file_sign | 是 | | 文件签名
to_id | 是 | | to_id
to_type | 否 | | 1: 用户，2: 群组
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| string| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,419 |
推送接口 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
推送接口
# 推送接口
最近更新时间: 2021-06-29 09:50:23
# 推送接口
## 发推送通知
### 基本信息
**Path：** /push/notify
**Method：** POST
**接口描述：**
发送推送通知需要在管理后台开通推送功能。
具体请求参数可以参考Model里的定义。
常用请求格式如下:
1. 推送文本给所有设备
{
“audience”: “all”,
“message”: {
“type”: “text”,
“title”: “this is push title”,
“body”: “this is push body”
}
}
2. 推送图片给push_token为token1或token2的设备
{
“audience”: {“push_token”:[“token1”,“token2”]},
“message”: {
“type”: “image”,
“title”: “this is push title”,
“body”: “this is push body”,
“attachment_url”: “https://xxx.com/images/1.jpg”
}
}
3. 推送透传消息给标签为beijing或shanghai的所有设备，透传消息不会展示到通知栏上
{
“audience”: {“tag”:[“beijing”,“shanghai”]},
“message”: {
“type”: “cmd”,
“title”: “this is push title”,
“body”: “this is push body”,
“ext”: {“key1”: 12345, “key2”: “xxx” }
}
}
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
audience| object| 非必须| | 推送目标, 不可为空。类型为字符串或JSONObject: "all", 表示发给所有设备 {"tag":["tag1","tag2"]} 表示发给标签为tag1或tag2的设备 {"alias":["alias1","alias2"]} 表示发给别名为alias1或alias2的设备 {"user_id":[111,222]} 表示发给用户ID为111或222的设备 {"push_token":["push_token1","push_token2"]} 表示发给PushToken为push_token1或push_token2的设备 使用标签/别名/用户ID/pushToken推送时，列表长度不能超过500 |
setting| object| 非必须| | 推送设置, 可为空|
├─ request_id| string| 非必须| | 请求ID，用于请求去重，如果请求ID以前出现过，则不推送。可为空，为空则不去重。|
message| object| 非必须| | 推送消息体|
├─ type| string| 非必须| | 消息类型：text - 文本，image - 图片， cmd - 透传消息。可为空，为空则默认为text| 枚举: text|image|cmd
├─ title| string| 非必须| | 标题。可为空|
├─ body| string| 非必须| | 内容。可为空|
├─ attachment_url| string| 非必须| | 附件地址: 图片/音频/视频的URL地址。可为空。如果是图片地址，需要以jpg/jpeg/png结尾，图片大小需小于1M,推荐876*324px|
├─ badge| string| 非必须| | 应用角标: 如果为数字，则修改角标为此数字；如果以+开头，表示增加此数字到角标，如"+1", 表示角标数加1;如果为空，默认为"+1"|
├─ ext| object| 非必须| | 扩展字段:可为空，类型为JSONObject, 例如: {"key1":123, "key2":"value2"}|
├─ show_begin_time| integer| 非必须| | 定时展示的开始时间戳(秒), 为空时表示立即展示| format: int64
├─ show_end_time| integer| 非必须| | 定时展示的结束时间戳(秒)，可为空| format: int64
├─ ios| object| 非必须| | ios平台额外参数，可为空|
├─ sound| string| 非必须| | 通知提示声音， 可为空|
├─ content_available| boolean| 非必须| | 对应APNs的content-available，可为空|
├─ mutable_content| boolean| 非必须| | 对应APNs的mutable-content， 可为空|
├─ category| string| 非必须| | 对应APNs Payload中的category， 可为空|
├─ thread_id| string| 非必须| | 对应APNs的thread-id，可为空，通过该属性来对通知进行分组，相同thread-id 的通知归为一组|
├─ android| object| 非必须| | android平台额外参数，可为空|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ huawei| object| 非必须| | huawei厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ badge_class| string| 非必须| | 桌面图标对应的应用入口Activity类， 比如 com.test.badge.MainActivity， 可为空|
├─ xiaomi| object| 非必须| | xiaomi厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ oppo| object| 非必须| | oppo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ vivo| object| 非必须| | vivo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ push_mode| integer| 非必须| | 推送模式： 0-正式推送；1-测试推送，不填默认为0| format: int32
├─ classification| integer| 非必须| | 消息类型 0：运营类消息，1：系统类消息。不填默认为0| format: int32
├─ flyme| object| 非必须| | 魅族厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ fcm| object| 非必须| | FCM厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取推送证书
### 基本信息
**Path：** /push/certificate
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
environment | 否 | | 运行环境， 0 - 开发环境， 1 - 生产环境 , 默认值：1
provider | 是 | | 证书提供方, 1-APNS，2-华为，3-小米，4-魅族，5-VIVO， 6-OPPO, 7-FCM
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 推送证书信息|
├─ app_id| string| 非必须| | APP ID|
├─ app_key| string| 非必须| | APP KEY|
├─ app_secret| string| 非必须| | APP SECRET|
├─ certificate| string| 非必须| | 证书|
├─ name| string| 必须| | 证书名称|
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
推送接口
# 推送接口
最近更新时间: 2021-06-29 09:50:23
# 推送接口
## 发推送通知
### 基本信息
**Path：** /push/notify
**Method：** POST
**接口描述：**
发送推送通知需要在管理后台开通推送功能。
具体请求参数可以参考Model里的定义。
常用请求格式如下:
1. 推送文本给所有设备
{
“audience”: “all”,
“message”: {
“type”: “text”,
“title”: “this is push title”,
“body”: “this is push body”
}
}
2. 推送图片给push_token为token1或token2的设备
{
“audience”: {“push_token”:[“token1”,“token2”]},
“message”: {
“type”: “image”,
“title”: “this is push title”,
“body”: “this is push body”,
“attachment_url”: “https://xxx.com/images/1.jpg”
}
}
3. 推送透传消息给标签为beijing或shanghai的所有设备，透传消息不会展示到通知栏上
{
“audience”: {“tag”:[“beijing”,“shanghai”]},
“message”: {
“type”: “cmd”,
“title”: “this is push title”,
“body”: “this is push body”,
“ext”: {“key1”: 12345, “key2”: “xxx” }
}
}
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
Content-Type | application/json | 是 | |
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Body**
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
audience| object| 非必须| | 推送目标, 不可为空。类型为字符串或JSONObject: "all", 表示发给所有设备 {"tag":["tag1","tag2"]} 表示发给标签为tag1或tag2的设备 {"alias":["alias1","alias2"]} 表示发给别名为alias1或alias2的设备 {"user_id":[111,222]} 表示发给用户ID为111或222的设备 {"push_token":["push_token1","push_token2"]} 表示发给PushToken为push_token1或push_token2的设备 使用标签/别名/用户ID/pushToken推送时，列表长度不能超过500 |
setting| object| 非必须| | 推送设置, 可为空|
├─ request_id| string| 非必须| | 请求ID，用于请求去重，如果请求ID以前出现过，则不推送。可为空，为空则不去重。|
message| object| 非必须| | 推送消息体|
├─ type| string| 非必须| | 消息类型：text - 文本，image - 图片， cmd - 透传消息。可为空，为空则默认为text| 枚举: text|image|cmd
├─ title| string| 非必须| | 标题。可为空|
├─ body| string| 非必须| | 内容。可为空|
├─ attachment_url| string| 非必须| | 附件地址: 图片/音频/视频的URL地址。可为空。如果是图片地址，需要以jpg/jpeg/png结尾，图片大小需小于1M,推荐876*324px|
├─ badge| string| 非必须| | 应用角标: 如果为数字，则修改角标为此数字；如果以+开头，表示增加此数字到角标，如"+1", 表示角标数加1;如果为空，默认为"+1"|
├─ ext| object| 非必须| | 扩展字段:可为空，类型为JSONObject, 例如: {"key1":123, "key2":"value2"}|
├─ show_begin_time| integer| 非必须| | 定时展示的开始时间戳(秒), 为空时表示立即展示| format: int64
├─ show_end_time| integer| 非必须| | 定时展示的结束时间戳(秒)，可为空| format: int64
├─ ios| object| 非必须| | ios平台额外参数，可为空|
├─ sound| string| 非必须| | 通知提示声音， 可为空|
├─ content_available| boolean| 非必须| | 对应APNs的content-available，可为空|
├─ mutable_content| boolean| 非必须| | 对应APNs的mutable-content， 可为空|
├─ category| string| 非必须| | 对应APNs Payload中的category， 可为空|
├─ thread_id| string| 非必须| | 对应APNs的thread-id，可为空，通过该属性来对通知进行分组，相同thread-id 的通知归为一组|
├─ android| object| 非必须| | android平台额外参数，可为空|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ huawei| object| 非必须| | huawei厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ badge_class| string| 非必须| | 桌面图标对应的应用入口Activity类， 比如 com.test.badge.MainActivity， 可为空|
├─ xiaomi| object| 非必须| | xiaomi厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ oppo| object| 非必须| | oppo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ vivo| object| 非必须| | vivo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ push_mode| integer| 非必须| | 推送模式： 0-正式推送；1-测试推送，不填默认为0| format: int32
├─ classification| integer| 非必须| | 消息类型 0：运营类消息，1：系统类消息。不填默认为0| format: int32
├─ flyme| object| 非必须| | 魅族厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
├─ fcm| object| 非必须| | FCM厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性|
├─ sound| string| 非必须| | 通知提示声音，可为空|
├─ channel_id| string| 非必须| | 通知栏通道，可为空|
├─ click_action| string| 非必须| | 点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空| 枚举: intent|open_app
├─ intent| string| 非必须| | 点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end|
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| boolean| 非必须| | 结果数据|
message| string| 非必须| | 错误信息，如果成功，该项为null|
## 获取推送证书
### 基本信息
**Path：** /push/certificate
**Method：** GET
**接口描述：**
### 请求参数
**Headers**
参数名称 | 参数值 | 是否必须 | 示例 | 备注
---|---|---|---|---
access-token | | 否 | | 令牌
app_id | | 是 | | 应用ID
group_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口
user_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口
**Query**
参数名称 | 是否必须 | 示例 | 备注
---|---|---|---
environment | 否 | | 运行环境， 0 - 开发环境， 1 - 生产环境 , 默认值：1
provider | 是 | | 证书提供方, 1-APNS，2-华为，3-小米，4-魅族，5-VIVO， 6-OPPO, 7-FCM
### 返回数据
名称| 类型| 是否必须| 默认值| 备注| 其他信息
---|---|---|---|---|---
code| integer| 非必须| | 返回码，200是成功| format: int32
data| object| 非必须| | 推送证书信息|
├─ app_id| string| 非必须| | APP ID|
├─ app_key| string| 非必须| | APP KEY|
├─ app_secret| string| 非必须| | APP SECRET|
├─ certificate| string| 非必须| | 证书|
├─ name| string| 必须| | 证书名称|
message| string| 非必须| | 错误信息，如果成功，该项为null|
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,429 |
状态回调 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
状态回调
# 状态回调
最近更新时间: 2022-01-19 18:37:32
# 用户状态回调
通过注册用户在线状态回调，系统会将应用内用户的在线状态变更事件，实时抄送到设定的服务器。
开通IM 商业版后，可以在Portal 后台，IM管理页面的【高级功能】部分，开启【信息订阅定制】服务。并设置用户在线状态回调地址。
用户系统可以根据该事件，作为一些自己业务的触发。
## 回调的方法
系统通过HTTP POST 方法，调用所设置的HTTP 接口。
## 回调的消息格式
回调消息，通过JSON 字符串的形式，在Body 中传递。使用UTF-8 编码。消息样例如下：
{
"timestamp": "1621838541791", //事件时间戳（毫秒）
"node": "[email protected]", //事件产生的节点
"xid": {
"uid": "6597439728320", // 用户ID
"deviceSN": 125171 // 用户设备序号
},
"status": "ONLINE", // ONLINE表示上线，OFFLINE表示下线
"reason": "", // 原因： replaced 表示设备被其它设备踢下线
"ip": "10.244.1.1:65167", // 客户端IP
"version": "3.0.2", // 客户端SDK版本号
"appId": "eajzxtgmgets" // APPID
}
## 回调接口返回
收到，并成功处理消息回调后，接口应该返回 HTTP 状态码 200。
# 消息回调
通过注册系统回调，实时订阅用户消息。系统将会将应用内用户发送的消息实时抄送到设定的服务器。
此功能可被用来作为应用消息的转存，或者作为其他业务的触发机制。
开通商业版后，可以在Portal 管理后台，IM管理页面的【信息订阅定制】部分，配置【用户消息回调地址】来接收消息回调。
请确保接收服务器的可用性，如果指定服务不可用或者网络原因中断，系统会尝试推送三次，如果仍然不可推送，会将消息存入失败队列，失败队列内消息默认存放三天，可以通过接口轮询获取。
## 回调的方法
系统通过HTTP POST 方法，调用所设置的HTTP 接口。
## 回调的消息格式
回调消息，通过JSON 字符串的形式，在Body 中传递。使用UTF-8 编码。消息样例如下：
{
"timestamp": "1583290166510", // 时间戳字符串类型
"node": "[email protected]", // 消息发送节点
"from": { // 消息发送者
"deviceSN": 393585
"uid": "6597271396128",
},
"to": { // 消息接收者
"uid": "6597321892992"
},
"type": "CHAT", // 消息类型, 单聊: CHAT; 群聊: GROUPCHAT
"msgId": "711785029071536147", // 消息ID
"innerFrom": { // 消息实际发送者, TYPE为GROUPCHAT
"uid": "6597271396128",
"deviceSN": 393585
},
"innerTo": {
"uid": "6597321892992"
},
"content": "hello, callback!", // 消息内容
"metaTimestamp": "1583290166473",
"appId": "welovemaxim" // 消息appId
}
## 回调接口返回
收到，并成功处理消息回调后，接口应该返回 HTTP 状态码 200。
# 内容安全加强回调
使用内容安全加强回调，对接第三方内容安全服务，高效过滤色情、广告、涉政、暴恐等多类垃圾文字及敏感词、违禁变种。实现协同过滤的目的。
内容安全加强回调功能，可以在开通商业版后开通。在Portal
后台,IM管理页面的【高级功能】部分，开启【内容安全加强】功能，并配置内容安全的回调地址，账号信息。
系统默认可以使用阿里云的内容安全服务。
如果应用希望定制自己的过滤关键词，或者使用已经调校过的第三方内容安全服务，可以在第三方服务注册后在此配置开通。
## 自定义安全接口实现规范
如果用户设置自己的内容安全服务，需要实现一个服务兼容阿里云盾的接口即可。具体可以参考：
* [文本垃圾内容检测 __](https://help.aliyun.com/document_detail/70439.html)
* [图片同步检测 __](https://help.aliyun.com/document_detail/70292.html)
* [公共参数 __](https://help.aliyun.com/document_detail/53413.html)
* [签名机制 __](https://help.aliyun.com/document_detail/53415.html)
该回调，在系统收到用户发送的消息，实际投递之前进行回调。当接口返回的Suggestion 是 “block”，则系统将不会最终发送改消息。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
状态回调
# 状态回调
最近更新时间: 2022-01-19 18:37:32
# 用户状态回调
通过注册用户在线状态回调，系统会将应用内用户的在线状态变更事件，实时抄送到设定的服务器。
开通IM 商业版后，可以在Portal 后台，IM管理页面的【高级功能】部分，开启【信息订阅定制】服务。并设置用户在线状态回调地址。
用户系统可以根据该事件，作为一些自己业务的触发。
## 回调的方法
系统通过HTTP POST 方法，调用所设置的HTTP 接口。
## 回调的消息格式
回调消息，通过JSON 字符串的形式，在Body 中传递。使用UTF-8 编码。消息样例如下：
{
"timestamp": "1621838541791", //事件时间戳（毫秒）
"node": "[email protected]", //事件产生的节点
"xid": {
"uid": "6597439728320", // 用户ID
"deviceSN": 125171 // 用户设备序号
},
"status": "ONLINE", // ONLINE表示上线，OFFLINE表示下线
"reason": "", // 原因： replaced 表示设备被其它设备踢下线
"ip": "10.244.1.1:65167", // 客户端IP
"version": "3.0.2", // 客户端SDK版本号
"appId": "eajzxtgmgets" // APPID
}
## 回调接口返回
收到，并成功处理消息回调后，接口应该返回 HTTP 状态码 200。
# 消息回调
通过注册系统回调，实时订阅用户消息。系统将会将应用内用户发送的消息实时抄送到设定的服务器。
此功能可被用来作为应用消息的转存，或者作为其他业务的触发机制。
开通商业版后，可以在Portal 管理后台，IM管理页面的【信息订阅定制】部分，配置【用户消息回调地址】来接收消息回调。
请确保接收服务器的可用性，如果指定服务不可用或者网络原因中断，系统会尝试推送三次，如果仍然不可推送，会将消息存入失败队列，失败队列内消息默认存放三天，可以通过接口轮询获取。
## 回调的方法
系统通过HTTP POST 方法，调用所设置的HTTP 接口。
## 回调的消息格式
回调消息，通过JSON 字符串的形式，在Body 中传递。使用UTF-8 编码。消息样例如下：
{
"timestamp": "1583290166510", // 时间戳字符串类型
"node": "[email protected]", // 消息发送节点
"from": { // 消息发送者
"deviceSN": 393585
"uid": "6597271396128",
},
"to": { // 消息接收者
"uid": "6597321892992"
},
"type": "CHAT", // 消息类型, 单聊: CHAT; 群聊: GROUPCHAT
"msgId": "711785029071536147", // 消息ID
"innerFrom": { // 消息实际发送者, TYPE为GROUPCHAT
"uid": "6597271396128",
"deviceSN": 393585
},
"innerTo": {
"uid": "6597321892992"
},
"content": "hello, callback!", // 消息内容
"metaTimestamp": "1583290166473",
"appId": "welovemaxim" // 消息appId
}
## 回调接口返回
收到，并成功处理消息回调后，接口应该返回 HTTP 状态码 200。
# 内容安全加强回调
使用内容安全加强回调，对接第三方内容安全服务，高效过滤色情、广告、涉政、暴恐等多类垃圾文字及敏感词、违禁变种。实现协同过滤的目的。
内容安全加强回调功能，可以在开通商业版后开通。在Portal
后台,IM管理页面的【高级功能】部分，开启【内容安全加强】功能，并配置内容安全的回调地址，账号信息。
系统默认可以使用阿里云的内容安全服务。
如果应用希望定制自己的过滤关键词，或者使用已经调校过的第三方内容安全服务，可以在第三方服务注册后在此配置开通。
## 自定义安全接口实现规范
如果用户设置自己的内容安全服务，需要实现一个服务兼容阿里云盾的接口即可。具体可以参考：
* [文本垃圾内容检测 __](https://help.aliyun.com/document_detail/70439.html)
* [图片同步检测 __](https://help.aliyun.com/document_detail/70292.html)
* [公共参数 __](https://help.aliyun.com/document_detail/53413.html)
* [签名机制 __](https://help.aliyun.com/document_detail/53415.html)
该回调，在系统收到用户发送的消息，实际投递之前进行回调。当接口返回的Suggestion 是 “block”，则系统将不会最终发送改消息。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,442 |
iOS API 参考 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > iOS API 参考
# iOS API 参考
最近更新时间: 2021-07-16 09:25:06
IM iOS API 参考。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > iOS API 参考
# iOS API 参考
最近更新时间: 2021-07-16 09:25:06
IM iOS API 参考。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,447 |
Protocol List 协议列表 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Protocol
List 协议列表
# Protocol List 协议列表
最近更新时间: 2021-07-16 09:26:56
协议列表
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Protocol
List 协议列表
# Protocol List 协议列表
最近更新时间: 2021-07-16 09:26:56
协议列表
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,448 |
QNIMRosterServiceProtocol好友监听 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMRosterServiceProtocol好友监听
# QNIMRosterServiceProtocol好友监听
最近更新时间: 2021-07-15 19:03:18
# QNIMRosterServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMRosterServiceProtocol.h
### `- friendAddedSponsorId:recipientId:`
添加好友
`- (void)friendAddedSponsorId:(long long) _sponsorId_ recipientId:(long long)
_recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
添加好友
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendRemovedSponsorId:recipientId:`
删除好友
* 用户B删除与用户A的好友关系后，用户A会收到这个回调
`- (void)friendRemovedSponsorId:(long long) _sponsorId_ recipientId:(long
long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
删除好友
* 用户B删除与用户A的好友关系后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidRecivedAppliedSponsorId:recipientId:message:`
* 收到加好友申请
* 用户B申请加A为好友后，用户A会收到这个回调
`- (void)friendDidRecivedAppliedSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_ message:(NSString *) _message_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
message | 好友邀请信息
#### Discussion
* 收到加好友申请
* 用户B申请加A为好友后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidApplicationAcceptedFromSponsorId:recipientId:`
* 加好友申请被通过了
* 用户B同意用户A的加好友请求后，用户A会收到这个回调
`- (void)friendDidApplicationAcceptedFromSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 加好友申请被通过了
* 用户B同意用户A的加好友请求后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidApplicationDeclinedFromSponsorId:recipientId:reson:`
* 加好友申请被拒绝了
* 用户B拒绝用户A的加好友请求后，用户A会收到这个回调
`- (void)friendDidApplicationDeclinedFromSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_ reson:(NSString *) _reason_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
reason | 拒绝理由
#### Discussion
* 加好友申请被拒绝了
* 用户B拒绝用户A的加好友请求后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendAddedtoBlockListSponsorId:recipientId:`
* 添加黑名单
`- (void)friendAddedtoBlockListSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 添加黑名单
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendRemovedFromBlockListSponsorId:recipientId:`
* 删除黑名单
`- (void)friendRemovedFromBlockListSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 删除黑名单
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- rosterInfoDidUpdate:`
用户信息更新
`- (void)rosterInfoDidUpdate:(QNIMRoster *) _roster_`
#### Discussion
用户信息更新
#### Declared In
`QNIMRosterServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMRosterServiceProtocol好友监听
# QNIMRosterServiceProtocol好友监听
最近更新时间: 2021-07-15 19:03:18
# QNIMRosterServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMRosterServiceProtocol.h
### `- friendAddedSponsorId:recipientId:`
添加好友
`- (void)friendAddedSponsorId:(long long) _sponsorId_ recipientId:(long long)
_recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
添加好友
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendRemovedSponsorId:recipientId:`
删除好友
* 用户B删除与用户A的好友关系后，用户A会收到这个回调
`- (void)friendRemovedSponsorId:(long long) _sponsorId_ recipientId:(long
long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
删除好友
* 用户B删除与用户A的好友关系后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidRecivedAppliedSponsorId:recipientId:message:`
* 收到加好友申请
* 用户B申请加A为好友后，用户A会收到这个回调
`- (void)friendDidRecivedAppliedSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_ message:(NSString *) _message_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
message | 好友邀请信息
#### Discussion
* 收到加好友申请
* 用户B申请加A为好友后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidApplicationAcceptedFromSponsorId:recipientId:`
* 加好友申请被通过了
* 用户B同意用户A的加好友请求后，用户A会收到这个回调
`- (void)friendDidApplicationAcceptedFromSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 加好友申请被通过了
* 用户B同意用户A的加好友请求后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendDidApplicationDeclinedFromSponsorId:recipientId:reson:`
* 加好友申请被拒绝了
* 用户B拒绝用户A的加好友请求后，用户A会收到这个回调
`- (void)friendDidApplicationDeclinedFromSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_ reson:(NSString *) _reason_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
reason | 拒绝理由
#### Discussion
* 加好友申请被拒绝了
* 用户B拒绝用户A的加好友请求后，用户A会收到这个回调
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendAddedtoBlockListSponsorId:recipientId:`
* 添加黑名单
`- (void)friendAddedtoBlockListSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 添加黑名单
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- friendRemovedFromBlockListSponsorId:recipientId:`
* 删除黑名单
`- (void)friendRemovedFromBlockListSponsorId:(long long) _sponsorId_
recipientId:(long long) _recipientId_`
#### Parameters
sponsorId | 发起方
---|---
recipientId | 接受方
#### Discussion
* 删除黑名单
#### Declared In
`QNIMRosterServiceProtocol.h`
### `- rosterInfoDidUpdate:`
用户信息更新
`- (void)rosterInfoDidUpdate:(QNIMRoster *) _roster_`
#### Discussion
用户信息更新
#### Declared In
`QNIMRosterServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,449 |
QNIMGroupServiceProtocol群组监听 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMGroupServiceProtocol群组监听
# QNIMGroupServiceProtocol群组监听
最近更新时间: 2021-07-15 19:07:01
# QNIMGroupServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupServiceProtocol.h
### `- groupDidCreated:` required method
多设备同步创建群组
`- (void)groupDidCreated:(QNIMGroup *) _group_`
#### Discussion
多设备同步创建群组
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupLeft:reason:` required method
退出了某群
`- (void)groupLeft:(QNIMGroup *) _group_ reason:(NSString *) _reason_`
#### Discussion
退出了某群
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupDidRecieveInviter:groupId:message:` required method
收到入群邀请
`- (void)groupDidRecieveInviter:(NSInteger) _inviter_ groupId:(NSInteger)
_groupId_ message:(NSString *) _message_`
#### Discussion
收到入群邀请
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInvitationAccepted:inviteeId:` required method
入群邀请被接受
`- (void)groupInvitationAccepted:(QNIMGroup *) _group_ inviteeId:(NSInteger)
_inviteeId_`
#### Discussion
入群邀请被接受
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInvitationDeclined:inviteeId:reason:` required method
入群申请被拒绝
`- (void)groupInvitationDeclined:(QNIMGroup *) _group_ inviteeId:(NSInteger)
_inviteeId_ reason:(NSString *) _reason_`
#### Discussion
入群申请被拒绝
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupDidRecieveApplied:applicantId:message:` required method
收到入群申请
`- (void)groupDidRecieveApplied:(QNIMGroup *) _group_ applicantId:(NSInteger)
_applicantId_ message:(NSString *) _message_`
#### Discussion
收到入群申请
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupApplicationAccepted:approver:` required method
入群申请被接受
`- (void)groupApplicationAccepted:(QNIMGroup *) _group_ approver:(NSInteger)
_approver_`
#### Discussion
入群申请被接受
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupApplicationDeclined:approver:reason:` required method
入群申请被拒绝
`- (void)groupApplicationDeclined:(QNIMGroup *) _group_ approver:(NSInteger)
_approver_ reason:(NSString *) _reason_`
#### Discussion
入群申请被拒绝
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMembersMutedGroup:members:duration:` required method
群成员被禁言
`- (void)groupMembersMutedGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_ duration:(NSInteger) _duration_`
#### Discussion
群成员被禁言
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMembersUnMutedGroup:Unmuted:` required method
群成员被解除禁言
`- (void)groupMembersUnMutedGroup:(QNIMGroup *) _group_
Unmuted:(NSArray<NSNumber*> *) _members_`
#### Discussion
群成员被解除禁言
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberJoined:memberId:inviter:` required method
加入新成员
`- (void)groupMemberJoined:(QNIMGroup *) _group_ memberId:(NSInteger)
_memberId_ inviter:(NSInteger) _inviter_`
#### Discussion
加入新成员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberLeft:memberId:reason:` required method
群成员退出
`- (void)groupMemberLeft:(QNIMGroup *) _group_ memberId:(NSInteger) _memberId_
reason:(NSString *) _reason_`
#### Discussion
群成员退出
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAdminsAddedGroup:members:` required method
添加了新管理员
`- (void)groupAdminsAddedGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_`
#### Discussion
添加了新管理员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAdminsRemovedFromGroup:members:reason:` required method
移除了管理员
`- (void)groupAdminsRemovedFromGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_ reason:(NSString *) _reason_`
#### Discussion
移除了管理员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupOwnerAssigned:` required method
成为群主
`- (void)groupOwnerAssigned:(QNIMGroup *) _group_`
#### Discussion
成为群主
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInfoDidUpdate:updateInfoType:` required method
群组信息变更
`- (void)groupInfoDidUpdate:(QNIMGroup *) _group_
updateInfoType:(QNIMGroupUpdateInfoType) _type_`
#### Discussion
群组信息变更
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberDidChangeNickName:memberId:nickName:` required method
群成员更改群内昵称
`- (void)groupMemberDidChangeNickName:(QNIMGroup *) _group_ memberId:(long
long) _memberId_ nickName:(NSString *) _nickName_`
#### Discussion
群成员更改群内昵称
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAnnouncementUpdate:announcement:` required method
收到群公告
`- (void)groupAnnouncementUpdate:(QNIMGroup *) _group_
announcement:(QNIMGroupAnnounment *) _announcement_`
#### Discussion
收到群公告
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupSharedFileUploaded:sharedFile:` required method
收到共享文件
`- (void)groupSharedFileUploaded:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
收到共享文件
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupSharedFileDeleted:sharedFile:` required method
删除了共享文件
`- (void)groupSharedFileDeleted:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
删除了共享文件
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupShareFileDidUpdated:sharedFile:` required method
共享文件更新文件名
`- (void)groupShareFileDidUpdated:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
共享文件更新文件名
#### Declared In
`QNIMGroupServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMGroupServiceProtocol群组监听
# QNIMGroupServiceProtocol群组监听
最近更新时间: 2021-07-15 19:07:01
# QNIMGroupServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupServiceProtocol.h
### `- groupDidCreated:` required method
多设备同步创建群组
`- (void)groupDidCreated:(QNIMGroup *) _group_`
#### Discussion
多设备同步创建群组
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupLeft:reason:` required method
退出了某群
`- (void)groupLeft:(QNIMGroup *) _group_ reason:(NSString *) _reason_`
#### Discussion
退出了某群
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupDidRecieveInviter:groupId:message:` required method
收到入群邀请
`- (void)groupDidRecieveInviter:(NSInteger) _inviter_ groupId:(NSInteger)
_groupId_ message:(NSString *) _message_`
#### Discussion
收到入群邀请
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInvitationAccepted:inviteeId:` required method
入群邀请被接受
`- (void)groupInvitationAccepted:(QNIMGroup *) _group_ inviteeId:(NSInteger)
_inviteeId_`
#### Discussion
入群邀请被接受
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInvitationDeclined:inviteeId:reason:` required method
入群申请被拒绝
`- (void)groupInvitationDeclined:(QNIMGroup *) _group_ inviteeId:(NSInteger)
_inviteeId_ reason:(NSString *) _reason_`
#### Discussion
入群申请被拒绝
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupDidRecieveApplied:applicantId:message:` required method
收到入群申请
`- (void)groupDidRecieveApplied:(QNIMGroup *) _group_ applicantId:(NSInteger)
_applicantId_ message:(NSString *) _message_`
#### Discussion
收到入群申请
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupApplicationAccepted:approver:` required method
入群申请被接受
`- (void)groupApplicationAccepted:(QNIMGroup *) _group_ approver:(NSInteger)
_approver_`
#### Discussion
入群申请被接受
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupApplicationDeclined:approver:reason:` required method
入群申请被拒绝
`- (void)groupApplicationDeclined:(QNIMGroup *) _group_ approver:(NSInteger)
_approver_ reason:(NSString *) _reason_`
#### Discussion
入群申请被拒绝
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMembersMutedGroup:members:duration:` required method
群成员被禁言
`- (void)groupMembersMutedGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_ duration:(NSInteger) _duration_`
#### Discussion
群成员被禁言
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMembersUnMutedGroup:Unmuted:` required method
群成员被解除禁言
`- (void)groupMembersUnMutedGroup:(QNIMGroup *) _group_
Unmuted:(NSArray<NSNumber*> *) _members_`
#### Discussion
群成员被解除禁言
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberJoined:memberId:inviter:` required method
加入新成员
`- (void)groupMemberJoined:(QNIMGroup *) _group_ memberId:(NSInteger)
_memberId_ inviter:(NSInteger) _inviter_`
#### Discussion
加入新成员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberLeft:memberId:reason:` required method
群成员退出
`- (void)groupMemberLeft:(QNIMGroup *) _group_ memberId:(NSInteger) _memberId_
reason:(NSString *) _reason_`
#### Discussion
群成员退出
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAdminsAddedGroup:members:` required method
添加了新管理员
`- (void)groupAdminsAddedGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_`
#### Discussion
添加了新管理员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAdminsRemovedFromGroup:members:reason:` required method
移除了管理员
`- (void)groupAdminsRemovedFromGroup:(QNIMGroup *) _group_
members:(NSArray<NSNumber*> *) _members_ reason:(NSString *) _reason_`
#### Discussion
移除了管理员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupOwnerAssigned:` required method
成为群主
`- (void)groupOwnerAssigned:(QNIMGroup *) _group_`
#### Discussion
成为群主
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupInfoDidUpdate:updateInfoType:` required method
群组信息变更
`- (void)groupInfoDidUpdate:(QNIMGroup *) _group_
updateInfoType:(QNIMGroupUpdateInfoType) _type_`
#### Discussion
群组信息变更
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberDidChangeNickName:memberId:nickName:` required method
群成员更改群内昵称
`- (void)groupMemberDidChangeNickName:(QNIMGroup *) _group_ memberId:(long
long) _memberId_ nickName:(NSString *) _nickName_`
#### Discussion
群成员更改群内昵称
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupAnnouncementUpdate:announcement:` required method
收到群公告
`- (void)groupAnnouncementUpdate:(QNIMGroup *) _group_
announcement:(QNIMGroupAnnounment *) _announcement_`
#### Discussion
收到群公告
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupSharedFileUploaded:sharedFile:` required method
收到共享文件
`- (void)groupSharedFileUploaded:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
收到共享文件
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupSharedFileDeleted:sharedFile:` required method
删除了共享文件
`- (void)groupSharedFileDeleted:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
删除了共享文件
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupShareFileDidUpdated:sharedFile:` required method
共享文件更新文件名
`- (void)groupShareFileDidUpdated:(QNIMGroup *) _group_
sharedFile:(QNIMGroupSharedFile *) _sharedFile_`
#### Discussion
共享文件更新文件名
#### Declared In
`QNIMGroupServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,454 |
QNIMPushServiceProtocol推送监听 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMPushServiceProtocol推送监听
# QNIMPushServiceProtocol推送监听
最近更新时间: 2021-07-15 18:57:50
# QNIMPushServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMPushServiceProtocol.h
### `- pushStartDidFinished:`
Push初始化完成通知。
`- (void)pushStartDidFinished:(NSString *) _QNIMToken_`
#### Parameters
QNIMToken | QNIMToken
---|---
|
#### Discussion
Push初始化完成通知。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- pushStartDidStopped`
Push功能停止通知。
`- (void)pushStartDidStopped`
#### Discussion
Push功能停止通知。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- certRetrieved:`
Push初始化完成后获取推送证书。
`- (void)certRetrieved:(NSString *) _certification_`
#### Parameters
certification | 推送证书
---|---
|
#### Discussion
Push初始化完成后获取推送证书。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- setTagsDidFinished:`
设置用户推送标签成功回调。
`- (void)setTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
设置用户推送标签成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- getTagsDidFinished:`
获取用户推送标签成功回调。
`- (void)getTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
获取用户推送标签成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- deleteTagsDidFinished:`
删除用户推送标签成功回调
`- (void)deleteTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
删除用户推送标签成功回调
#### Declared In
`QNIMPushServiceProtocol.h`
### `- clearedTags:`
清空用户推送成功回调。
`- (void)clearedTags:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
清空用户推送成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- receivedPush:`
接收到新的Push通知
`- (void)receivedPush:(NSArray<QNIMMessageObject*> *) _messages_`
#### Parameters
messages | Push通知列表
---|---
|
#### Discussion
接收到新的Push通知
#### Declared In
`QNIMPushServiceProtocol.h`
### `- pushMessageStatusChanged:error:`
发送Push上行消息状态变化通知。
`- (void)pushMessageStatusChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_`
#### Parameters
message | 发生状态变化的上行消息
---|---
error | 状态错误码
#### Discussion
发送Push上行消息状态变化通知。
#### Declared In
`QNIMPushServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMPushServiceProtocol推送监听
# QNIMPushServiceProtocol推送监听
最近更新时间: 2021-07-15 18:57:50
# QNIMPushServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMPushServiceProtocol.h
### `- pushStartDidFinished:`
Push初始化完成通知。
`- (void)pushStartDidFinished:(NSString *) _QNIMToken_`
#### Parameters
QNIMToken | QNIMToken
---|---
|
#### Discussion
Push初始化完成通知。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- pushStartDidStopped`
Push功能停止通知。
`- (void)pushStartDidStopped`
#### Discussion
Push功能停止通知。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- certRetrieved:`
Push初始化完成后获取推送证书。
`- (void)certRetrieved:(NSString *) _certification_`
#### Parameters
certification | 推送证书
---|---
|
#### Discussion
Push初始化完成后获取推送证书。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- setTagsDidFinished:`
设置用户推送标签成功回调。
`- (void)setTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
设置用户推送标签成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- getTagsDidFinished:`
获取用户推送标签成功回调。
`- (void)getTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
获取用户推送标签成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- deleteTagsDidFinished:`
删除用户推送标签成功回调
`- (void)deleteTagsDidFinished:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
删除用户推送标签成功回调
#### Declared In
`QNIMPushServiceProtocol.h`
### `- clearedTags:`
清空用户推送成功回调。
`- (void)clearedTags:(NSString *) _operationId_`
#### Parameters
operationId | 操作id
---|---
|
#### Discussion
清空用户推送成功回调。
#### Declared In
`QNIMPushServiceProtocol.h`
### `- receivedPush:`
接收到新的Push通知
`- (void)receivedPush:(NSArray<QNIMMessageObject*> *) _messages_`
#### Parameters
messages | Push通知列表
---|---
|
#### Discussion
接收到新的Push通知
#### Declared In
`QNIMPushServiceProtocol.h`
### `- pushMessageStatusChanged:error:`
发送Push上行消息状态变化通知。
`- (void)pushMessageStatusChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_`
#### Parameters
message | 发生状态变化的上行消息
---|---
error | 状态错误码
#### Discussion
发送Push上行消息状态变化通知。
#### Declared In
`QNIMPushServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,463 |
QNIMChatServiceProtocol聊天监听 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMChatServiceProtocol聊天监听
# QNIMChatServiceProtocol聊天监听
最近更新时间: 2021-07-15 19:09:39
# QNIMChatServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMChatServiceProtocol.h
### `- messageStatusChanged:error:`
消息发送状态发生变化
`- (void)messageStatusChanged:(QNIMMessageObject *) _message_ error:(QNIMError
*) _error_`
#### Discussion
消息发送状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageAttachmentUploadProgressChanged:percent:`
附件上传进度发送变化
`- (void)messageAttachmentUploadProgressChanged:(QNIMMessageObject *)
_message_ percent:(int) _percent_`
#### Discussion
附件上传进度发送变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageRecallStatusDidChanged:error:`
消息撤回状态发送变化
`- (void)messageRecallStatusDidChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_`
#### Discussion
消息撤回状态发送变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedMessages:`
收到消息
`- (void)receivedMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedCommandMessages:`
收到命令消息
`- (void)receivedCommandMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到命令消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedSystemMessages:`
收到系统通知消息
`- (void)receivedSystemMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到系统通知消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedReadAcks:`
收到消息已读回执
`- (void)receivedReadAcks:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息已读回执
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedDeliverAcks:`
收到消息已送达回执
`- (void)receivedDeliverAcks:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息已送达回执
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedRecallMessages:`
收到撤回消息
`- (void)receivedRecallMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到撤回消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveReadCancelsMessages:`
收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
`- (void)receiveReadCancelsMessages:(NSArray<QNIMMessageObject*> *)
_messages_`
#### Discussion
收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveReadAllMessages:`
收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
`- (void)receiveReadAllMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveDeleteMessages:`
收到删除消息 （多设备同步删除消息）
`- (void)receiveDeleteMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到删除消息 （多设备同步删除消息）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageAttachmentStatusDidChanged:error:percent:`
附件下载状态发生变化
`- (void)messageAttachmentStatusDidChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_ percent:(int) _percent_`
#### Discussion
附件下载状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- retrieveHistoryMessagesConversation:`
拉取历史消息
`- (void)retrieveHistoryMessagesConversation:(QNIMConversation *)
_conversation_`
#### Discussion
拉取历史消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- loadAllConversationDidFinished`
已经加载完未读会话列表
`- (void)loadAllConversationDidFinished`
#### Discussion
已经加载完未读会话列表
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationDidCreatedConversation:message:`
本地创建新会话成功
`- (void)conversationDidCreatedConversation:(QNIMConversation *)
_conversation_ message:(QNIMMessageObject *) _message_`
#### Parameters
conversation | 新创建的本地会话
---|---
message | 会话的最新消息，存在返回不存在返回为空
#### Discussion
本地创建新会话成功
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationDidDeletedConversationId:error:`
删除会话
`- (void)conversationDidDeletedConversationId:(NSInteger) _conversationId_
error:(QNIMError *) _error_`
#### Parameters
conversationId | 删除的本地会话id
---|---
error | 状态错误码
#### Discussion
删除会话
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationTotalCountChanged:`
更新总未读数
`- (void)conversationTotalCountChanged:(NSInteger) _unreadCount_`
#### Parameters
unreadCount | 未读数
---|---
#### Discussion
更新总未读数
#### Declared In
`QNIMChatServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMChatServiceProtocol聊天监听
# QNIMChatServiceProtocol聊天监听
最近更新时间: 2021-07-15 19:09:39
# QNIMChatServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMChatServiceProtocol.h
### `- messageStatusChanged:error:`
消息发送状态发生变化
`- (void)messageStatusChanged:(QNIMMessageObject *) _message_ error:(QNIMError
*) _error_`
#### Discussion
消息发送状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageAttachmentUploadProgressChanged:percent:`
附件上传进度发送变化
`- (void)messageAttachmentUploadProgressChanged:(QNIMMessageObject *)
_message_ percent:(int) _percent_`
#### Discussion
附件上传进度发送变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageRecallStatusDidChanged:error:`
消息撤回状态发送变化
`- (void)messageRecallStatusDidChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_`
#### Discussion
消息撤回状态发送变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedMessages:`
收到消息
`- (void)receivedMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedCommandMessages:`
收到命令消息
`- (void)receivedCommandMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到命令消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedSystemMessages:`
收到系统通知消息
`- (void)receivedSystemMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到系统通知消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedReadAcks:`
收到消息已读回执
`- (void)receivedReadAcks:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息已读回执
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedDeliverAcks:`
收到消息已送达回执
`- (void)receivedDeliverAcks:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息已送达回执
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedRecallMessages:`
收到撤回消息
`- (void)receivedRecallMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到撤回消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveReadCancelsMessages:`
收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
`- (void)receiveReadCancelsMessages:(NSArray<QNIMMessageObject*> *)
_messages_`
#### Discussion
收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveReadAllMessages:`
收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
`- (void)receiveReadAllMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receiveDeleteMessages:`
收到删除消息 （多设备同步删除消息）
`- (void)receiveDeleteMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到删除消息 （多设备同步删除消息）
#### Declared In
`QNIMChatServiceProtocol.h`
### `- messageAttachmentStatusDidChanged:error:percent:`
附件下载状态发生变化
`- (void)messageAttachmentStatusDidChanged:(QNIMMessageObject *) _message_
error:(QNIMError *) _error_ percent:(int) _percent_`
#### Discussion
附件下载状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- retrieveHistoryMessagesConversation:`
拉取历史消息
`- (void)retrieveHistoryMessagesConversation:(QNIMConversation *)
_conversation_`
#### Discussion
拉取历史消息
#### Declared In
`QNIMChatServiceProtocol.h`
### `- loadAllConversationDidFinished`
已经加载完未读会话列表
`- (void)loadAllConversationDidFinished`
#### Discussion
已经加载完未读会话列表
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationDidCreatedConversation:message:`
本地创建新会话成功
`- (void)conversationDidCreatedConversation:(QNIMConversation *)
_conversation_ message:(QNIMMessageObject *) _message_`
#### Parameters
conversation | 新创建的本地会话
---|---
message | 会话的最新消息，存在返回不存在返回为空
#### Discussion
本地创建新会话成功
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationDidDeletedConversationId:error:`
删除会话
`- (void)conversationDidDeletedConversationId:(NSInteger) _conversationId_
error:(QNIMError *) _error_`
#### Parameters
conversationId | 删除的本地会话id
---|---
error | 状态错误码
#### Discussion
删除会话
#### Declared In
`QNIMChatServiceProtocol.h`
### `- conversationTotalCountChanged:`
更新总未读数
`- (void)conversationTotalCountChanged:(NSInteger) _unreadCount_`
#### Parameters
unreadCount | 未读数
---|---
#### Discussion
更新总未读数
#### Declared In
`QNIMChatServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,468 |
QNIMUserServiceProtocol用户监听 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMUserServiceProtocol用户监听
# QNIMUserServiceProtocol用户监听
最近更新时间: 2021-07-15 19:01:21
# QNIMUserServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMUserServiceProtocol.h
### `- connectStatusDidChanged:`
链接状态发生变化
`- (void)connectStatusDidChanged:(QNIMConnectStatus) _status_`
#### Parameters
status | 网络状态
---|---
|
#### Discussion
链接状态发生变化
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userSignIn:`
用户登陆
`- (void)userSignIn:(QNIMUserProfile *) _userProflie_`
#### Parameters
userProflie | 用户信息
---|---
|
#### Discussion
用户登陆
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userSignOut:userId:`
用户登出
`- (void)userSignOut:(QNIMError *) _error_ userId:(long long) _userId_`
#### Parameters
error | 错误码
---|---
|
#### Discussion
用户登出
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userInfoDidUpdated:`
同步用户信息更新（其他设备操作发生用户信息变更）
`- (void)userInfoDidUpdated:(QNIMUserProfile *) _userProflie_`
#### Discussion
同步用户信息更新（其他设备操作发生用户信息变更）
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userOtherDeviceDidSignIn:`
用户在其他设备上登陆
`- (void)userOtherDeviceDidSignIn:(NSInteger) _deviceSN_`
#### Discussion
用户在其他设备上登陆
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userOtherDeviceDidSignOut:`
用户在其他设备上登出
`- (void)userOtherDeviceDidSignOut:(NSInteger) _deviceSN_`
#### Discussion
用户在其他设备上登出
#### Declared In
`QNIMUserServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
List 协议列表](https://developer.qiniu.com/IM/api/8189/protocol-list) >
QNIMUserServiceProtocol用户监听
# QNIMUserServiceProtocol用户监听
最近更新时间: 2021-07-15 19:01:21
# QNIMUserServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMUserServiceProtocol.h
### `- connectStatusDidChanged:`
链接状态发生变化
`- (void)connectStatusDidChanged:(QNIMConnectStatus) _status_`
#### Parameters
status | 网络状态
---|---
|
#### Discussion
链接状态发生变化
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userSignIn:`
用户登陆
`- (void)userSignIn:(QNIMUserProfile *) _userProflie_`
#### Parameters
userProflie | 用户信息
---|---
|
#### Discussion
用户登陆
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userSignOut:userId:`
用户登出
`- (void)userSignOut:(QNIMError *) _error_ userId:(long long) _userId_`
#### Parameters
error | 错误码
---|---
|
#### Discussion
用户登出
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userInfoDidUpdated:`
同步用户信息更新（其他设备操作发生用户信息变更）
`- (void)userInfoDidUpdated:(QNIMUserProfile *) _userProflie_`
#### Discussion
同步用户信息更新（其他设备操作发生用户信息变更）
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userOtherDeviceDidSignIn:`
用户在其他设备上登陆
`- (void)userOtherDeviceDidSignIn:(NSInteger) _deviceSN_`
#### Discussion
用户在其他设备上登陆
#### Declared In
`QNIMUserServiceProtocol.h`
### `- userOtherDeviceDidSignOut:`
用户在其他设备上登出
`- (void)userOtherDeviceDidSignOut:(NSInteger) _deviceSN_`
#### Discussion
用户在其他设备上登出
#### Declared In
`QNIMUserServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,476 |
Class List 类列表 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Class List
类列表
# Class List 类列表
最近更新时间: 2021-07-16 09:25:14
类列表
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Class List
类列表
# Class List 类列表
最近更新时间: 2021-07-16 09:25:14
类列表
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,479 |
QNIMRoster好友 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMRoster好友
# QNIMRoster好友
最近更新时间: 2021-07-16 09:25:21
# QNIMRoster Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMRoster.h
### ` rosterId`
好友Id
`@property (nonatomic, assign, readonly) long long rosterId`
#### Discussion
好友Id
#### Declared In
`QNIMRoster.h`
### ` userName`
好友名
`@property (nonatomic, copy, readonly) NSString *userName`
#### Discussion
好友名
#### Declared In
`QNIMRoster.h`
### ` nickName`
好友昵称
`@property (nonatomic, copy, readonly) NSString *nickName`
#### Discussion
好友昵称
#### Declared In
`QNIMRoster.h`
### ` avatarUrl`
好友头像
`@property (nonatomic, copy, readonly) NSString *avatarUrl`
#### Discussion
好友头像
#### Declared In
`QNIMRoster.h`
### ` avatarPath`
好友头像本地存储路径
`@property (nonatomic, copy, readonly) NSString *avatarPath`
#### Discussion
好友头像本地存储路径
#### Declared In
`QNIMRoster.h`
### ` avatarThumbnailPath`
好友头像缩略图本地存储路径
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailPath`
#### Discussion
好友头像缩略图本地存储路径
#### Declared In
`QNIMRoster.h`
### ` json_PublicInfo`
扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
`@property (nonatomic, copy, readonly) NSString *json_PublicInfo`
#### Discussion
扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
#### Declared In
`QNIMRoster.h`
### ` json_alias`
用户对好友添加的备注等信息
`@property (nonatomic, copy, readonly) NSString *json_alias`
#### Discussion
用户对好友添加的备注等信息
#### Declared In
`QNIMRoster.h`
### ` json_ext`
用户的服务器扩展信息
`@property (nonatomic, copy, readonly) NSString *json_ext`
#### Discussion
用户的服务器扩展信息
#### Declared In
`QNIMRoster.h`
### ` json_localExt`
用户的本地扩展信息
`@property (nonatomic, copy, readonly) NSString *json_localExt`
#### Discussion
用户的本地扩展信息
#### Declared In
`QNIMRoster.h`
### ` isMuteNotification`
是否提醒用户消息
`@property (nonatomic, assign, readonly) BOOL isMuteNotification`
#### Discussion
是否提醒用户消息
#### Declared In
`QNIMRoster.h`
### ` rosterRelation`
联系人关系
`@property (nonatomic, assign, readonly) QNIMRosterRelation rosterRelation`
#### Discussion
联系人关系
#### Declared In
`QNIMRoster.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMRoster好友
# QNIMRoster好友
最近更新时间: 2021-07-16 09:25:21
# QNIMRoster Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMRoster.h
### ` rosterId`
好友Id
`@property (nonatomic, assign, readonly) long long rosterId`
#### Discussion
好友Id
#### Declared In
`QNIMRoster.h`
### ` userName`
好友名
`@property (nonatomic, copy, readonly) NSString *userName`
#### Discussion
好友名
#### Declared In
`QNIMRoster.h`
### ` nickName`
好友昵称
`@property (nonatomic, copy, readonly) NSString *nickName`
#### Discussion
好友昵称
#### Declared In
`QNIMRoster.h`
### ` avatarUrl`
好友头像
`@property (nonatomic, copy, readonly) NSString *avatarUrl`
#### Discussion
好友头像
#### Declared In
`QNIMRoster.h`
### ` avatarPath`
好友头像本地存储路径
`@property (nonatomic, copy, readonly) NSString *avatarPath`
#### Discussion
好友头像本地存储路径
#### Declared In
`QNIMRoster.h`
### ` avatarThumbnailPath`
好友头像缩略图本地存储路径
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailPath`
#### Discussion
好友头像缩略图本地存储路径
#### Declared In
`QNIMRoster.h`
### ` json_PublicInfo`
扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
`@property (nonatomic, copy, readonly) NSString *json_PublicInfo`
#### Discussion
扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
#### Declared In
`QNIMRoster.h`
### ` json_alias`
用户对好友添加的备注等信息
`@property (nonatomic, copy, readonly) NSString *json_alias`
#### Discussion
用户对好友添加的备注等信息
#### Declared In
`QNIMRoster.h`
### ` json_ext`
用户的服务器扩展信息
`@property (nonatomic, copy, readonly) NSString *json_ext`
#### Discussion
用户的服务器扩展信息
#### Declared In
`QNIMRoster.h`
### ` json_localExt`
用户的本地扩展信息
`@property (nonatomic, copy, readonly) NSString *json_localExt`
#### Discussion
用户的本地扩展信息
#### Declared In
`QNIMRoster.h`
### ` isMuteNotification`
是否提醒用户消息
`@property (nonatomic, assign, readonly) BOOL isMuteNotification`
#### Discussion
是否提醒用户消息
#### Declared In
`QNIMRoster.h`
### ` rosterRelation`
联系人关系
`@property (nonatomic, assign, readonly) QNIMRosterRelation rosterRelation`
#### Discussion
联系人关系
#### Declared In
`QNIMRoster.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,480 |
QNIMPushUserProfile推送用户 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMPushUserProfile推送用户
# QNIMPushUserProfile推送用户
最近更新时间: 2021-07-16 09:25:36
# QNIMPushUserProfile Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMPushUserProfile.h
### ` userId`
用户ID（唯一）
`@property (nonatomic, assign, readonly) NSInteger userId`
#### Discussion
用户ID（唯一）
#### Declared In
`QNIMPushUserProfile.h`
### ` pushAlias`
推送用户别名
`@property (nonatomic, copy, readonly) NSString *pushAlias`
#### Discussion
推送用户别名
#### Declared In
`QNIMPushUserProfile.h`
### ` pushToken`
推送用户token
`@property (nonatomic, copy, readonly) NSString *pushToken`
#### Discussion
推送用户token
#### Declared In
`QNIMPushUserProfile.h`
### ` setting`
推送用户消息设定
`@property (nonatomic, strong) QNIMMessagePushSetting *setting`
#### Discussion
推送用户消息设定
#### Declared In
`QNIMPushUserProfile.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMPushUserProfile推送用户
# QNIMPushUserProfile推送用户
最近更新时间: 2021-07-16 09:25:36
# QNIMPushUserProfile Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMPushUserProfile.h
### ` userId`
用户ID（唯一）
`@property (nonatomic, assign, readonly) NSInteger userId`
#### Discussion
用户ID（唯一）
#### Declared In
`QNIMPushUserProfile.h`
### ` pushAlias`
推送用户别名
`@property (nonatomic, copy, readonly) NSString *pushAlias`
#### Discussion
推送用户别名
#### Declared In
`QNIMPushUserProfile.h`
### ` pushToken`
推送用户token
`@property (nonatomic, copy, readonly) NSString *pushToken`
#### Discussion
推送用户token
#### Declared In
`QNIMPushUserProfile.h`
### ` setting`
推送用户消息设定
`@property (nonatomic, strong) QNIMMessagePushSetting *setting`
#### Discussion
推送用户消息设定
#### Declared In
`QNIMPushUserProfile.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,483 |
QNIMSDKConfig设置 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMSDKConfig设置
# QNIMSDKConfig设置
最近更新时间: 2021-07-16 09:25:43
# QNIMSDKConfig Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMSDKConfig.h
### ` deviceUUID`
获取设备的唯一识别码,如果使用数据库
`@property (nonatomic, copy) NSString *deviceUUID`
#### Discussion
获取设备的唯一识别码,如果使用数据库
#### Declared In
`QNIMSDKConfig.h`
### ` enableDNS`
获取是否启用dns功能,设置是否启用dns功能，默认是开启的。
`@property (nonatomic, assign) BOOL enableDNS`
#### Discussion
获取是否启用dns功能,设置是否启用dns功能，默认是开启的。
#### Declared In
`QNIMSDKConfig.h`
### ` userDNSAddress`
获取用户自定义dns服务器地址,设置用户自定义dns服务器地址，在用户设置了dns服务器的情况下优先使用用户dns。
`@property (nonatomic, copy) NSString *userDNSAddress`
#### Discussion
获取用户自定义dns服务器地址,设置用户自定义dns服务器地址，在用户设置了dns服务器的情况下优先使用用户dns。
#### Declared In
`QNIMSDKConfig.h`
### ` appID`
获取用户的appId, 设置用户的appId。
`@property (nonatomic, copy) NSString *appID`
#### Discussion
获取用户的appId, 设置用户的appId。
#### Declared In
`QNIMSDKConfig.h`
### ` debugLogRecevierID`
设置调试log接收账号(仅用于SDK调试，接收客户端log日志使用)
`@property (nonatomic, copy) NSString *debugLogRecevierID`
#### Discussion
设置调试log接收账号(仅用于SDK调试，接收客户端log日志使用)
#### Declared In
`QNIMSDKConfig.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMSDKConfig设置
# QNIMSDKConfig设置
最近更新时间: 2021-07-16 09:25:43
# QNIMSDKConfig Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMSDKConfig.h
### ` deviceUUID`
获取设备的唯一识别码,如果使用数据库
`@property (nonatomic, copy) NSString *deviceUUID`
#### Discussion
获取设备的唯一识别码,如果使用数据库
#### Declared In
`QNIMSDKConfig.h`
### ` enableDNS`
获取是否启用dns功能,设置是否启用dns功能，默认是开启的。
`@property (nonatomic, assign) BOOL enableDNS`
#### Discussion
获取是否启用dns功能,设置是否启用dns功能，默认是开启的。
#### Declared In
`QNIMSDKConfig.h`
### ` userDNSAddress`
获取用户自定义dns服务器地址,设置用户自定义dns服务器地址，在用户设置了dns服务器的情况下优先使用用户dns。
`@property (nonatomic, copy) NSString *userDNSAddress`
#### Discussion
获取用户自定义dns服务器地址,设置用户自定义dns服务器地址，在用户设置了dns服务器的情况下优先使用用户dns。
#### Declared In
`QNIMSDKConfig.h`
### ` appID`
获取用户的appId, 设置用户的appId。
`@property (nonatomic, copy) NSString *appID`
#### Discussion
获取用户的appId, 设置用户的appId。
#### Declared In
`QNIMSDKConfig.h`
### ` debugLogRecevierID`
设置调试log接收账号(仅用于SDK调试，接收客户端log日志使用)
`@property (nonatomic, copy) NSString *debugLogRecevierID`
#### Discussion
设置调试log接收账号(仅用于SDK调试，接收客户端log日志使用)
#### Declared In
`QNIMSDKConfig.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,485 |
QNIMConversation会话 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMConversation会话
# QNIMConversation会话
最近更新时间: 2021-07-16 09:25:51
# QNIMConversation Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMConversation.h
### ` conversationId`
会话Id
`@property (nonatomic, assign, readonly) long long conversationId`
#### Discussion
会话Id
#### Declared In
`QNIMConversation.h`
### ` type`
会话类型
`@property (nonatomic, assign, readonly) QNIMConversationType type`
#### Discussion
会话类型
#### Declared In
`QNIMConversation.h`
### ` lastMessage`
最新消息
`@property (nonatomic, strong, readonly) QNIMMessageObject *lastMessage`
#### Discussion
最新消息
#### Declared In
`QNIMConversation.h`
### ` unreadNumber`
未读消息数量
`@property (nonatomic, assign, readonly) NSInteger unreadNumber`
#### Discussion
未读消息数量
#### Declared In
`QNIMConversation.h`
### ` messageCount`
会话中所有消息数量
`@property (nonatomic, assign, readonly) NSInteger messageCount`
#### Discussion
会话中所有消息数量
#### Declared In
`QNIMConversation.h`
### ` isMuteNotication`
是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
`@property (nonatomic, assign) BOOL isMuteNotication`
#### Discussion
是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
#### Declared In
`QNIMConversation.h`
### ` extensionJson`
扩展信息
`@property (nonatomic, copy) NSString *extensionJson`
#### Discussion
扩展信息
#### Declared In
`QNIMConversation.h`
### ` editMessage`
编辑消息
`@property (nonatomic, copy) NSString *editMessage`
#### Discussion
编辑消息
#### Declared In
`QNIMConversation.h`
### `- setMessagePlayedStatus:status:completion:`
设置消息播放状态（只对语音/视频消息有效）
`- (void)setMessagePlayedStatus:(QNIMMessageObject *) _message_ status:(bool)
_status_ completion:(void ( ^ ) ( QNIMMessageObject *aMessage , QNIMError
*error )) _aCompletionBlock_`
#### Parameters
message | message
---|---
status | 播放状态
aCompletionBlock | Result
#### Discussion
设置消息播放状态（只对语音/视频消息有效）
#### Declared In
`QNIMConversation.h`
### `- setMessageReadStatus:status:completion:`
设置消息未读状态，更新未读消息数, 本地
`- (void)setMessageReadStatus:(QNIMMessageObject *) _message_ status:(BOOL)
_status_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
message | message
---|---
status | 是否已读
aCompletionBlock | Result
#### Discussion
设置消息未读状态，更新未读消息数, 本地
#### Declared In
`QNIMConversation.h`
### `- setAllMessagesReadCompletion:`
把所有消息设置为已读，更新未读消息数
`- (void)setAllMessagesReadCompletion:(void ( ^ ) ( QNIMError *error ))
_aCompletionBlock_`
#### Discussion
把所有消息设置为已读，更新未读消息数
#### Declared In
`QNIMConversation.h`
### `- updateMessageExtension:completion:`
更新一条数据库存储消息的扩展字段信息
`- (void)updateMessageExtension:(QNIMMessageObject *) _message_
completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
message | 需要更改扩展信息的消息此时msg部分已经更新扩展字椴信息
---|---
aCompletionBlock | 更新结果
#### Discussion
更新一条数据库存储消息的扩展字段信息
#### Declared In
`QNIMConversation.h`
### `- insertMessage:completion:`
插入一条消息
`- (void)insertMessage:(QNIMMessageObject *) _msg_ completion:(void ( ^ ) (
QNIMError *error )) _aCompletionBlock_`
#### Parameters
msg | Message
---|---
aCompletionBlock | Result
#### Discussion
插入一条消息
#### Declared In
`QNIMConversation.h`
### `- loadMessage:completion:`
读取一条消息
`- (void)loadMessage:(long long) _msgId_ completion:(void ( ^ ) (
QNIMMessageObject *message )) _aCompletionBlock_`
#### Parameters
msgId | msgId
---|---
aCompletionBlock | Result
#### Discussion
读取一条消息
#### Declared In
`QNIMConversation.h`
### `- removeAllMessagescompletion:`
删除会话中的所有消息
`- (void)removeAllMessagescompletion:(void ( ^ ) ( QNIMError *error ))
_aCompletionBlock_`
#### Parameters
aCompletionBlock | Result
---|---
|
#### Discussion
删除会话中的所有消息
#### Declared In
`QNIMConversation.h`
### `- loadMessageFromMessageId:size:completion:`
加载消息，从参考消息向前加载，如果不指定则从最新消息开始
`- (void)loadMessageFromMessageId:(long long) _reMsgId_ size:(NSUInteger)
_size_ completion:(void ( ^ ) ( NSArray *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Parameters
reMsgId | 参考消息Id
---|---
Size | size
aCompletionBlock | Result：MessageList
#### Discussion
加载消息，从参考消息向前加载，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
### `- searchMessagesByKeyWords:refTime:size:directionType:completion:`
搜索消息，如果不指定则从最新消息开始
`- (void)searchMessagesByKeyWords:(NSString *) _keywords_
refTime:(NSTimeInterval) _refTime_ size:(NSUInteger) _size_
directionType:(QNIMMessageDirection) _directionType_ completion:(void ( ^ ) (
NSArray<QNIMMessageObject*> *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
搜索消息，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
### searchMessagesBycontentType:refTime:size:directionType:completion:
按照类型搜索消息，如果不指定则从最新消息开始
`- (void)searchMessagesBycontentType:(QNIMContentType) _contentType_
refTime:(NSTimeInterval) _refTime_ size:(NSUInteger) _size_
directionType:(QNIMMessageDirection) _directionType_ completion:(void ( ^ ) (
NSArray<QNIMMessageObject*> *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
按照类型搜索消息，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMConversation会话
# QNIMConversation会话
最近更新时间: 2021-07-16 09:25:51
# QNIMConversation Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMConversation.h
### ` conversationId`
会话Id
`@property (nonatomic, assign, readonly) long long conversationId`
#### Discussion
会话Id
#### Declared In
`QNIMConversation.h`
### ` type`
会话类型
`@property (nonatomic, assign, readonly) QNIMConversationType type`
#### Discussion
会话类型
#### Declared In
`QNIMConversation.h`
### ` lastMessage`
最新消息
`@property (nonatomic, strong, readonly) QNIMMessageObject *lastMessage`
#### Discussion
最新消息
#### Declared In
`QNIMConversation.h`
### ` unreadNumber`
未读消息数量
`@property (nonatomic, assign, readonly) NSInteger unreadNumber`
#### Discussion
未读消息数量
#### Declared In
`QNIMConversation.h`
### ` messageCount`
会话中所有消息数量
`@property (nonatomic, assign, readonly) NSInteger messageCount`
#### Discussion
会话中所有消息数量
#### Declared In
`QNIMConversation.h`
### ` isMuteNotication`
是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
`@property (nonatomic, assign) BOOL isMuteNotication`
#### Discussion
是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
#### Declared In
`QNIMConversation.h`
### ` extensionJson`
扩展信息
`@property (nonatomic, copy) NSString *extensionJson`
#### Discussion
扩展信息
#### Declared In
`QNIMConversation.h`
### ` editMessage`
编辑消息
`@property (nonatomic, copy) NSString *editMessage`
#### Discussion
编辑消息
#### Declared In
`QNIMConversation.h`
### `- setMessagePlayedStatus:status:completion:`
设置消息播放状态（只对语音/视频消息有效）
`- (void)setMessagePlayedStatus:(QNIMMessageObject *) _message_ status:(bool)
_status_ completion:(void ( ^ ) ( QNIMMessageObject *aMessage , QNIMError
*error )) _aCompletionBlock_`
#### Parameters
message | message
---|---
status | 播放状态
aCompletionBlock | Result
#### Discussion
设置消息播放状态（只对语音/视频消息有效）
#### Declared In
`QNIMConversation.h`
### `- setMessageReadStatus:status:completion:`
设置消息未读状态，更新未读消息数, 本地
`- (void)setMessageReadStatus:(QNIMMessageObject *) _message_ status:(BOOL)
_status_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
message | message
---|---
status | 是否已读
aCompletionBlock | Result
#### Discussion
设置消息未读状态，更新未读消息数, 本地
#### Declared In
`QNIMConversation.h`
### `- setAllMessagesReadCompletion:`
把所有消息设置为已读，更新未读消息数
`- (void)setAllMessagesReadCompletion:(void ( ^ ) ( QNIMError *error ))
_aCompletionBlock_`
#### Discussion
把所有消息设置为已读，更新未读消息数
#### Declared In
`QNIMConversation.h`
### `- updateMessageExtension:completion:`
更新一条数据库存储消息的扩展字段信息
`- (void)updateMessageExtension:(QNIMMessageObject *) _message_
completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
message | 需要更改扩展信息的消息此时msg部分已经更新扩展字椴信息
---|---
aCompletionBlock | 更新结果
#### Discussion
更新一条数据库存储消息的扩展字段信息
#### Declared In
`QNIMConversation.h`
### `- insertMessage:completion:`
插入一条消息
`- (void)insertMessage:(QNIMMessageObject *) _msg_ completion:(void ( ^ ) (
QNIMError *error )) _aCompletionBlock_`
#### Parameters
msg | Message
---|---
aCompletionBlock | Result
#### Discussion
插入一条消息
#### Declared In
`QNIMConversation.h`
### `- loadMessage:completion:`
读取一条消息
`- (void)loadMessage:(long long) _msgId_ completion:(void ( ^ ) (
QNIMMessageObject *message )) _aCompletionBlock_`
#### Parameters
msgId | msgId
---|---
aCompletionBlock | Result
#### Discussion
读取一条消息
#### Declared In
`QNIMConversation.h`
### `- removeAllMessagescompletion:`
删除会话中的所有消息
`- (void)removeAllMessagescompletion:(void ( ^ ) ( QNIMError *error ))
_aCompletionBlock_`
#### Parameters
aCompletionBlock | Result
---|---
|
#### Discussion
删除会话中的所有消息
#### Declared In
`QNIMConversation.h`
### `- loadMessageFromMessageId:size:completion:`
加载消息，从参考消息向前加载，如果不指定则从最新消息开始
`- (void)loadMessageFromMessageId:(long long) _reMsgId_ size:(NSUInteger)
_size_ completion:(void ( ^ ) ( NSArray *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Parameters
reMsgId | 参考消息Id
---|---
Size | size
aCompletionBlock | Result：MessageList
#### Discussion
加载消息，从参考消息向前加载，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
### `- searchMessagesByKeyWords:refTime:size:directionType:completion:`
搜索消息，如果不指定则从最新消息开始
`- (void)searchMessagesByKeyWords:(NSString *) _keywords_
refTime:(NSTimeInterval) _refTime_ size:(NSUInteger) _size_
directionType:(QNIMMessageDirection) _directionType_ completion:(void ( ^ ) (
NSArray<QNIMMessageObject*> *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
搜索消息，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
### searchMessagesBycontentType:refTime:size:directionType:completion:
按照类型搜索消息，如果不指定则从最新消息开始
`- (void)searchMessagesBycontentType:(QNIMContentType) _contentType_
refTime:(NSTimeInterval) _refTime_ size:(NSUInteger) _size_
directionType:(QNIMMessageDirection) _directionType_ completion:(void ( ^ ) (
NSArray<QNIMMessageObject*> *messageList , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
按照类型搜索消息，如果不指定则从最新消息开始
#### Declared In
`QNIMConversation.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,488 |
QNIMMessageObject消息 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessageObject消息
# QNIMMessageObject消息
最近更新时间: 2021-07-16 09:25:58
# QNIMMessageObject Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessageObject.h
### `- initWithQNIMMessageText:fromId:toId:type:conversationId:`
创建文本消息
`- (instancetype)initWithQNIMMessageText:(NSString *) _content_ fromId:(long
long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType) _mtype_
conversationId:(long long) _conversationId_`
#### Parameters
content | 内容
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建文本消息
#### Declared In
`QNIMMessageObject.h`
### `- initWithQNIMCommandMessageText:fromId:toId:type:conversationId:`
创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
`- (instancetype)initWithQNIMCommandMessageText:(NSString *) _content_
fromId:(long long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType)
_mtype_ conversationId:(long long) _conversationId_`
#### Parameters
content | 消息内容
---|---
fromId | 消息发送者
toId | 消息接收者
mtype | 消息类型
conversationId | 会话id
#### Discussion
创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
#### Declared In
`QNIMMessageObject.h`
### `- initWithQNIMMessageAttachment:fromId:toId:type:conversationId:`
创建附件消息
`- (instancetype)initWithQNIMMessageAttachment:(QNIMMessageAttachment *)
_attachment_ fromId:(long long) _fromId_ toId:(long long) _toId_
type:(QNIMMessageType) _mtype_ conversationId:(long long) _conversationId_`
#### Parameters
attachment | [QNIMMessageAttachment](https://developer.qiniu.com/IM/8177/Classes/QNIMMessageAttachment.html)
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建附件消息
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageText:msgId:fromId:toId:type:conversationId:timeStamp:`
创建接收文本消息
`- (instancetype)initWithRecieveQNIMMessageText:(NSString *) _content_
msgId:(long long) _msgId_ fromId:(long long) _fromId_ toId:(long long) _toId_
type:(QNIMMessageType) _mtype_ conversationId:(long long) _conversationId_
timeStamp:(long long) _timeStamp_`
#### Parameters
content | 内容
---|---
msgId | 消息id
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
timeStamp | 时间戳
#### Return Value
QNIMMessageObject
#### Discussion
创建接收文本消息
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageCommandMessageText:msgId:fromId:toId:type:conversationId:timeStamp:`
创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
`- (instancetype)initWithRecieveQNIMMessageCommandMessageText:(NSString *)
_content_ msgId:(long long) _msgId_ fromId:(long long) _fromId_ toId:(long
long) _toId_ type:(QNIMMessageType) _mtype_ conversationId:(long long)
_conversationId_ timeStamp:(long long) _timeStamp_`
#### Parameters
content | 消息内容
---|---
msgId | 消息id
fromId | 消息发送者
toId | 消息接收者
mtype | 消息类型
conversationId | 会话id
timeStamp | 服务器时间戳
#### Discussion
创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageAttachment:msgId:fromId:toId:type:conversationId:timeStamp:`
创建接收附件消息
`- (instancetype)initWithRecieveQNIMMessageAttachment:(QNIMMessageAttachment
*) _attachment_ msgId:(long long) _msgId_ fromId:(long long) _fromId_
toId:(long long) _toId_ type:(QNIMMessageType) _mtype_ conversationId:(long
long) _conversationId_ timeStamp:(long long) _timeStamp_`
#### Parameters
attachment | [QNIMMessageAttachment](https://developer.qiniu.com/IM/8177/Classes/QNIMMessageAttachment.html)
---|---
msgId | 消息id
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
timeStamp | 时间戳
#### Return Value
QNIMMessageObject
#### Discussion
创建接收附件消息
#### Declared In
`QNIMMessageObject.h`
### `- initWithForwardMessage:fromId:toId:type:conversationId:`
创建转发消息
`- (instancetype)initWithForwardMessage:(QNIMMessageObject *) _message_
fromId:(long long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType)
_mtype_ conversationId:(long long) _conversationId_`
#### Parameters
message | QNIMMessageObject
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建转发消息
#### Declared In
`QNIMMessageObject.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessageObject消息
# QNIMMessageObject消息
最近更新时间: 2021-07-16 09:25:58
# QNIMMessageObject Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessageObject.h
### `- initWithQNIMMessageText:fromId:toId:type:conversationId:`
创建文本消息
`- (instancetype)initWithQNIMMessageText:(NSString *) _content_ fromId:(long
long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType) _mtype_
conversationId:(long long) _conversationId_`
#### Parameters
content | 内容
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建文本消息
#### Declared In
`QNIMMessageObject.h`
### `- initWithQNIMCommandMessageText:fromId:toId:type:conversationId:`
创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
`- (instancetype)initWithQNIMCommandMessageText:(NSString *) _content_
fromId:(long long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType)
_mtype_ conversationId:(long long) _conversationId_`
#### Parameters
content | 消息内容
---|---
fromId | 消息发送者
toId | 消息接收者
mtype | 消息类型
conversationId | 会话id
#### Discussion
创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
#### Declared In
`QNIMMessageObject.h`
### `- initWithQNIMMessageAttachment:fromId:toId:type:conversationId:`
创建附件消息
`- (instancetype)initWithQNIMMessageAttachment:(QNIMMessageAttachment *)
_attachment_ fromId:(long long) _fromId_ toId:(long long) _toId_
type:(QNIMMessageType) _mtype_ conversationId:(long long) _conversationId_`
#### Parameters
attachment | [QNIMMessageAttachment](https://developer.qiniu.com/IM/8177/Classes/QNIMMessageAttachment.html)
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建附件消息
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageText:msgId:fromId:toId:type:conversationId:timeStamp:`
创建接收文本消息
`- (instancetype)initWithRecieveQNIMMessageText:(NSString *) _content_
msgId:(long long) _msgId_ fromId:(long long) _fromId_ toId:(long long) _toId_
type:(QNIMMessageType) _mtype_ conversationId:(long long) _conversationId_
timeStamp:(long long) _timeStamp_`
#### Parameters
content | 内容
---|---
msgId | 消息id
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
timeStamp | 时间戳
#### Return Value
QNIMMessageObject
#### Discussion
创建接收文本消息
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageCommandMessageText:msgId:fromId:toId:type:conversationId:timeStamp:`
创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
`- (instancetype)initWithRecieveQNIMMessageCommandMessageText:(NSString *)
_content_ msgId:(long long) _msgId_ fromId:(long long) _fromId_ toId:(long
long) _toId_ type:(QNIMMessageType) _mtype_ conversationId:(long long)
_conversationId_ timeStamp:(long long) _timeStamp_`
#### Parameters
content | 消息内容
---|---
msgId | 消息id
fromId | 消息发送者
toId | 消息接收者
mtype | 消息类型
conversationId | 会话id
timeStamp | 服务器时间戳
#### Discussion
创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
#### Declared In
`QNIMMessageObject.h`
### `-
initWithRecieveQNIMMessageAttachment:msgId:fromId:toId:type:conversationId:timeStamp:`
创建接收附件消息
`- (instancetype)initWithRecieveQNIMMessageAttachment:(QNIMMessageAttachment
*) _attachment_ msgId:(long long) _msgId_ fromId:(long long) _fromId_
toId:(long long) _toId_ type:(QNIMMessageType) _mtype_ conversationId:(long
long) _conversationId_ timeStamp:(long long) _timeStamp_`
#### Parameters
attachment | [QNIMMessageAttachment](https://developer.qiniu.com/IM/8177/Classes/QNIMMessageAttachment.html)
---|---
msgId | 消息id
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
timeStamp | 时间戳
#### Return Value
QNIMMessageObject
#### Discussion
创建接收附件消息
#### Declared In
`QNIMMessageObject.h`
### `- initWithForwardMessage:fromId:toId:type:conversationId:`
创建转发消息
`- (instancetype)initWithForwardMessage:(QNIMMessageObject *) _message_
fromId:(long long) _fromId_ toId:(long long) _toId_ type:(QNIMMessageType)
_mtype_ conversationId:(long long) _conversationId_`
#### Parameters
message | QNIMMessageObject
---|---
fromId | 发送id
toId | 接收id
mtype | 消息类型
conversationId | 会话id
#### Return Value
QNIMMessageObject
#### Discussion
创建转发消息
#### Declared In
`QNIMMessageObject.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,497 |
QNIMGroup群组 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMGroup群组
# QNIMGroup群组
最近更新时间: 2021-07-16 09:26:05
# QNIMGroup Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMGroup.h
## Overview
聊天室
### ` groupId`
群Id
`@property (nonatomic, assign, readonly) long long groupId`
#### Discussion
群Id
#### Declared In
`QNIMGroup.h`
### ` myNickName`
在群里的昵称
`@property (nonatomic, copy, readonly) NSString *myNickName`
#### Discussion
在群里的昵称
#### Declared In
`QNIMGroup.h`
### ` name`
群名称
`@property (nonatomic, copy, readonly) NSString *name`
#### Discussion
群名称
#### Declared In
`QNIMGroup.h`
### ` groupDescription`
群描述
`@property (nonatomic, copy, readonly) NSString *groupDescription`
#### Discussion
群描述
#### Declared In
`QNIMGroup.h`
### ` avatarUrl`
群头像
`@property (nonatomic, copy, readonly) NSString *avatarUrl`
#### Discussion
群头像
#### Declared In
`QNIMGroup.h`
### ` avatarPath`
群头像下载后的本地路径
`@property (nonatomic, copy, readonly) NSString *avatarPath`
#### Discussion
群头像下载后的本地路径
#### Declared In
`QNIMGroup.h`
### ` avatarThumbnailUrl`
群头像缩略图
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailUrl`
#### Discussion
群头像缩略图
#### Declared In
`QNIMGroup.h`
### ` avatarThumbnailPath`
群头像缩略图下载后的本地路径
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailPath`
#### Discussion
群头像缩略图下载后的本地路径
#### Declared In
`QNIMGroup.h`
### ` creatTime`
群创建时间
`@property (nonatomic, readonly) long long creatTime`
#### Discussion
群创建时间
#### Declared In
`QNIMGroup.h`
### ` jsonextension`
群扩展信息
`@property (nonatomic, copy, readonly) NSString *jsonextension`
#### Discussion
群扩展信息
#### Declared In
`QNIMGroup.h`
### ` ownerId`
群成员
`@property (nonatomic, assign, readonly) NSInteger ownerId`
#### Discussion
群成员
#### Declared In
`QNIMGroup.h`
### ` capactiy`
最大人数
`@property (nonatomic, assign, readonly) NSInteger capactiy`
#### Discussion
最大人数
#### Declared In
`QNIMGroup.h`
### ` membersCount`
群成员数量，包含Owner，admins 和members
`@property (nonatomic, assign, readonly) NSInteger membersCount`
#### Discussion
群成员数量，包含Owner，admins 和members
#### Declared In
`QNIMGroup.h`
### ` adminsCount`
群管理员数量
`@property (nonatomic, assign, readonly) NSInteger adminsCount`
#### Discussion
群管理员数量
#### Declared In
`QNIMGroup.h`
### ` sharedFilesCount`
群共享文件数量
`@property (nonatomic, assign, readonly) NSInteger sharedFilesCount`
#### Discussion
群共享文件数量
#### Declared In
`QNIMGroup.h`
### ` msgPushMode`
群消息通知类型
`@property (nonatomic, assign, readonly) QNIMGroupMsgPushMode msgPushMode`
#### Discussion
群消息通知类型
#### Declared In
`QNIMGroup.h`
### ` modifyMode`
群信息修改模式
`@property (nonatomic, assign, readonly) QNIMGroupModifyMode modifyMode`
#### Discussion
群信息修改模式
#### Declared In
`QNIMGroup.h`
### ` joinAuthMode`
入群审批模式
`@property (nonatomic, assign, readonly) QNIMGroupJoinAuthMode joinAuthMode`
#### Discussion
入群审批模式
#### Declared In
`QNIMGroup.h`
### ` inviteMode`
入群邀请模式
`@property (nonatomic, assign, readonly) QNIMGroupInviteMode inviteMode`
#### Discussion
入群邀请模式
#### Declared In
`QNIMGroup.h`
### ` enableReadAck`
是否开启群消息已读功能
`@property (nonatomic, assign) BOOL enableReadAck`
#### Discussion
是否开启群消息已读功能
#### Declared In
`QNIMGroup.h`
### ` historyVisible`
是否可以加载显示历史聊天记录
`@property (nonatomic, assign) BOOL historyVisible`
#### Discussion
是否可以加载显示历史聊天记录
#### Declared In
`QNIMGroup.h`
### ` msgMuteMode`
群消息屏蔽模式
`@property (nonatomic, assign) QNIMGroupMsgMuteMode msgMuteMode`
#### Discussion
群消息屏蔽模式
#### Declared In
`QNIMGroup.h`
### ` groupStatus`
当前群组的状态。（Normal 正常， Destroyed 以销毁）
`@property (nonatomic, assign) QNIMGroupStatus groupStatus`
#### Discussion
当前群组的状态。（Normal 正常， Destroyed 以销毁）
#### Declared In
`QNIMGroup.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMGroup群组
# QNIMGroup群组
最近更新时间: 2021-07-16 09:26:05
# QNIMGroup Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMGroup.h
## Overview
聊天室
### ` groupId`
群Id
`@property (nonatomic, assign, readonly) long long groupId`
#### Discussion
群Id
#### Declared In
`QNIMGroup.h`
### ` myNickName`
在群里的昵称
`@property (nonatomic, copy, readonly) NSString *myNickName`
#### Discussion
在群里的昵称
#### Declared In
`QNIMGroup.h`
### ` name`
群名称
`@property (nonatomic, copy, readonly) NSString *name`
#### Discussion
群名称
#### Declared In
`QNIMGroup.h`
### ` groupDescription`
群描述
`@property (nonatomic, copy, readonly) NSString *groupDescription`
#### Discussion
群描述
#### Declared In
`QNIMGroup.h`
### ` avatarUrl`
群头像
`@property (nonatomic, copy, readonly) NSString *avatarUrl`
#### Discussion
群头像
#### Declared In
`QNIMGroup.h`
### ` avatarPath`
群头像下载后的本地路径
`@property (nonatomic, copy, readonly) NSString *avatarPath`
#### Discussion
群头像下载后的本地路径
#### Declared In
`QNIMGroup.h`
### ` avatarThumbnailUrl`
群头像缩略图
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailUrl`
#### Discussion
群头像缩略图
#### Declared In
`QNIMGroup.h`
### ` avatarThumbnailPath`
群头像缩略图下载后的本地路径
`@property (nonatomic, copy, readonly) NSString *avatarThumbnailPath`
#### Discussion
群头像缩略图下载后的本地路径
#### Declared In
`QNIMGroup.h`
### ` creatTime`
群创建时间
`@property (nonatomic, readonly) long long creatTime`
#### Discussion
群创建时间
#### Declared In
`QNIMGroup.h`
### ` jsonextension`
群扩展信息
`@property (nonatomic, copy, readonly) NSString *jsonextension`
#### Discussion
群扩展信息
#### Declared In
`QNIMGroup.h`
### ` ownerId`
群成员
`@property (nonatomic, assign, readonly) NSInteger ownerId`
#### Discussion
群成员
#### Declared In
`QNIMGroup.h`
### ` capactiy`
最大人数
`@property (nonatomic, assign, readonly) NSInteger capactiy`
#### Discussion
最大人数
#### Declared In
`QNIMGroup.h`
### ` membersCount`
群成员数量，包含Owner，admins 和members
`@property (nonatomic, assign, readonly) NSInteger membersCount`
#### Discussion
群成员数量，包含Owner，admins 和members
#### Declared In
`QNIMGroup.h`
### ` adminsCount`
群管理员数量
`@property (nonatomic, assign, readonly) NSInteger adminsCount`
#### Discussion
群管理员数量
#### Declared In
`QNIMGroup.h`
### ` sharedFilesCount`
群共享文件数量
`@property (nonatomic, assign, readonly) NSInteger sharedFilesCount`
#### Discussion
群共享文件数量
#### Declared In
`QNIMGroup.h`
### ` msgPushMode`
群消息通知类型
`@property (nonatomic, assign, readonly) QNIMGroupMsgPushMode msgPushMode`
#### Discussion
群消息通知类型
#### Declared In
`QNIMGroup.h`
### ` modifyMode`
群信息修改模式
`@property (nonatomic, assign, readonly) QNIMGroupModifyMode modifyMode`
#### Discussion
群信息修改模式
#### Declared In
`QNIMGroup.h`
### ` joinAuthMode`
入群审批模式
`@property (nonatomic, assign, readonly) QNIMGroupJoinAuthMode joinAuthMode`
#### Discussion
入群审批模式
#### Declared In
`QNIMGroup.h`
### ` inviteMode`
入群邀请模式
`@property (nonatomic, assign, readonly) QNIMGroupInviteMode inviteMode`
#### Discussion
入群邀请模式
#### Declared In
`QNIMGroup.h`
### ` enableReadAck`
是否开启群消息已读功能
`@property (nonatomic, assign) BOOL enableReadAck`
#### Discussion
是否开启群消息已读功能
#### Declared In
`QNIMGroup.h`
### ` historyVisible`
是否可以加载显示历史聊天记录
`@property (nonatomic, assign) BOOL historyVisible`
#### Discussion
是否可以加载显示历史聊天记录
#### Declared In
`QNIMGroup.h`
### ` msgMuteMode`
群消息屏蔽模式
`@property (nonatomic, assign) QNIMGroupMsgMuteMode msgMuteMode`
#### Discussion
群消息屏蔽模式
#### Declared In
`QNIMGroup.h`
### ` groupStatus`
当前群组的状态。（Normal 正常， Destroyed 以销毁）
`@property (nonatomic, assign) QNIMGroupStatus groupStatus`
#### Discussion
当前群组的状态。（Normal 正常， Destroyed 以销毁）
#### Declared In
`QNIMGroup.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,504 |
QNIMMessageSetting推送设置 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessageSetting推送设置
# QNIMMessageSetting推送设置
最近更新时间: 2021-07-16 09:26:12
# QNIMMessageSetting Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessageSetting.h
### ` mPushEnabled`
推送开关
`@property (nonatomic, assign, readonly) BOOL mPushEnabled`
#### Discussion
推送开关
#### Declared In
`QNIMMessageSetting.h`
### ` mPushDetail`
推送详情
`@property (nonatomic, assign, readonly) BOOL mPushDetail`
#### Discussion
推送详情
#### Declared In
`QNIMMessageSetting.h`
### ` pushNickname`
对方收到推送消息时显示的名称
`@property (nonatomic, copy) NSString *pushNickname`
#### Discussion
对方收到推送消息时显示的名称
#### Declared In
`QNIMMessageSetting.h`
### ` mNotificationSound`
推送声音
`@property (nonatomic, assign, readonly) BOOL mNotificationSound`
#### Discussion
推送声音
#### Declared In
`QNIMMessageSetting.h`
### ` mNotificationVibrate`
推送通知震动
`@property (nonatomic, assign, readonly) BOOL mNotificationVibrate`
#### Discussion
推送通知震动
#### Declared In
`QNIMMessageSetting.h`
### ` mAutoDownloadAttachment`
自动下载附件
`@property (nonatomic, assign, readonly) BOOL mAutoDownloadAttachment`
#### Discussion
自动下载附件
#### Declared In
`QNIMMessageSetting.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessageSetting推送设置
# QNIMMessageSetting推送设置
最近更新时间: 2021-07-16 09:26:12
# QNIMMessageSetting Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessageSetting.h
### ` mPushEnabled`
推送开关
`@property (nonatomic, assign, readonly) BOOL mPushEnabled`
#### Discussion
推送开关
#### Declared In
`QNIMMessageSetting.h`
### ` mPushDetail`
推送详情
`@property (nonatomic, assign, readonly) BOOL mPushDetail`
#### Discussion
推送详情
#### Declared In
`QNIMMessageSetting.h`
### ` pushNickname`
对方收到推送消息时显示的名称
`@property (nonatomic, copy) NSString *pushNickname`
#### Discussion
对方收到推送消息时显示的名称
#### Declared In
`QNIMMessageSetting.h`
### ` mNotificationSound`
推送声音
`@property (nonatomic, assign, readonly) BOOL mNotificationSound`
#### Discussion
推送声音
#### Declared In
`QNIMMessageSetting.h`
### ` mNotificationVibrate`
推送通知震动
`@property (nonatomic, assign, readonly) BOOL mNotificationVibrate`
#### Discussion
推送通知震动
#### Declared In
`QNIMMessageSetting.h`
### ` mAutoDownloadAttachment`
自动下载附件
`@property (nonatomic, assign, readonly) BOOL mAutoDownloadAttachment`
#### Discussion
自动下载附件
#### Declared In
`QNIMMessageSetting.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,509 |
QNIMDevice设备 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMDevice设备
# QNIMDevice设备
最近更新时间: 2021-07-16 09:26:18
# QNIMDevice Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMDevice.h
### ` deviceSN`
设备序列号
`@property (nonatomic, assign, readonly) int deviceSN`
#### Discussion
设备序列号
#### Declared In
`QNIMDevice.h`
### ` userId`
用户id
`@property (nonatomic, assign, readonly) long long userId`
#### Discussion
用户id
#### Declared In
`QNIMDevice.h`
### ` platform`
平台
`@property (nonatomic, assign, readonly) int platform`
#### Discussion
平台
#### Declared In
`QNIMDevice.h`
### ` userAgent`
UA
`@property (nonatomic, copy) NSString *userAgent`
#### Discussion
UA
#### Declared In
`QNIMDevice.h`
### ` isCurrentDevice`
是否是当前设备
`@property (nonatomic, assign, readonly) BOOL isCurrentDevice`
#### Discussion
是否是当前设备
#### Declared In
`QNIMDevice.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMDevice设备
# QNIMDevice设备
最近更新时间: 2021-07-16 09:26:18
# QNIMDevice Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMDevice.h
### ` deviceSN`
设备序列号
`@property (nonatomic, assign, readonly) int deviceSN`
#### Discussion
设备序列号
#### Declared In
`QNIMDevice.h`
### ` userId`
用户id
`@property (nonatomic, assign, readonly) long long userId`
#### Discussion
用户id
#### Declared In
`QNIMDevice.h`
### ` platform`
平台
`@property (nonatomic, assign, readonly) int platform`
#### Discussion
平台
#### Declared In
`QNIMDevice.h`
### ` userAgent`
UA
`@property (nonatomic, copy) NSString *userAgent`
#### Discussion
UA
#### Declared In
`QNIMDevice.h`
### ` isCurrentDevice`
是否是当前设备
`@property (nonatomic, assign, readonly) BOOL isCurrentDevice`
#### Discussion
是否是当前设备
#### Declared In
`QNIMDevice.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,512 |
QNIMClient核心类 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMClient核心类
# QNIMClient核心类
最近更新时间: 2021-07-16 09:26:27
# QNIMClient Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMClient.h
### \- signUpNewUser:password:completion:
注册新用户，username和password是必填参数
- (void)signUpNewUser:(NSString *)_userName_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMUserProfile *profile , QNIMError *error ))aCompletionBlock
#### Parameters
userName | 用户名
---|---
password | 密码
aCompletionBlock | 注册成功后从该函数处获取新注册用户的Profile信息，初始传入指向为空的shared_ptr对象即可。
#### Discussion
注册新用户，username和password是必填参数。
#### Declared In
`QNIMClient.h`
### \- signInByName:password:completion:
通过用户名登录
- (void)signInByName:(NSString *)_userName_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))aCompletionBlock
#### Discussion
通过用户名登录
#### Declared In
`QNIMClient.h`
### \- signInById:password:completion:
通过用户ID登录
- (void)signInById:(long long)userId password:(NSString *)password completion:(void ( ^ ) ( QNIMError *error ))aCompletionBlock
#### Discussion
通过用户ID登录
#### Declared In
`QNIMClient.h`
### \- signInById:withToken:completion:
通过用户ID和token登录
- (void)signInById:(long long)_userId_ withToken:(NSString *)_token_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户ID和token登录
#### Declared In
`QNIMClient.h`
### \- fastSignInByName:password:completion:
通过用户名自动登录（要求之前成功登录过，登录速度较快）
- (void)fastSignInByName:(NSString *)_name_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户名自动登录（要求之前成功登录过，登录速度较快）
#### Declared In
`QNIMClient.h`
### \- fastSignInById:password:completion:
通过用户ID自动登录（要求之前成功登录过，登录速度较快）
- (void)fastSignInById:(long long)_uid_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户ID自动登录（要求之前成功登录过，登录速度较快）
#### Declared In
`QNIMClient.h`
### \- signOutID:ignoreUnbindDevice:completion:
退出登录
- (void)signOutID:(NSInteger)_userID_ ignoreUnbindDevice:(BOOL)_ignoreUnbindDevice_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
退出登录
#### Declared In
`QNIMClient.h`
### \- signInStatus
获取当前的登录状态
- (QNIMSignInStatus)signInStatus
#### Discussion
获取当前的登录状态
#### Declared In
`QNIMClient.h`
### \- connectStatus
获取当前和服务器的连接状态
- (QNIMConnectStatus)connectStatus
#### Discussion
获取当前和服务器的连接状态
#### Declared In
`QNIMClient.h`
### \- networkDidChangedType:reconnect:
处理网络状态发送变化
- (void)networkDidChangedType:(QNIMNetworkType)_type_ reconnect:(BOOL)_reconnect_
#### Parameters
type | 变化后的网络类型
---|---
reconnect | 网络是否需要重连
#### Discussion
处理网络状态发送变化
#### Declared In
`QNIMClient.h`
### \- reconnect
强制重新连接
- (void)reconnect
#### Discussion
强制重新连接
#### Declared In
`QNIMClient.h`
### \- disConnect
断开网络连接
- (void)disConnect
#### Discussion
断开网络连接
#### Declared In
`QNIMClient.h`
### \- changeAppID:completion:
更改SDK的appId，本操作会同时更新QNIMConfig中的appId。
- (void)changeAppID:(NSString *)_appID_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Parameters
appID | 新变更的appId
---|---
_aCompletionBlock_ | 回调
#### Discussion
更改SDK的appId，本操作会同时更新QNIMConfig中的appId。
#### Declared In
`QNIMClient.h`
### \- initializeServerConfig:
获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
- (void)initializeServerConfig:(BOOL)isLocal
#### Parameters
isLocal | 为true则使用本地缓存的dns配置，为false则从服务器获取最新的配置。
---|---
|
#### Discussion
获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
#### Declared In
`QNIMClient.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) > QNIMClient核心类
# QNIMClient核心类
最近更新时间: 2021-07-16 09:26:27
# QNIMClient Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMClient.h
### \- signUpNewUser:password:completion:
注册新用户，username和password是必填参数
- (void)signUpNewUser:(NSString *)_userName_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMUserProfile *profile , QNIMError *error ))aCompletionBlock
#### Parameters
userName | 用户名
---|---
password | 密码
aCompletionBlock | 注册成功后从该函数处获取新注册用户的Profile信息，初始传入指向为空的shared_ptr对象即可。
#### Discussion
注册新用户，username和password是必填参数。
#### Declared In
`QNIMClient.h`
### \- signInByName:password:completion:
通过用户名登录
- (void)signInByName:(NSString *)_userName_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))aCompletionBlock
#### Discussion
通过用户名登录
#### Declared In
`QNIMClient.h`
### \- signInById:password:completion:
通过用户ID登录
- (void)signInById:(long long)userId password:(NSString *)password completion:(void ( ^ ) ( QNIMError *error ))aCompletionBlock
#### Discussion
通过用户ID登录
#### Declared In
`QNIMClient.h`
### \- signInById:withToken:completion:
通过用户ID和token登录
- (void)signInById:(long long)_userId_ withToken:(NSString *)_token_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户ID和token登录
#### Declared In
`QNIMClient.h`
### \- fastSignInByName:password:completion:
通过用户名自动登录（要求之前成功登录过，登录速度较快）
- (void)fastSignInByName:(NSString *)_name_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户名自动登录（要求之前成功登录过，登录速度较快）
#### Declared In
`QNIMClient.h`
### \- fastSignInById:password:completion:
通过用户ID自动登录（要求之前成功登录过，登录速度较快）
- (void)fastSignInById:(long long)_uid_ password:(NSString *)_password_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
通过用户ID自动登录（要求之前成功登录过，登录速度较快）
#### Declared In
`QNIMClient.h`
### \- signOutID:ignoreUnbindDevice:completion:
退出登录
- (void)signOutID:(NSInteger)_userID_ ignoreUnbindDevice:(BOOL)_ignoreUnbindDevice_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Discussion
退出登录
#### Declared In
`QNIMClient.h`
### \- signInStatus
获取当前的登录状态
- (QNIMSignInStatus)signInStatus
#### Discussion
获取当前的登录状态
#### Declared In
`QNIMClient.h`
### \- connectStatus
获取当前和服务器的连接状态
- (QNIMConnectStatus)connectStatus
#### Discussion
获取当前和服务器的连接状态
#### Declared In
`QNIMClient.h`
### \- networkDidChangedType:reconnect:
处理网络状态发送变化
- (void)networkDidChangedType:(QNIMNetworkType)_type_ reconnect:(BOOL)_reconnect_
#### Parameters
type | 变化后的网络类型
---|---
reconnect | 网络是否需要重连
#### Discussion
处理网络状态发送变化
#### Declared In
`QNIMClient.h`
### \- reconnect
强制重新连接
- (void)reconnect
#### Discussion
强制重新连接
#### Declared In
`QNIMClient.h`
### \- disConnect
断开网络连接
- (void)disConnect
#### Discussion
断开网络连接
#### Declared In
`QNIMClient.h`
### \- changeAppID:completion:
更改SDK的appId，本操作会同时更新QNIMConfig中的appId。
- (void)changeAppID:(NSString *)_appID_ completion:(void ( ^ ) ( QNIMError *error ))_aCompletionBlock_
#### Parameters
appID | 新变更的appId
---|---
_aCompletionBlock_ | 回调
#### Discussion
更改SDK的appId，本操作会同时更新QNIMConfig中的appId。
#### Declared In
`QNIMClient.h`
### \- initializeServerConfig:
获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
- (void)initializeServerConfig:(BOOL)isLocal
#### Parameters
isLocal | 为true则使用本地缓存的dns配置，为false则从服务器获取最新的配置。
---|---
|
#### Discussion
获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
#### Declared In
`QNIMClient.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,514 |
QNIMCreatGroupOption群设置 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMCreatGroupOption群设置
# QNIMCreatGroupOption群设置
最近更新时间: 2021-07-16 09:26:35
# QNIMCreatGroupOption Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMCreatGroupOption.h
### ` name`
群名称
`@property (nonatomic, copy) NSString *name`
#### Discussion
群名称
#### Declared In
`QNIMCreatGroupOption.h`
### ` groupDescription`
群描述
`@property (nonatomic, copy) NSString *groupDescription`
#### Discussion
群描述
#### Declared In
`QNIMCreatGroupOption.h`
### ` isChatroom`
是否聊天室
`@property (nonatomic, assign) BOOL isChatroom`
#### Discussion
是否聊天室
#### Declared In
`QNIMCreatGroupOption.h`
### ` message`
建群时成员收到的邀请信息
`@property (nonatomic, copy) NSString *message`
#### Discussion
建群时成员收到的邀请信息
#### Declared In
`QNIMCreatGroupOption.h`
### ` avatarPath`
群头像本地路径
`@property (nonatomic, copy) NSString *avatarPath`
#### Discussion
群头像本地路径
#### Declared In
`QNIMCreatGroupOption.h`
### ` announcement`
群公告
`@property (nonatomic, copy) NSString *announcement`
#### Discussion
群公告
#### Declared In
`QNIMCreatGroupOption.h`
### ` members`
建群时添加的成员
`@property (nonatomic, strong) NSArray *members`
#### Discussion
建群时添加的成员
#### Declared In
`QNIMCreatGroupOption.h`
### ` extion`
群扩展信息
`@property (nonatomic, copy) NSString *extion`
#### Discussion
群扩展信息
#### Declared In
`QNIMCreatGroupOption.h`
### `- initWithGroupName:groupDescription:isPublic:`
创建群实体
`- (instancetype)initWithGroupName:(NSString *) _name_
groupDescription:(NSString *) _groupDescription_ isPublic:(BOOL) _isPublic_`
#### Parameters
name | 必填
---|---
groupDescription | 非必填
#### Return Value
QNIMCreatGroupOption
#### Discussion
创建群实体
#### Declared In
`QNIMCreatGroupOption.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMCreatGroupOption群设置
# QNIMCreatGroupOption群设置
最近更新时间: 2021-07-16 09:26:35
# QNIMCreatGroupOption Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMCreatGroupOption.h
### ` name`
群名称
`@property (nonatomic, copy) NSString *name`
#### Discussion
群名称
#### Declared In
`QNIMCreatGroupOption.h`
### ` groupDescription`
群描述
`@property (nonatomic, copy) NSString *groupDescription`
#### Discussion
群描述
#### Declared In
`QNIMCreatGroupOption.h`
### ` isChatroom`
是否聊天室
`@property (nonatomic, assign) BOOL isChatroom`
#### Discussion
是否聊天室
#### Declared In
`QNIMCreatGroupOption.h`
### ` message`
建群时成员收到的邀请信息
`@property (nonatomic, copy) NSString *message`
#### Discussion
建群时成员收到的邀请信息
#### Declared In
`QNIMCreatGroupOption.h`
### ` avatarPath`
群头像本地路径
`@property (nonatomic, copy) NSString *avatarPath`
#### Discussion
群头像本地路径
#### Declared In
`QNIMCreatGroupOption.h`
### ` announcement`
群公告
`@property (nonatomic, copy) NSString *announcement`
#### Discussion
群公告
#### Declared In
`QNIMCreatGroupOption.h`
### ` members`
建群时添加的成员
`@property (nonatomic, strong) NSArray *members`
#### Discussion
建群时添加的成员
#### Declared In
`QNIMCreatGroupOption.h`
### ` extion`
群扩展信息
`@property (nonatomic, copy) NSString *extion`
#### Discussion
群扩展信息
#### Declared In
`QNIMCreatGroupOption.h`
### `- initWithGroupName:groupDescription:isPublic:`
创建群实体
`- (instancetype)initWithGroupName:(NSString *) _name_
groupDescription:(NSString *) _groupDescription_ isPublic:(BOOL) _isPublic_`
#### Parameters
name | 必填
---|---
groupDescription | 非必填
#### Return Value
QNIMCreatGroupOption
#### Discussion
创建群实体
#### Declared In
`QNIMCreatGroupOption.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,519 |
QNIMMessagePushSetting消息推送 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessagePushSetting消息推送
# QNIMMessagePushSetting消息推送
最近更新时间: 2021-07-16 09:26:40
# QNIMMessagePushSetting Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessagePushSetting.h
### ` pushEnabled`
推送设定
`@property (nonatomic, assign) BOOL pushEnabled`
#### Discussion
推送设定
#### Declared In
`QNIMMessagePushSetting.h`
### ` silenceStartTime`
当APP未打开时是否允许推送
`@property (nonatomic, assign) NSInteger silenceStartTime`
#### Discussion
当APP未打开时是否允许推送
#### Declared In
`QNIMMessagePushSetting.h`
### ` silenceEndTime`
推送静默结束时间
`@property (nonatomic, assign) NSInteger silenceEndTime`
#### Discussion
推送静默结束时间
#### Declared In
`QNIMMessagePushSetting.h`
### ` pushStartTime`
允许推送起始时间
`@property (nonatomic, assign) NSInteger pushStartTime`
#### Discussion
允许推送起始时间
#### Declared In
`QNIMMessagePushSetting.h`
### ` mPushEndTime`
允许推送结束时间
`@property (nonatomic, assign) NSInteger mPushEndTime`
#### Discussion
允许推送结束时间
#### Declared In
`QNIMMessagePushSetting.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMMessagePushSetting消息推送
# QNIMMessagePushSetting消息推送
最近更新时间: 2021-07-16 09:26:40
# QNIMMessagePushSetting Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMMessagePushSetting.h
### ` pushEnabled`
推送设定
`@property (nonatomic, assign) BOOL pushEnabled`
#### Discussion
推送设定
#### Declared In
`QNIMMessagePushSetting.h`
### ` silenceStartTime`
当APP未打开时是否允许推送
`@property (nonatomic, assign) NSInteger silenceStartTime`
#### Discussion
当APP未打开时是否允许推送
#### Declared In
`QNIMMessagePushSetting.h`
### ` silenceEndTime`
推送静默结束时间
`@property (nonatomic, assign) NSInteger silenceEndTime`
#### Discussion
推送静默结束时间
#### Declared In
`QNIMMessagePushSetting.h`
### ` pushStartTime`
允许推送起始时间
`@property (nonatomic, assign) NSInteger pushStartTime`
#### Discussion
允许推送起始时间
#### Declared In
`QNIMMessagePushSetting.h`
### ` mPushEndTime`
允许推送结束时间
`@property (nonatomic, assign) NSInteger mPushEndTime`
#### Discussion
允许推送结束时间
#### Declared In
`QNIMMessagePushSetting.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,523 |
QNIMUserProfile用户 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMUserProfile用户
# QNIMUserProfile用户
最近更新时间: 2021-07-16 09:26:47
# QNIMUserProfile Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMUserProfile.h
### ` userId`
用户id
`@property (nonatomic, assign) long long userId`
#### Discussion
用户id
#### Declared In
`QNIMUserProfile.h`
### ` userCategory`
用户级别
`@property (nonatomic, assign) QNIMUserCategory userCategory`
#### Discussion
用户级别
#### Declared In
`QNIMUserProfile.h`
### ` userName`
用户名
`@property (nonatomic, copy) NSString *userName`
#### Discussion
用户名
#### Declared In
`QNIMUserProfile.h`
### ` nickName`
昵称
`@property (nonatomic, copy) NSString *nickName`
#### Discussion
昵称
#### Declared In
`QNIMUserProfile.h`
### ` avatarUrl`
头像url
`@property (nonatomic, copy) NSString *avatarUrl`
#### Discussion
头像url
#### Declared In
`QNIMUserProfile.h`
### ` avatarPath`
头像本地路径
`@property (nonatomic, copy) NSString *avatarPath`
#### Discussion
头像本地路径
#### Declared In
`QNIMUserProfile.h`
### ` avatarThumbnailUrl`
头像缩略图url
`@property (nonatomic, copy) NSString *avatarThumbnailUrl`
#### Discussion
头像缩略图url
#### Declared In
`QNIMUserProfile.h`
### ` avatarThumbnailPath`
头像缩略图本地路径
`@property (nonatomic, copy) NSString *avatarThumbnailPath`
#### Discussion
头像缩略图本地路径
#### Declared In
`QNIMUserProfile.h`
### ` mobilePhone`
手机号
`@property (nonatomic, copy) NSString *mobilePhone`
#### Discussion
手机号
#### Declared In
`QNIMUserProfile.h`
### ` email`
用户邮箱
`@property (nonatomic, copy) NSString *email`
#### Discussion
用户邮箱
#### Declared In
`QNIMUserProfile.h`
### ` publicInfoJson`
公开信息
`@property (nonatomic, copy) NSString *publicInfoJson`
#### Discussion
公开信息
#### Declared In
`QNIMUserProfile.h`
### ` privateInfoJson`
私密信息
`@property (nonatomic, copy) NSString *privateInfoJson`
#### Discussion
私密信息
#### Declared In
`QNIMUserProfile.h`
### ` authQuestion`
验证问题
`@property (nonatomic, strong) QNIMAuthQuestion *authQuestion`
#### Discussion
验证问题
#### Declared In
`QNIMUserProfile.h`
### ` messageSetting`
消息设置
`@property (nonatomic, strong) QNIMMessageSetting *messageSetting`
#### Discussion
消息设置
#### Declared In
`QNIMUserProfile.h`
### ` addFriendAuthMode`
好友验证模式
`@property (nonatomic, assign) QNIMAddFriendAuthMode addFriendAuthMode`
#### Discussion
好友验证模式
#### Declared In
`QNIMUserProfile.h`
### ` isAutoAcceptGroupInvite`
自动接收群邀请
`@property (nonatomic, assign) BOOL isAutoAcceptGroupInvite`
#### Discussion
自动接收群邀请
#### Declared In
`QNIMUserProfile.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMUserProfile用户
# QNIMUserProfile用户
最近更新时间: 2021-07-16 09:26:47
# QNIMUserProfile Class Reference
Inherits from | NSObject
---|---
Declared in | QNIMUserProfile.h
### ` userId`
用户id
`@property (nonatomic, assign) long long userId`
#### Discussion
用户id
#### Declared In
`QNIMUserProfile.h`
### ` userCategory`
用户级别
`@property (nonatomic, assign) QNIMUserCategory userCategory`
#### Discussion
用户级别
#### Declared In
`QNIMUserProfile.h`
### ` userName`
用户名
`@property (nonatomic, copy) NSString *userName`
#### Discussion
用户名
#### Declared In
`QNIMUserProfile.h`
### ` nickName`
昵称
`@property (nonatomic, copy) NSString *nickName`
#### Discussion
昵称
#### Declared In
`QNIMUserProfile.h`
### ` avatarUrl`
头像url
`@property (nonatomic, copy) NSString *avatarUrl`
#### Discussion
头像url
#### Declared In
`QNIMUserProfile.h`
### ` avatarPath`
头像本地路径
`@property (nonatomic, copy) NSString *avatarPath`
#### Discussion
头像本地路径
#### Declared In
`QNIMUserProfile.h`
### ` avatarThumbnailUrl`
头像缩略图url
`@property (nonatomic, copy) NSString *avatarThumbnailUrl`
#### Discussion
头像缩略图url
#### Declared In
`QNIMUserProfile.h`
### ` avatarThumbnailPath`
头像缩略图本地路径
`@property (nonatomic, copy) NSString *avatarThumbnailPath`
#### Discussion
头像缩略图本地路径
#### Declared In
`QNIMUserProfile.h`
### ` mobilePhone`
手机号
`@property (nonatomic, copy) NSString *mobilePhone`
#### Discussion
手机号
#### Declared In
`QNIMUserProfile.h`
### ` email`
用户邮箱
`@property (nonatomic, copy) NSString *email`
#### Discussion
用户邮箱
#### Declared In
`QNIMUserProfile.h`
### ` publicInfoJson`
公开信息
`@property (nonatomic, copy) NSString *publicInfoJson`
#### Discussion
公开信息
#### Declared In
`QNIMUserProfile.h`
### ` privateInfoJson`
私密信息
`@property (nonatomic, copy) NSString *privateInfoJson`
#### Discussion
私密信息
#### Declared In
`QNIMUserProfile.h`
### ` authQuestion`
验证问题
`@property (nonatomic, strong) QNIMAuthQuestion *authQuestion`
#### Discussion
验证问题
#### Declared In
`QNIMUserProfile.h`
### ` messageSetting`
消息设置
`@property (nonatomic, strong) QNIMMessageSetting *messageSetting`
#### Discussion
消息设置
#### Declared In
`QNIMUserProfile.h`
### ` addFriendAuthMode`
好友验证模式
`@property (nonatomic, assign) QNIMAddFriendAuthMode addFriendAuthMode`
#### Discussion
好友验证模式
#### Declared In
`QNIMUserProfile.h`
### ` isAutoAcceptGroupInvite`
自动接收群邀请
`@property (nonatomic, assign) BOOL isAutoAcceptGroupInvite`
#### Discussion
自动接收群邀请
#### Declared In
`QNIMUserProfile.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,526 |
QNIMGroupManager Protocol Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMGroupManager Protocol Reference
# QNIMGroupManager Protocol Reference
最近更新时间: 2021-06-27 18:09:12
# QNIMGroupManager Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupManager.h
### `- getGroupListForceRefresh:completion:`
获取群组列表
`- (void)getGroupListForceRefresh:(BOOL) _forceRefresh_ completion:(void ( ^ )
( NSArray *groupList , QNIMError *error )) _aCompletionBlock_`
#### Parameters
forceRefresh | 如果设置了forceRefresh则从服务器拉取
---|---
aCompletionBlock | GroupList, Error
#### Discussion
获取群组列表
#### Declared In
`QNIMGroupManager.h`
### `- getGroupInfoByGroupId:forceRefresh:completion:`
获取群信息
`- (void)getGroupInfoByGroupId:(long long) _groupId_ forceRefresh:(BOOL)
_forceRefresh_ completion:(void ( ^ ) ( QNIMGroup *group , QNIMError *error ))
_aCompletionBlock_`
#### Parameters
groupId | 群id
---|---
forceRefresh | 如果设置了forceRefresh则从服务器拉取
aCompletionBlock | 群
#### Discussion
获取群信息
#### Declared In
`QNIMGroupManager.h`
### `- getGroupInfoByGroupIdArray:forceRefresh:completion:`
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
`- (void)getGroupInfoByGroupIdArray:(NSArray<NSNumber*> *) _groupIdArray_
forceRefresh:(BOOL) _forceRefresh_ completion:(void ( ^ ) ( NSArray *aGroups ,
QNIMError *aError )) _aCompletionBlock_`
#### Discussion
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
#### Declared In
`QNIMGroupManager.h`
### `- getGroupByName:completion:`
通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
`- (void)getGroupByName:(NSString *) _name_ completion:(void ( ^ ) ( NSArray
*groupList , QNIMError *error )) _aCompletionBlock_`
#### Parameters
name | 查询的群名称关键字
---|---
aCompletionBlock | 搜索结果返回的群列表信息,[QNIMErrorCode](https://developer.qiniu.com/IM/8143/Constants/QNIMErrorCode.html)
#### Discussion
通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
#### Declared In
`QNIMGroupManager.h`
### `- destroyGroup:completion:`
销毁群(群主权限)
`- (void)destroyGroup:(QNIMGroup *) _group_ completion:(void ( ^ ) ( QNIMError
*error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | Error
#### Discussion
销毁群(群主权限)
#### Declared In
`QNIMGroupManager.h`
### `- joinGroup:message:completion:`
加入一个群，根据群设置可能需要管理员批准
`- (void)joinGroup:(QNIMGroup *) _group_ message:(NSString *) _message_
completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
message | 申请信息
aCompletionBlock | Error
#### Discussion
加入一个群，根据群设置可能需要管理员批准
#### Declared In
`QNIMGroupManager.h`
### `- leaveGroup:completion:`
退出群
`- (void)leaveGroup:(QNIMGroup *) _group_ completion:(void ( ^ ) ( QNIMError
*error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | Error
#### Discussion
退出群
#### Declared In
`QNIMGroupManager.h`
### `- loadGroupInfo:completion:`
获取群详情，从服务端拉取最新信息
`- (void)loadGroupInfo:(QNIMGroup *) _group_ completion:(void ( ^ ) (
QNIMGroup *group , QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html),QNIMError
#### Discussion
获取群详情，从服务端拉取最新信息
#### Declared In
`QNIMGroupManager.h`
### `- getMembersNickName:memberIdlist:completion:`
批量获取群组成员昵称
`- (void)getMembersNickName:(QNIMGroup *) _group_
memberIdlist:(NSArray<NSNumber*> *) _memberIdlist_ completion:(void ( ^ ) (
NSArray *aGroupMembers , QNIMError *aError )) _aCompletionBlock_`
#### Discussion
批量获取群组成员昵称
#### Declared In
`QNIMGroupManager.h`
### `- getMemberList:cursor:pageSize:completion:`
分页获取群成员列表
`- (void)getMemberList:(QNIMGroup *) _group_ cursor:(NSString *) _cursor_
pageSize:(int) _pageSize_ completion:(void ( ^ ) ( NSArray *memberList ,
NSString *cursor , long long offset , QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
cursor | String
pageSize | int
aCompletionBlock | NSArray *memberList,
#### Discussion
分页获取群成员列表
#### Declared In
`QNIMGroupManager.h`
### `- setGroupName:name:completion:`
设置群名称
`- (void)setGroupName:(QNIMGroup *) _group_ name:(NSString *) _name_
completion:(void ( ^ ) ( QNIMGroup *group , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
设置群名称
#### Declared In
`QNIMGroupManager.h`
### `- setMyNicknameWithGroup:nickName:completion:`
设置在群里的昵称
`- (void)setMyNicknameWithGroup:(QNIMGroup *) _group_ nickName:(NSString *)
_nickName_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Discussion
设置在群里的昵称
#### Declared In
`QNIMGroupManager.h`
### `- setHistoryVisibleWithGroup:enable:completion:`
设置群成员是否开可见群历史聊天记录
`- (void)setHistoryVisibleWithGroup:(QNIMGroup *) _group_ enable:(BOOL)
_enable_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | 进行操作的群组
---|---
enable | 是否开启
aCompletionBlock | QNIMError
#### Discussion
设置群成员是否开可见群历史聊天记录
#### Declared In
`QNIMGroupManager.h`
### `- addGroupListener:`
添加群组变化监听者
`- (void)addGroupListener:(id<QNIMGroupServiceProtocol>) _listener_`
#### Discussion
添加群组变化监听者
#### Declared In
`QNIMGroupManager.h`
### `- removeGroupListener:`
移除群组变化监听者
`- (void)removeGroupListener:(id<QNIMGroupServiceProtocol>) _listener_`
#### Discussion
移除群组变化监听者
#### Declared In
`QNIMGroupManager.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Class
List 类列表](https://developer.qiniu.com/IM/api/8190/class-list) >
QNIMGroupManager Protocol Reference
# QNIMGroupManager Protocol Reference
最近更新时间: 2021-06-27 18:09:12
# QNIMGroupManager Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupManager.h
### `- getGroupListForceRefresh:completion:`
获取群组列表
`- (void)getGroupListForceRefresh:(BOOL) _forceRefresh_ completion:(void ( ^ )
( NSArray *groupList , QNIMError *error )) _aCompletionBlock_`
#### Parameters
forceRefresh | 如果设置了forceRefresh则从服务器拉取
---|---
aCompletionBlock | GroupList, Error
#### Discussion
获取群组列表
#### Declared In
`QNIMGroupManager.h`
### `- getGroupInfoByGroupId:forceRefresh:completion:`
获取群信息
`- (void)getGroupInfoByGroupId:(long long) _groupId_ forceRefresh:(BOOL)
_forceRefresh_ completion:(void ( ^ ) ( QNIMGroup *group , QNIMError *error ))
_aCompletionBlock_`
#### Parameters
groupId | 群id
---|---
forceRefresh | 如果设置了forceRefresh则从服务器拉取
aCompletionBlock | 群
#### Discussion
获取群信息
#### Declared In
`QNIMGroupManager.h`
### `- getGroupInfoByGroupIdArray:forceRefresh:completion:`
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
`- (void)getGroupInfoByGroupIdArray:(NSArray<NSNumber*> *) _groupIdArray_
forceRefresh:(BOOL) _forceRefresh_ completion:(void ( ^ ) ( NSArray *aGroups ,
QNIMError *aError )) _aCompletionBlock_`
#### Discussion
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
#### Declared In
`QNIMGroupManager.h`
### `- getGroupByName:completion:`
通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
`- (void)getGroupByName:(NSString *) _name_ completion:(void ( ^ ) ( NSArray
*groupList , QNIMError *error )) _aCompletionBlock_`
#### Parameters
name | 查询的群名称关键字
---|---
aCompletionBlock | 搜索结果返回的群列表信息,[QNIMErrorCode](https://developer.qiniu.com/IM/8143/Constants/QNIMErrorCode.html)
#### Discussion
通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
#### Declared In
`QNIMGroupManager.h`
### `- destroyGroup:completion:`
销毁群(群主权限)
`- (void)destroyGroup:(QNIMGroup *) _group_ completion:(void ( ^ ) ( QNIMError
*error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | Error
#### Discussion
销毁群(群主权限)
#### Declared In
`QNIMGroupManager.h`
### `- joinGroup:message:completion:`
加入一个群，根据群设置可能需要管理员批准
`- (void)joinGroup:(QNIMGroup *) _group_ message:(NSString *) _message_
completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
message | 申请信息
aCompletionBlock | Error
#### Discussion
加入一个群，根据群设置可能需要管理员批准
#### Declared In
`QNIMGroupManager.h`
### `- leaveGroup:completion:`
退出群
`- (void)leaveGroup:(QNIMGroup *) _group_ completion:(void ( ^ ) ( QNIMError
*error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | Error
#### Discussion
退出群
#### Declared In
`QNIMGroupManager.h`
### `- loadGroupInfo:completion:`
获取群详情，从服务端拉取最新信息
`- (void)loadGroupInfo:(QNIMGroup *) _group_ completion:(void ( ^ ) (
QNIMGroup *group , QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
aCompletionBlock | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html),QNIMError
#### Discussion
获取群详情，从服务端拉取最新信息
#### Declared In
`QNIMGroupManager.h`
### `- getMembersNickName:memberIdlist:completion:`
批量获取群组成员昵称
`- (void)getMembersNickName:(QNIMGroup *) _group_
memberIdlist:(NSArray<NSNumber*> *) _memberIdlist_ completion:(void ( ^ ) (
NSArray *aGroupMembers , QNIMError *aError )) _aCompletionBlock_`
#### Discussion
批量获取群组成员昵称
#### Declared In
`QNIMGroupManager.h`
### `- getMemberList:cursor:pageSize:completion:`
分页获取群成员列表
`- (void)getMemberList:(QNIMGroup *) _group_ cursor:(NSString *) _cursor_
pageSize:(int) _pageSize_ completion:(void ( ^ ) ( NSArray *memberList ,
NSString *cursor , long long offset , QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | [QNIMGroup](https://developer.qiniu.com/IM/8143/Classes/QNIMGroup.html)
---|---
cursor | String
pageSize | int
aCompletionBlock | NSArray *memberList,
#### Discussion
分页获取群成员列表
#### Declared In
`QNIMGroupManager.h`
### `- setGroupName:name:completion:`
设置群名称
`- (void)setGroupName:(QNIMGroup *) _group_ name:(NSString *) _name_
completion:(void ( ^ ) ( QNIMGroup *group , QNIMError *error ))
_aCompletionBlock_`
#### Discussion
设置群名称
#### Declared In
`QNIMGroupManager.h`
### `- setMyNicknameWithGroup:nickName:completion:`
设置在群里的昵称
`- (void)setMyNicknameWithGroup:(QNIMGroup *) _group_ nickName:(NSString *)
_nickName_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Discussion
设置在群里的昵称
#### Declared In
`QNIMGroupManager.h`
### `- setHistoryVisibleWithGroup:enable:completion:`
设置群成员是否开可见群历史聊天记录
`- (void)setHistoryVisibleWithGroup:(QNIMGroup *) _group_ enable:(BOOL)
_enable_ completion:(void ( ^ ) ( QNIMError *error )) _aCompletionBlock_`
#### Parameters
group | 进行操作的群组
---|---
enable | 是否开启
aCompletionBlock | QNIMError
#### Discussion
设置群成员是否开可见群历史聊天记录
#### Declared In
`QNIMGroupManager.h`
### `- addGroupListener:`
添加群组变化监听者
`- (void)addGroupListener:(id<QNIMGroupServiceProtocol>) _listener_`
#### Discussion
添加群组变化监听者
#### Declared In
`QNIMGroupManager.h`
### `- removeGroupListener:`
移除群组变化监听者
`- (void)removeGroupListener:(id<QNIMGroupServiceProtocol>) _listener_`
#### Discussion
移除群组变化监听者
#### Declared In
`QNIMGroupManager.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,530 |
Protocol References | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Protocol
References
# Protocol References
最近更新时间: 2021-06-27 11:47:54
Protocol References
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Protocol
References
# Protocol References
最近更新时间: 2021-06-27 11:47:54
Protocol References
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,540 |
QNIMChatServiceProtocol Protocol Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
References](https://developer.qiniu.com/IM/api/8131/im-ios-protocol-
references) > QNIMChatServiceProtocol Protocol Reference
# QNIMChatServiceProtocol Protocol Reference
最近更新时间: 2021-06-27 18:02:08
# QNIMChatServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMChatServiceProtocol.h
### `- messageStatusChanged:error:`
消息发送状态发生变化
`- (void)messageStatusChanged:(QNIMMessageObject *) _message_ error:(QNIMError
*) _error_`
#### Discussion
消息发送状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedMessages:`
收到消息
`- (void)receivedMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息
#### Declared In
`QNIMChatServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
References](https://developer.qiniu.com/IM/api/8131/im-ios-protocol-
references) > QNIMChatServiceProtocol Protocol Reference
# QNIMChatServiceProtocol Protocol Reference
最近更新时间: 2021-06-27 18:02:08
# QNIMChatServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMChatServiceProtocol.h
### `- messageStatusChanged:error:`
消息发送状态发生变化
`- (void)messageStatusChanged:(QNIMMessageObject *) _message_ error:(QNIMError
*) _error_`
#### Discussion
消息发送状态发生变化
#### Declared In
`QNIMChatServiceProtocol.h`
### `- receivedMessages:`
收到消息
`- (void)receivedMessages:(NSArray<QNIMMessageObject*> *) _messages_`
#### Discussion
收到消息
#### Declared In
`QNIMChatServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,541 |
QNIMGroupServiceProtocol Protocol Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
References](https://developer.qiniu.com/IM/api/8131/im-ios-protocol-
references) > QNIMGroupServiceProtocol Protocol Reference
# QNIMGroupServiceProtocol Protocol Reference
最近更新时间: 2021-06-27 18:12:38
# QNIMGroupServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupServiceProtocol.h
### `- groupLeft:reason:` required method
退出了某群
`- (void)groupLeft:(QNIMGroup *) _group_ reason:(NSString *) _reason_`
#### Discussion
退出了某群
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberJoined:memberId:inviter:` required method
加入新成员
`- (void)groupMemberJoined:(QNIMGroup *) _group_ memberId:(NSInteger)
_memberId_ inviter:(NSInteger) _inviter_`
#### Discussion
加入新成员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberLeft:memberId:reason:` required method
群成员退出
`- (void)groupMemberLeft:(QNIMGroup *) _group_ memberId:(NSInteger) _memberId_
reason:(NSString *) _reason_`
#### Discussion
群成员退出
#### Declared In
`QNIMGroupServiceProtocol.h`
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Protocol
References](https://developer.qiniu.com/IM/api/8131/im-ios-protocol-
references) > QNIMGroupServiceProtocol Protocol Reference
# QNIMGroupServiceProtocol Protocol Reference
最近更新时间: 2021-06-27 18:12:38
# QNIMGroupServiceProtocol Protocol Reference
Conforms to | NSObject
---|---
Declared in | QNIMGroupServiceProtocol.h
### `- groupLeft:reason:` required method
退出了某群
`- (void)groupLeft:(QNIMGroup *) _group_ reason:(NSString *) _reason_`
#### Discussion
退出了某群
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberJoined:memberId:inviter:` required method
加入新成员
`- (void)groupMemberJoined:(QNIMGroup *) _group_ memberId:(NSInteger)
_memberId_ inviter:(NSInteger) _inviter_`
#### Discussion
加入新成员
#### Declared In
`QNIMGroupServiceProtocol.h`
### `- groupMemberLeft:memberId:reason:` required method
群成员退出
`- (void)groupMemberLeft:(QNIMGroup *) _group_ memberId:(NSInteger) _memberId_
reason:(NSString *) _reason_`
#### Discussion
群成员退出
#### Declared In
`QNIMGroupServiceProtocol.h`
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,543 |
Constant References | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Constant
References
# Constant References
最近更新时间: 2021-06-27 18:14:53
Constant References
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > Constant
References
# Constant References
最近更新时间: 2021-06-27 18:14:53
Constant References
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,546 |
QNIMConnectStatus Constants Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMConnectStatus Constants Reference
# QNIMConnectStatus Constants Reference
最近更新时间: 2021-06-27 18:31:09
# QNIMConnectStatus Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMConnectStatus
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMConnectStatus ) {
[QNIMConnectStatusDisconnected](), [QNIMConnectStatusConnected](), };`
#### Constants
`QNIMConnectStatusDisconnected`
Declared In `QNIMClient.h`.
`QNIMConnectStatusConnected`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMConnectStatus Constants Reference
# QNIMConnectStatus Constants Reference
最近更新时间: 2021-06-27 18:31:09
# QNIMConnectStatus Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMConnectStatus
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMConnectStatus ) {
[QNIMConnectStatusDisconnected](), [QNIMConnectStatusConnected](), };`
#### Constants
`QNIMConnectStatusDisconnected`
Declared In `QNIMClient.h`.
`QNIMConnectStatusConnected`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,547 |
QNIMErrorCode Constants Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMErrorCode Constants Reference
# QNIMErrorCode Constants Reference
最近更新时间: 2021-06-27 18:32:32
# QNIMErrorCode Constants Reference
Declared in | QNIMError.h
---|---
### QNIMErrorCode
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMErrorCode ) { [QNIMNoError]() = 0,
[QNIMGeneralError]() = 1, [QNIMInvalidParam]() = 2, [QNIMNotFound]() = 3,
[QNIMUserNotLogin]() = 4, [QNIMUserAlreadyLogin]() = 5, [QNIMUserAuthFailed]()
= 6, [QNIMUserPermissionDenied]() = 7, [QNIMUserNotExist]() = 8,
[QNIMUserAlreadyExist]() = 9, [QNIMUserFrozen]() = 10, [QNIMUserBanned]() =
11, [QNIMUserRemoved]() = 12, [QNIMUserTooManyDevice]() = 13,
[QNIMUserPasswordChanged]() = 14, [QNIMUserKickedBySameDevice]() = 15,
[QNIMUserKickedByOtherDevices]() = 16, [QNIMUserAbnormal]() = 17,
[QNIMUserCancel]() = 18, [QNIMInvalidVerificationCode]() = 19,
[QNIMInvalidRequestParameter]() = 20, [QNIMInvalidUserNameParameter]() = 21,
[QNIMMissingAccessToken]() = 22, [QNIMCurrentUserIsInRoster]() = 23,
[QNIMCurrentUserIsInBlocklist]() = 24, [QNIMAnswerFailed]() = 25,
[QNIMInvalidToken]() = 26, [QNIMRosterNotFriend]() = 27,
[QNIMRosterBlockListExist]() = 28, [QNIMRosterRejectApplication]() = 29,
[QNIMGroupServerDbError]() = 30, [QNIMGroupNotExist]() = 31,
[QNIMGroupNotMemberFound]() = 32, [QNIMGroupMsgNotifyTypeUnknown]() = 33,
[QNIMGroupOwnerCannotLeave]() = 34, [QNIMGroupTransferNotAllowed]() = 35,
[QNIMGroupRecoveryMode]() = 36, [QNIMGroupExceedLimitGlobal]() = 37,
[QNIMGroupExceedLimitUserCreate]() = 38, [QNIMGroupExceedLimitUserJoin]() =
39, [QNIMGroupCapacityExceedLimit]() = 40,
[QNIMGroupMemberPermissionRequired]() = 41,
[QNIMGroupAdminPermissionRequired]() = 42,
[QNIMGroupOwnerPermissionRequired]() = 43,
[QNIMGroupApplicationExpiredOrHandled]() = 44,
[QNIMGroupInvitationExpiredOrHandled]() = 45, [QNIMGroupKickTooManyTimes]() =
46, [QNIMGroupMemberExist]() = 47, [QNIMGroupBlockListExist]() = 48,
[QNIMGroupAnnouncementNotFound]() = 49, [QNIMGroupAnnouncementForbidden]() =
50, [QNIMGroupSharedFileNotFound]() = 51,
[QNIMGroupSharedFileOperateNotAllowed]() = 52, [QNIMGroupMemberBanned]() = 53,
[QNIMSignInCancelled]() = 54, [QNIMSignInTimeout]() = 55, [QNIMSignInFailed]()
= 56, [QNIMDbOperationFailed]() = 57, [QNIMMessageInvalid]() = 58,
[QNIMMessageOutRecallTime]() = 59, [QNIMMessageRecallDisabled]() = 60,
[QNIMMessageCensored]() = 61, [QNIMMessageInvalidType]() = 62,
[QNIMServerNotReachable]() = 63, [QNIMServerUnknownError]() = 64,
[QNIMServerInvalid]() = 65, [QNIMServerDecryptionFailed]() = 66,
[QNIMServerEncryptMethodUnsupported](), [QNIMServerBusy](),
[QNIMServerNeedRetry](), [QNIMServerTimeOut](), [QNIMServerConnectFailed](),
[QNIMServerDNSFailed](), [QNIMServerNeedReconnected](),
[QNIMServerFileUploadUnknownError](), [QNIMServerFileDownloadUnknownError](),
[QNIMServerInvalidLicense](), [QNIMServerLicenseLimit](),
[QNIMServerAppFrozen](), [QNIMServerTooManyRequest](), };`
#### Constants
`QNIMNoError`
Declared In `QNIMError.h`.
`QNIMGeneralError`
Declared In `QNIMError.h`.
`QNIMInvalidParam`
Declared In `QNIMError.h`.
`QNIMNotFound`
Declared In `QNIMError.h`.
`QNIMUserNotLogin`
Declared In `QNIMError.h`.
`QNIMUserAlreadyLogin`
Declared In `QNIMError.h`.
`QNIMUserAuthFailed`
Declared In `QNIMError.h`.
`QNIMUserPermissionDenied`
Declared In `QNIMError.h`.
`QNIMUserNotExist`
Declared In `QNIMError.h`.
`QNIMUserAlreadyExist`
Declared In `QNIMError.h`.
`QNIMUserFrozen`
Declared In `QNIMError.h`.
`QNIMUserBanned`
Declared In `QNIMError.h`.
`QNIMUserRemoved`
Declared In `QNIMError.h`.
`QNIMUserTooManyDevice`
Declared In `QNIMError.h`.
`QNIMUserPasswordChanged`
Declared In `QNIMError.h`.
`QNIMUserKickedBySameDevice`
Declared In `QNIMError.h`.
`QNIMUserKickedByOtherDevices`
Declared In `QNIMError.h`.
`QNIMUserAbnormal`
Declared In `QNIMError.h`.
`QNIMUserCancel`
Declared In `QNIMError.h`.
`QNIMInvalidVerificationCode`
Declared In `QNIMError.h`.
`QNIMInvalidRequestParameter`
Declared In `QNIMError.h`.
`QNIMInvalidUserNameParameter`
Declared In `QNIMError.h`.
`QNIMMissingAccessToken`
Declared In `QNIMError.h`.
`QNIMCurrentUserIsInRoster`
Declared In `QNIMError.h`.
`QNIMCurrentUserIsInBlocklist`
Declared In `QNIMError.h`.
`QNIMAnswerFailed`
Declared In `QNIMError.h`.
`QNIMInvalidToken`
Declared In `QNIMError.h`.
`QNIMRosterNotFriend`
Declared In `QNIMError.h`.
`QNIMRosterBlockListExist`
Declared In `QNIMError.h`.
`QNIMRosterRejectApplication`
Declared In `QNIMError.h`.
`QNIMGroupServerDbError`
Declared In `QNIMError.h`.
`QNIMGroupNotExist`
Declared In `QNIMError.h`.
`QNIMGroupNotMemberFound`
Declared In `QNIMError.h`.
`QNIMGroupMsgNotifyTypeUnknown`
Declared In `QNIMError.h`.
`QNIMGroupOwnerCannotLeave`
Declared In `QNIMError.h`.
`QNIMGroupTransferNotAllowed`
Declared In `QNIMError.h`.
`QNIMGroupRecoveryMode`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitGlobal`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitUserCreate`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitUserJoin`
Declared In `QNIMError.h`.
`QNIMGroupCapacityExceedLimit`
Declared In `QNIMError.h`.
`QNIMGroupMemberPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupAdminPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupOwnerPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupApplicationExpiredOrHandled`
Declared In `QNIMError.h`.
`QNIMGroupInvitationExpiredOrHandled`
Declared In `QNIMError.h`.
`QNIMGroupKickTooManyTimes`
Declared In `QNIMError.h`.
`QNIMGroupMemberExist`
Declared In `QNIMError.h`.
`QNIMGroupBlockListExist`
Declared In `QNIMError.h`.
`QNIMGroupAnnouncementNotFound`
Declared In `QNIMError.h`.
`QNIMGroupAnnouncementForbidden`
Declared In `QNIMError.h`.
`QNIMGroupSharedFileNotFound`
Declared In `QNIMError.h`.
`QNIMGroupSharedFileOperateNotAllowed`
Declared In `QNIMError.h`.
`QNIMGroupMemberBanned`
Declared In `QNIMError.h`.
`QNIMSignInCancelled`
Declared In `QNIMError.h`.
`QNIMSignInTimeout`
Declared In `QNIMError.h`.
`QNIMSignInFailed`
Declared In `QNIMError.h`.
`QNIMDbOperationFailed`
Declared In `QNIMError.h`.
`QNIMMessageInvalid`
Declared In `QNIMError.h`.
`QNIMMessageOutRecallTime`
Declared In `QNIMError.h`.
`QNIMMessageRecallDisabled`
Declared In `QNIMError.h`.
`QNIMMessageCensored`
Declared In `QNIMError.h`.
`QNIMMessageInvalidType`
Declared In `QNIMError.h`.
`QNIMServerNotReachable`
Declared In `QNIMError.h`.
`QNIMServerUnknownError`
Declared In `QNIMError.h`.
`QNIMServerInvalid`
Declared In `QNIMError.h`.
`QNIMServerDecryptionFailed`
Declared In `QNIMError.h`.
`QNIMServerEncryptMethodUnsupported`
Declared In `QNIMError.h`.
`QNIMServerBusy`
Declared In `QNIMError.h`.
`QNIMServerNeedRetry`
Declared In `QNIMError.h`.
`QNIMServerTimeOut`
Declared In `QNIMError.h`.
`QNIMServerConnectFailed`
Declared In `QNIMError.h`.
`QNIMServerDNSFailed`
Declared In `QNIMError.h`.
`QNIMServerNeedReconnected`
Declared In `QNIMError.h`.
`QNIMServerFileUploadUnknownError`
Declared In `QNIMError.h`.
`QNIMServerFileDownloadUnknownError`
Declared In `QNIMError.h`.
`QNIMServerInvalidLicense`
Declared In `QNIMError.h`.
`QNIMServerLicenseLimit`
Declared In `QNIMError.h`.
`QNIMServerAppFrozen`
Declared In `QNIMError.h`.
`QNIMServerTooManyRequest`
Declared In `QNIMError.h`.
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMErrorCode Constants Reference
# QNIMErrorCode Constants Reference
最近更新时间: 2021-06-27 18:32:32
# QNIMErrorCode Constants Reference
Declared in | QNIMError.h
---|---
### QNIMErrorCode
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMErrorCode ) { [QNIMNoError]() = 0,
[QNIMGeneralError]() = 1, [QNIMInvalidParam]() = 2, [QNIMNotFound]() = 3,
[QNIMUserNotLogin]() = 4, [QNIMUserAlreadyLogin]() = 5, [QNIMUserAuthFailed]()
= 6, [QNIMUserPermissionDenied]() = 7, [QNIMUserNotExist]() = 8,
[QNIMUserAlreadyExist]() = 9, [QNIMUserFrozen]() = 10, [QNIMUserBanned]() =
11, [QNIMUserRemoved]() = 12, [QNIMUserTooManyDevice]() = 13,
[QNIMUserPasswordChanged]() = 14, [QNIMUserKickedBySameDevice]() = 15,
[QNIMUserKickedByOtherDevices]() = 16, [QNIMUserAbnormal]() = 17,
[QNIMUserCancel]() = 18, [QNIMInvalidVerificationCode]() = 19,
[QNIMInvalidRequestParameter]() = 20, [QNIMInvalidUserNameParameter]() = 21,
[QNIMMissingAccessToken]() = 22, [QNIMCurrentUserIsInRoster]() = 23,
[QNIMCurrentUserIsInBlocklist]() = 24, [QNIMAnswerFailed]() = 25,
[QNIMInvalidToken]() = 26, [QNIMRosterNotFriend]() = 27,
[QNIMRosterBlockListExist]() = 28, [QNIMRosterRejectApplication]() = 29,
[QNIMGroupServerDbError]() = 30, [QNIMGroupNotExist]() = 31,
[QNIMGroupNotMemberFound]() = 32, [QNIMGroupMsgNotifyTypeUnknown]() = 33,
[QNIMGroupOwnerCannotLeave]() = 34, [QNIMGroupTransferNotAllowed]() = 35,
[QNIMGroupRecoveryMode]() = 36, [QNIMGroupExceedLimitGlobal]() = 37,
[QNIMGroupExceedLimitUserCreate]() = 38, [QNIMGroupExceedLimitUserJoin]() =
39, [QNIMGroupCapacityExceedLimit]() = 40,
[QNIMGroupMemberPermissionRequired]() = 41,
[QNIMGroupAdminPermissionRequired]() = 42,
[QNIMGroupOwnerPermissionRequired]() = 43,
[QNIMGroupApplicationExpiredOrHandled]() = 44,
[QNIMGroupInvitationExpiredOrHandled]() = 45, [QNIMGroupKickTooManyTimes]() =
46, [QNIMGroupMemberExist]() = 47, [QNIMGroupBlockListExist]() = 48,
[QNIMGroupAnnouncementNotFound]() = 49, [QNIMGroupAnnouncementForbidden]() =
50, [QNIMGroupSharedFileNotFound]() = 51,
[QNIMGroupSharedFileOperateNotAllowed]() = 52, [QNIMGroupMemberBanned]() = 53,
[QNIMSignInCancelled]() = 54, [QNIMSignInTimeout]() = 55, [QNIMSignInFailed]()
= 56, [QNIMDbOperationFailed]() = 57, [QNIMMessageInvalid]() = 58,
[QNIMMessageOutRecallTime]() = 59, [QNIMMessageRecallDisabled]() = 60,
[QNIMMessageCensored]() = 61, [QNIMMessageInvalidType]() = 62,
[QNIMServerNotReachable]() = 63, [QNIMServerUnknownError]() = 64,
[QNIMServerInvalid]() = 65, [QNIMServerDecryptionFailed]() = 66,
[QNIMServerEncryptMethodUnsupported](), [QNIMServerBusy](),
[QNIMServerNeedRetry](), [QNIMServerTimeOut](), [QNIMServerConnectFailed](),
[QNIMServerDNSFailed](), [QNIMServerNeedReconnected](),
[QNIMServerFileUploadUnknownError](), [QNIMServerFileDownloadUnknownError](),
[QNIMServerInvalidLicense](), [QNIMServerLicenseLimit](),
[QNIMServerAppFrozen](), [QNIMServerTooManyRequest](), };`
#### Constants
`QNIMNoError`
Declared In `QNIMError.h`.
`QNIMGeneralError`
Declared In `QNIMError.h`.
`QNIMInvalidParam`
Declared In `QNIMError.h`.
`QNIMNotFound`
Declared In `QNIMError.h`.
`QNIMUserNotLogin`
Declared In `QNIMError.h`.
`QNIMUserAlreadyLogin`
Declared In `QNIMError.h`.
`QNIMUserAuthFailed`
Declared In `QNIMError.h`.
`QNIMUserPermissionDenied`
Declared In `QNIMError.h`.
`QNIMUserNotExist`
Declared In `QNIMError.h`.
`QNIMUserAlreadyExist`
Declared In `QNIMError.h`.
`QNIMUserFrozen`
Declared In `QNIMError.h`.
`QNIMUserBanned`
Declared In `QNIMError.h`.
`QNIMUserRemoved`
Declared In `QNIMError.h`.
`QNIMUserTooManyDevice`
Declared In `QNIMError.h`.
`QNIMUserPasswordChanged`
Declared In `QNIMError.h`.
`QNIMUserKickedBySameDevice`
Declared In `QNIMError.h`.
`QNIMUserKickedByOtherDevices`
Declared In `QNIMError.h`.
`QNIMUserAbnormal`
Declared In `QNIMError.h`.
`QNIMUserCancel`
Declared In `QNIMError.h`.
`QNIMInvalidVerificationCode`
Declared In `QNIMError.h`.
`QNIMInvalidRequestParameter`
Declared In `QNIMError.h`.
`QNIMInvalidUserNameParameter`
Declared In `QNIMError.h`.
`QNIMMissingAccessToken`
Declared In `QNIMError.h`.
`QNIMCurrentUserIsInRoster`
Declared In `QNIMError.h`.
`QNIMCurrentUserIsInBlocklist`
Declared In `QNIMError.h`.
`QNIMAnswerFailed`
Declared In `QNIMError.h`.
`QNIMInvalidToken`
Declared In `QNIMError.h`.
`QNIMRosterNotFriend`
Declared In `QNIMError.h`.
`QNIMRosterBlockListExist`
Declared In `QNIMError.h`.
`QNIMRosterRejectApplication`
Declared In `QNIMError.h`.
`QNIMGroupServerDbError`
Declared In `QNIMError.h`.
`QNIMGroupNotExist`
Declared In `QNIMError.h`.
`QNIMGroupNotMemberFound`
Declared In `QNIMError.h`.
`QNIMGroupMsgNotifyTypeUnknown`
Declared In `QNIMError.h`.
`QNIMGroupOwnerCannotLeave`
Declared In `QNIMError.h`.
`QNIMGroupTransferNotAllowed`
Declared In `QNIMError.h`.
`QNIMGroupRecoveryMode`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitGlobal`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitUserCreate`
Declared In `QNIMError.h`.
`QNIMGroupExceedLimitUserJoin`
Declared In `QNIMError.h`.
`QNIMGroupCapacityExceedLimit`
Declared In `QNIMError.h`.
`QNIMGroupMemberPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupAdminPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupOwnerPermissionRequired`
Declared In `QNIMError.h`.
`QNIMGroupApplicationExpiredOrHandled`
Declared In `QNIMError.h`.
`QNIMGroupInvitationExpiredOrHandled`
Declared In `QNIMError.h`.
`QNIMGroupKickTooManyTimes`
Declared In `QNIMError.h`.
`QNIMGroupMemberExist`
Declared In `QNIMError.h`.
`QNIMGroupBlockListExist`
Declared In `QNIMError.h`.
`QNIMGroupAnnouncementNotFound`
Declared In `QNIMError.h`.
`QNIMGroupAnnouncementForbidden`
Declared In `QNIMError.h`.
`QNIMGroupSharedFileNotFound`
Declared In `QNIMError.h`.
`QNIMGroupSharedFileOperateNotAllowed`
Declared In `QNIMError.h`.
`QNIMGroupMemberBanned`
Declared In `QNIMError.h`.
`QNIMSignInCancelled`
Declared In `QNIMError.h`.
`QNIMSignInTimeout`
Declared In `QNIMError.h`.
`QNIMSignInFailed`
Declared In `QNIMError.h`.
`QNIMDbOperationFailed`
Declared In `QNIMError.h`.
`QNIMMessageInvalid`
Declared In `QNIMError.h`.
`QNIMMessageOutRecallTime`
Declared In `QNIMError.h`.
`QNIMMessageRecallDisabled`
Declared In `QNIMError.h`.
`QNIMMessageCensored`
Declared In `QNIMError.h`.
`QNIMMessageInvalidType`
Declared In `QNIMError.h`.
`QNIMServerNotReachable`
Declared In `QNIMError.h`.
`QNIMServerUnknownError`
Declared In `QNIMError.h`.
`QNIMServerInvalid`
Declared In `QNIMError.h`.
`QNIMServerDecryptionFailed`
Declared In `QNIMError.h`.
`QNIMServerEncryptMethodUnsupported`
Declared In `QNIMError.h`.
`QNIMServerBusy`
Declared In `QNIMError.h`.
`QNIMServerNeedRetry`
Declared In `QNIMError.h`.
`QNIMServerTimeOut`
Declared In `QNIMError.h`.
`QNIMServerConnectFailed`
Declared In `QNIMError.h`.
`QNIMServerDNSFailed`
Declared In `QNIMError.h`.
`QNIMServerNeedReconnected`
Declared In `QNIMError.h`.
`QNIMServerFileUploadUnknownError`
Declared In `QNIMError.h`.
`QNIMServerFileDownloadUnknownError`
Declared In `QNIMError.h`.
`QNIMServerInvalidLicense`
Declared In `QNIMError.h`.
`QNIMServerLicenseLimit`
Declared In `QNIMError.h`.
`QNIMServerAppFrozen`
Declared In `QNIMError.h`.
`QNIMServerTooManyRequest`
Declared In `QNIMError.h`.
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,549 |
QNIMLogLevel Constants Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMLogLevel Constants Reference
# QNIMLogLevel Constants Reference
最近更新时间: 2021-06-27 18:33:47
# QNIMLogLevel Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMLogLevel
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMLogLevel ) { [QNIMLogLevelError](),
[QNIMLogLevelWarning](), [QNIMLogLevelDebug](), };`
#### Constants
`QNIMLogLevelError`
Declared In `QNIMClient.h`.
`QNIMLogLevelWarning`
Declared In `QNIMClient.h`.
`QNIMLogLevelDebug`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMLogLevel Constants Reference
# QNIMLogLevel Constants Reference
最近更新时间: 2021-06-27 18:33:47
# QNIMLogLevel Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMLogLevel
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMLogLevel ) { [QNIMLogLevelError](),
[QNIMLogLevelWarning](), [QNIMLogLevelDebug](), };`
#### Constants
`QNIMLogLevelError`
Declared In `QNIMClient.h`.
`QNIMLogLevelWarning`
Declared In `QNIMClient.h`.
`QNIMLogLevelDebug`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,569 |
QNIMNetworkType Constants Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMNetworkType Constants Reference
# QNIMNetworkType Constants Reference
最近更新时间: 2021-06-27 18:35:03
# QNIMNetworkType Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMNetworkType
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMNetworkType ) { [QNIMNetworkTypeMobile](),
[QNIMNetworkTypeWifi](), [QNIMNetworkTypeCable](), [QNIMNetworkTypeNone](),
};`
#### Constants
`QNIMNetworkTypeMobile`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeWifi`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeCable`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeNone`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMNetworkType Constants Reference
# QNIMNetworkType Constants Reference
最近更新时间: 2021-06-27 18:35:03
# QNIMNetworkType Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMNetworkType
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMNetworkType ) { [QNIMNetworkTypeMobile](),
[QNIMNetworkTypeWifi](), [QNIMNetworkTypeCable](), [QNIMNetworkTypeNone](),
};`
#### Constants
`QNIMNetworkTypeMobile`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeWifi`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeCable`
Declared In `QNIMClient.h`.
`QNIMNetworkTypeNone`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,571 |
QNIMSignInStatus Constants Reference | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMSignInStatus Constants Reference
# QNIMSignInStatus Constants Reference
最近更新时间: 2021-06-27 18:36:13
# QNIMSignInStatus Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMSignInStatus
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMSignInStatus ) { [QNIMSignInStatusSignOut](),
[QNIMSignInStatusSignIn](), };`
#### Constants
`QNIMSignInStatusSignOut`
Declared In `QNIMClient.h`.
`QNIMSignInStatusSignIn`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [iOS API
参考](https://developer.qiniu.com/IM/api/8104/im-ios-api-hierarchy) > [Constant
References](https://developer.qiniu.com/IM/api/8145/im-ios-constant-
references) > QNIMSignInStatus Constants Reference
# QNIMSignInStatus Constants Reference
最近更新时间: 2021-06-27 18:36:13
# QNIMSignInStatus Constants Reference
Declared in | QNIMClient.h
---|---
### QNIMSignInStatus
#### Definition
`typedef NS_ENUM(NSUInteger, QNIMSignInStatus ) { [QNIMSignInStatusSignOut](),
[QNIMSignInStatusSignIn](), };`
#### Constants
`QNIMSignInStatusSignOut`
Declared In `QNIMClient.h`.
`QNIMSignInStatusSignIn`
Declared In `QNIMClient.h`.
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,573 |
ANDROID API | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > ANDROID API
# ANDROID API
最近更新时间: 2022-07-22 22:34:27
[QNIMClient](https://developer.qiniu.com/IM/api/8296/qnimclient)
七牛im 客户端
[BXMChatRoomService](https://developer.qiniu.com/IM/api/8200/bxmchatroomservice)
聊天室
[BXMChatRoomManager](https://developer.qiniu.com/IM/api/8298/bxmchatroommanager)
聊天室
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice)
聊天Service
[BMXChatService.ThumbnailStrategy](https://developer.qiniu.com/IM/api/8303/bmxchatservice-
thumbnailstrategy)
缩略图生成策略,
[BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
[BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
客户端类型
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
网络连接状态
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
会话
[BMXConversation.Type](https://developer.qiniu.com/IM/api/8208/bmxconversation-
type)
会话类型
[BMXConversation.Direction](https://developer.qiniu.com/IM/api/8317/bmxconversation
--direction)
消息搜索方向
[BMXDevice](https://developer.qiniu.com/IM/api/8209/bmxdevice)
设备信息
[BMXFileAttachment](https://developer.qiniu.com/IM/api/8210/bmxfileattachment)
消息文件附件
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群组
[BMXGroup.Member](https://developer.qiniu.com/IM/api/8223/bmxgroup-member)
群成员
[BMXGroup.BannedMember](https://developer.qiniu.com/IM/api/8215/bmxgroup-
bannedmember)
群禁言成员
[BMXGroup.SharedFile](https://developer.qiniu.com/IM/api/8302/bmxgroup-
sharedfile)
群共享文件
[BMXGroup.Announcement](https://developer.qiniu.com/IM/api/8212/bmxgroup-
announcement)
群公告
[BMXGroup.Invitation](https://developer.qiniu.com/IM/api/8219/bmxgroup-
invitation)
群邀请
[BMXGroup.Application](https://developer.qiniu.com/IM/api/8213/bmxgroup-
application)
群申请
[BMXGroup.InvitationStatus](https://developer.qiniu.com/IM/api/8220/BMXGroup.InvitationStatus)
群邀请状态
[BMXGroup.ApplicationStatus](https://developer.qiniu.com/IM/api/8214/bmxgroup-
applicationstatus)
群申请状态
[BMXGroup.MsgPushMode](https://developer.qiniu.com/IM/api/8227/bmxgroup-
msgpushmode)
消息通知类型
[BMXGroup.ModifyMode](https://developer.qiniu.com/IM/api/8225/bmxgroup-
modifymode)
群信息修改模式
[BMXGroup.JoinAuthMode](https://developer.qiniu.com/IM/api/8222/bmxgroup-
joinauthmode)
进群验证方式
[BMXGroup.InviteMode](https://developer.qiniu.com/IM/api/8221/bmxgroup-
invitemode)
邀请入群模式
[BMXGroup.UpdateInfoType](https://developer.qiniu.com/IM/api/8229/bmxgroup-
updateinfotype)
群组信息更新类型
[BMXGroup.GroupStatus](https://developer.qiniu.com/IM/api/8217/bmxgroup--
groupstatus)
群组状态
[BMXGroup.MsgMuteMode](https://developer.qiniu.com/IM/api/8226/bmxgroup-
msgmutemode)
群组消息屏蔽模式
[BMXGroup.MemberRoleType](https://developer.qiniu.com/IM/api/8224/bmxgroup-
memberroletype)
群成员角色
[BMXGroup.GroupType](https://developer.qiniu.com/IM/api/8218/bmxgroup-
grouptype)
群类型
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice)
群组Service
[BMXGroupService.CreateGroupOptions](https://developer.qiniu.com/IM/api/8232/bmxgroupservice-
creategroupoptions)
创建群组选项
[BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
[BMXImageAttachment](https://developer.qiniu.com/IM/api/8236/bmximageattachment)
图片消息附件
[BMXLocationAttachment](https://developer.qiniu.com/IM/api/8237/bmxlocationattachment)
位置消息附件
[BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
日志级别
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
消息
[BMXMessage.DeliveryStatus](https://developer.qiniu.com/IM/api/8242/bmxmessage-
deliverystatus)
消息投递状态
[BMXMessage.MessageType](https://developer.qiniu.com/IM/api/8243/bmxmessage-
messagetype)
消息类型
[BMXMessage.ContentType](https://developer.qiniu.com/IM/api/8240/bmxmessage-
contenttype)
消息内容类型
[BMXMessage.DeliveryQos](https://developer.qiniu.com/IM/api/8241/bmxmessage-
deliveryqos)
消息投递质量
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
消息附件
[BMXMessageAttachment.Size](https://developer.qiniu.com/IM/api/8246/bmxmessageattachment-
size)
图片/视频大小
[BMXMessageAttachment.Type](https://developer.qiniu.com/IM/api/8247/bmxmessageattachment-
type)
附件类型
[BMXMessageAttachment.DownloadStatus](https://developer.qiniu.com/IM/api/8245/bmxmessageattachment-
downloadstatus)
附件下载状态
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
消息配置
[BMXMessageConfig.BadgeCountType](https://developer.qiniu.com/IM/api/8249/bmxmessageconfig-
badgecounttype)
[BMXNetworkListener](https://developer.qiniu.com/IM/api/8250/bmxnetworklistener)
网络监听者
[BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
网络类型
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
联系人
[BMXRosterItem.RosterRelation](https://developer.qiniu.com/IM/api/8276/bmxrosteritem-
rosterrelation)
好友关系
[BMXRosterItem.AddFriendAuthMode](https://developer.qiniu.com/IM/api/8275/bmxrosteritem-
addfriendauthmode)
roster 被申请加好友时的验证方式
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice)
好友Service
[BMXRosterService.Application](https://developer.qiniu.com/IM/api/8300/bmxrosterservice-
application)
好友邀请
[BMXRosterService.ApplicationStatus](https://developer.qiniu.com/IM/api/8301/bmxrosterservice-
applicationstatus)
请求状态
[BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
[BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
SDK设置管理
[BMXSDKConfig.HostConfig](https://developer.qiniu.com/IM/api/8285/bmxsdkconfig-
hostconfig)
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
登录状态
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户Profile
[BMXUserProfile.AuthQuestion](https://developer.qiniu.com/IM/api/8308/bmxuserprofile
--authquestion)
添加好友时的校验问题
[BMXUserProfile.MessageSetting](https://developer.qiniu.com/IM/api/8313/bmxuserprofile
--messagesetting)
用户消息设置
[BMXUserProfile.AddFriendAuthMode](https://developer.qiniu.com/IM/api/8306/bmxuserprofile
--addfriendauthmode)
对方申请加好友时的验证方式
[BMXUserProfile.UserCategory](https://developer.qiniu.com/IM/api/8311/bmxuserprofile
--usercategory)
用户类型
[BMXUserService](https://developer.qiniu.com/IM/api/8292/bmxuserservice)
用户Service
[BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
[BMXVideoAttachment](https://developer.qiniu.com/IM/api/8294/bmxvideoattachment)
视频消息附件
[BMXVoiceAttachment](https://developer.qiniu.com/IM/api/8297/bmxvoiceattachment)
音频消息附件
[BMXUserManager](https://developer.qiniu.com/IM/api/8287/bmxusermanager)
用户管理器
[BMXGroupManager](https://developer.qiniu.com/IM/api/8230/bmxgroupmanager)
群组管理器
[BMXRosterManager](https://developer.qiniu.com/IM/api/8277/bmxrostermanager)
好友管理器
[BMXChatManager](https://developer.qiniu.com/IM/api/8201/bmxchatmanager)
聊天管理器
[BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
[BMXPushManager](https://developer.qiniu.com/IM/api/8253/bmxpushmanager)
推送管理器
[BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice)
[BMXPushService.PushSdkStatus](https://developer.qiniu.com/IM/api/8315/bmxpushservice-
pushsdkstatus)
push sdk状态
[BMXPushService.PushDirection](https://developer.qiniu.com/IM/api/8268/bmxpushservice-
pushdirection)
本地推送消息搜索方向
[BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
[BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
[BMXPushUserProfile.MessagePushSetting](https://developer.qiniu.com/IM/api/8272/bmxpushuserprofile-
messagepushsetting)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > ANDROID API
# ANDROID API
最近更新时间: 2022-07-22 22:34:27
[QNIMClient](https://developer.qiniu.com/IM/api/8296/qnimclient)
七牛im 客户端
[BXMChatRoomService](https://developer.qiniu.com/IM/api/8200/bxmchatroomservice)
聊天室
[BXMChatRoomManager](https://developer.qiniu.com/IM/api/8298/bxmchatroommanager)
聊天室
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice)
聊天Service
[BMXChatService.ThumbnailStrategy](https://developer.qiniu.com/IM/api/8303/bmxchatservice-
thumbnailstrategy)
缩略图生成策略,
[BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
[BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
客户端类型
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
网络连接状态
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
会话
[BMXConversation.Type](https://developer.qiniu.com/IM/api/8208/bmxconversation-
type)
会话类型
[BMXConversation.Direction](https://developer.qiniu.com/IM/api/8317/bmxconversation
--direction)
消息搜索方向
[BMXDevice](https://developer.qiniu.com/IM/api/8209/bmxdevice)
设备信息
[BMXFileAttachment](https://developer.qiniu.com/IM/api/8210/bmxfileattachment)
消息文件附件
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群组
[BMXGroup.Member](https://developer.qiniu.com/IM/api/8223/bmxgroup-member)
群成员
[BMXGroup.BannedMember](https://developer.qiniu.com/IM/api/8215/bmxgroup-
bannedmember)
群禁言成员
[BMXGroup.SharedFile](https://developer.qiniu.com/IM/api/8302/bmxgroup-
sharedfile)
群共享文件
[BMXGroup.Announcement](https://developer.qiniu.com/IM/api/8212/bmxgroup-
announcement)
群公告
[BMXGroup.Invitation](https://developer.qiniu.com/IM/api/8219/bmxgroup-
invitation)
群邀请
[BMXGroup.Application](https://developer.qiniu.com/IM/api/8213/bmxgroup-
application)
群申请
[BMXGroup.InvitationStatus](https://developer.qiniu.com/IM/api/8220/BMXGroup.InvitationStatus)
群邀请状态
[BMXGroup.ApplicationStatus](https://developer.qiniu.com/IM/api/8214/bmxgroup-
applicationstatus)
群申请状态
[BMXGroup.MsgPushMode](https://developer.qiniu.com/IM/api/8227/bmxgroup-
msgpushmode)
消息通知类型
[BMXGroup.ModifyMode](https://developer.qiniu.com/IM/api/8225/bmxgroup-
modifymode)
群信息修改模式
[BMXGroup.JoinAuthMode](https://developer.qiniu.com/IM/api/8222/bmxgroup-
joinauthmode)
进群验证方式
[BMXGroup.InviteMode](https://developer.qiniu.com/IM/api/8221/bmxgroup-
invitemode)
邀请入群模式
[BMXGroup.UpdateInfoType](https://developer.qiniu.com/IM/api/8229/bmxgroup-
updateinfotype)
群组信息更新类型
[BMXGroup.GroupStatus](https://developer.qiniu.com/IM/api/8217/bmxgroup--
groupstatus)
群组状态
[BMXGroup.MsgMuteMode](https://developer.qiniu.com/IM/api/8226/bmxgroup-
msgmutemode)
群组消息屏蔽模式
[BMXGroup.MemberRoleType](https://developer.qiniu.com/IM/api/8224/bmxgroup-
memberroletype)
群成员角色
[BMXGroup.GroupType](https://developer.qiniu.com/IM/api/8218/bmxgroup-
grouptype)
群类型
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice)
群组Service
[BMXGroupService.CreateGroupOptions](https://developer.qiniu.com/IM/api/8232/bmxgroupservice-
creategroupoptions)
创建群组选项
[BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
[BMXImageAttachment](https://developer.qiniu.com/IM/api/8236/bmximageattachment)
图片消息附件
[BMXLocationAttachment](https://developer.qiniu.com/IM/api/8237/bmxlocationattachment)
位置消息附件
[BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
日志级别
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
消息
[BMXMessage.DeliveryStatus](https://developer.qiniu.com/IM/api/8242/bmxmessage-
deliverystatus)
消息投递状态
[BMXMessage.MessageType](https://developer.qiniu.com/IM/api/8243/bmxmessage-
messagetype)
消息类型
[BMXMessage.ContentType](https://developer.qiniu.com/IM/api/8240/bmxmessage-
contenttype)
消息内容类型
[BMXMessage.DeliveryQos](https://developer.qiniu.com/IM/api/8241/bmxmessage-
deliveryqos)
消息投递质量
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
消息附件
[BMXMessageAttachment.Size](https://developer.qiniu.com/IM/api/8246/bmxmessageattachment-
size)
图片/视频大小
[BMXMessageAttachment.Type](https://developer.qiniu.com/IM/api/8247/bmxmessageattachment-
type)
附件类型
[BMXMessageAttachment.DownloadStatus](https://developer.qiniu.com/IM/api/8245/bmxmessageattachment-
downloadstatus)
附件下载状态
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
消息配置
[BMXMessageConfig.BadgeCountType](https://developer.qiniu.com/IM/api/8249/bmxmessageconfig-
badgecounttype)
[BMXNetworkListener](https://developer.qiniu.com/IM/api/8250/bmxnetworklistener)
网络监听者
[BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
网络类型
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
联系人
[BMXRosterItem.RosterRelation](https://developer.qiniu.com/IM/api/8276/bmxrosteritem-
rosterrelation)
好友关系
[BMXRosterItem.AddFriendAuthMode](https://developer.qiniu.com/IM/api/8275/bmxrosteritem-
addfriendauthmode)
roster 被申请加好友时的验证方式
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice)
好友Service
[BMXRosterService.Application](https://developer.qiniu.com/IM/api/8300/bmxrosterservice-
application)
好友邀请
[BMXRosterService.ApplicationStatus](https://developer.qiniu.com/IM/api/8301/bmxrosterservice-
applicationstatus)
请求状态
[BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
[BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
SDK设置管理
[BMXSDKConfig.HostConfig](https://developer.qiniu.com/IM/api/8285/bmxsdkconfig-
hostconfig)
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
登录状态
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户Profile
[BMXUserProfile.AuthQuestion](https://developer.qiniu.com/IM/api/8308/bmxuserprofile
--authquestion)
添加好友时的校验问题
[BMXUserProfile.MessageSetting](https://developer.qiniu.com/IM/api/8313/bmxuserprofile
--messagesetting)
用户消息设置
[BMXUserProfile.AddFriendAuthMode](https://developer.qiniu.com/IM/api/8306/bmxuserprofile
--addfriendauthmode)
对方申请加好友时的验证方式
[BMXUserProfile.UserCategory](https://developer.qiniu.com/IM/api/8311/bmxuserprofile
--usercategory)
用户类型
[BMXUserService](https://developer.qiniu.com/IM/api/8292/bmxuserservice)
用户Service
[BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
[BMXVideoAttachment](https://developer.qiniu.com/IM/api/8294/bmxvideoattachment)
视频消息附件
[BMXVoiceAttachment](https://developer.qiniu.com/IM/api/8297/bmxvoiceattachment)
音频消息附件
[BMXUserManager](https://developer.qiniu.com/IM/api/8287/bmxusermanager)
用户管理器
[BMXGroupManager](https://developer.qiniu.com/IM/api/8230/bmxgroupmanager)
群组管理器
[BMXRosterManager](https://developer.qiniu.com/IM/api/8277/bmxrostermanager)
好友管理器
[BMXChatManager](https://developer.qiniu.com/IM/api/8201/bmxchatmanager)
聊天管理器
[BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
[BMXPushManager](https://developer.qiniu.com/IM/api/8253/bmxpushmanager)
推送管理器
[BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice)
[BMXPushService.PushSdkStatus](https://developer.qiniu.com/IM/api/8315/bmxpushservice-
pushsdkstatus)
push sdk状态
[BMXPushService.PushDirection](https://developer.qiniu.com/IM/api/8268/bmxpushservice-
pushdirection)
本地推送消息搜索方向
[BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
[BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
[BMXPushUserProfile.MessagePushSetting](https://developer.qiniu.com/IM/api/8272/bmxpushuserprofile-
messagepushsetting)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,575 |
BMXChatService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatService
# BMXChatService
最近更新时间: 2022-07-22 22:44:26
class im.floo.floolib.BMXChatService
聊天Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* sendMessage
* resendMessage
* recallMessage
* forwardMessage
* forwardMessage
* ackMessage
* ackMessageDelivered
* ackPlayMessage
* readCancel
* readAllMessage
* removeMessage
* removeMessage
* downloadThumbnail
* downloadThumbnail
* downloadAttachment
* downloadAttachmentByUrl
* cancelUploadAttachment
* cancelDownloadAttachment
* transferingNum
* insertMessages
* getMessage
* deleteConversation
* deleteConversation
* openConversation
* openConversation
* attachmentDir
* attachmentDirForConversation
* getAllConversations
* getAllConversationsUnreadCount
* retrieveHistoryMessages
* searchMessagesByKeyWords
* searchMessagesByKeyWords
* searchMessages
* searchMessages
* getGroupAckMessageUserIdList
* getGroupAckMessageUnreadUserIdList
* getGroupPlayAckMessageUserIdList
* getGroupUnPlayAckMessageUserIdList
* addChatListener
* removeChatListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXChatService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
sendMessage
* public void sendMessage(BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发送的消息
Returns void
resendMessage
* public void resendMessage(BMXMessage msg);
* 重新发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
重新发送的消息
Returns void
recallMessage
* public void recallMessage(BMXMessage msg);
* 撤回消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回的消息
Returns void
forwardMessage
* public BMXErrorCode forwardMessage(BMXMessageList list, BMXConversation to, BMXMessage newMsg);
* 合并转发消息
Parameters
* list: BMXMessageList
转发的消息列表
* to: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
消息被转发到的会话
* newMsg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息列表合并后生成的新的单条转发消息
Returns BMXErrorCode
forwardMessage
* public void forwardMessage(BMXMessage msg);
* 简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息
Returns void
ackMessage
* public void ackMessage(BMXMessage msg);
* 发送已读回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送已读回执的消息
Returns void
ackMessageDelivered
* public void ackMessageDelivered(BMXMessage msg);
* 发送送达回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送送达回执的消息
Returns void
ackPlayMessage
* public void ackPlayMessage(BMXMessage msg);
* 发送已播放回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送已读回播放的消息
Returns void
readCancel
* public void readCancel(BMXMessage msg);
* 标记此消息为未读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送消息已读取消的消息
Returns void
readAllMessage
* public void readAllMessage(BMXMessage msg);
* 标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要标记为此消息以前全部消息为已读的消息
Returns void
removeMessage
* public void removeMessage(BMXMessage msg, boolean synchronize);
* 删除此消息，该消息同步到当前用户的其它设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要删除的消息
* synchronize: boolean
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Returns void
removeMessage
* public void removeMessage(BMXMessage msg);
* Returns void
downloadThumbnail
* public void downloadThumbnail(BMXMessage msg, BMXChatService.ThumbnailStrategy strategy);
* 下载缩略图，下载状态变化和进度通过listener通知 缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载缩略图的消息
* strategy: ThumbnailStrategy
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Returns void
downloadThumbnail
* public void downloadThumbnail(BMXMessage msg);
* Returns void
downloadAttachment
* public void downloadAttachment(BMXMessage msg);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
downloadAttachmentByUrl
* public void downloadAttachmentByUrl(long msgId, String url, String path);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msgId: long
需要下载附件的消息
* url: String
文件远程地址
* path: String
文件本地路径
Returns void
cancelUploadAttachment
* public void cancelUploadAttachment(BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要取消上传附件的消息
Returns void
cancelDownloadAttachment
* public void cancelDownloadAttachment(BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要取消上传附件的消息
Returns void
transferingNum
* public int transferingNum();
* 上传或下载中的文件数
Returns int
insertMessages
* public BMXErrorCode insertMessages(BMXMessageList list);
* 插入消息
Parameters
* list: BMXMessageList
插入消息列表
Returns BMXErrorCode
getMessage
* public BMXMessage getMessage(long msgId);
* 读取一条消息
Parameters
* msgId: long
需要获取消息的消息id
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
deleteConversation
* public void deleteConversation(long conversationId, boolean synchronize);
* 删除会话
Parameters
* conversationId: long
需要删除会话的会话id
* synchronize: boolean
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Returns void
deleteConversation
* public void deleteConversation(long conversationId);
* Returns void
openConversation
* public BMXConversation openConversation(long conversationId, BMXConversation.Type type, boolean createIfNotExist);
* 打开一个会话
Parameters
* conversationId: long
需要打开的会话的会话id
* type: Type
会话的类型，单聊还是群聊。
* createIfNotExist: boolean
会话不存在的情况下是否要创建本地会话，默认为创建
Returns [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-
conversation)
openConversation
* public BMXConversation openConversation(long conversationId, BMXConversation.Type type);
* Returns [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
attachmentDir
* public String attachmentDir();
* 获取附件保存路径
Returns String
attachmentDirForConversation
* public String attachmentDirForConversation(long conversationId);
* 获取会话的附件保存路径
Parameters
* conversationId: long
需要获取会话附件路径的会话id
Returns String
getAllConversations
* public BMXConversationList getAllConversations();
* 获取所有会话
Returns BMXConversationList
getAllConversationsUnreadCount
* public int getAllConversationsUnreadCount();
* 获取所有会话的全部未读数（标记为屏蔽的个人和群组的未读数不统计在内）
Returns int
retrieveHistoryMessages
* public BMXErrorCode retrieveHistoryMessages(BMXConversation conversation, long refMsgId, long size, BMXMessageList result);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
需要拉取历史消息的会话
* refMsgId: long
拉取会话消息的起始消息Id
* size: long
拉取的最大消息条数
* result: BMXMessageList
拉取操作获取的消息列表，外部初始化传入空列表。
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageListList result, BMXConversation.Direction arg4);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* result: BMXMessageListList
搜索到的消息结果列表，外部初始化传入空列表。
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageListList result);
* Returns BMXErrorCode
searchMessages
* public BMXErrorCode searchMessages(String keywords, long refTime, long size, BMXMessageListList result, BMXConversation.Direction arg4);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* result: BMXMessageListList
搜索到的消息结果列表，外部初始化传入空列表。
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessages
* public BMXErrorCode searchMessages(String keywords, long refTime, long size, BMXMessageListList result);
* Returns BMXErrorCode
getGroupAckMessageUserIdList
* public BMXErrorCode getGroupAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息已读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已读用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息已读的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupAckMessageUnreadUserIdList
* public BMXErrorCode getGroupAckMessageUnreadUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息未读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取未读用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息未读的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupPlayAckMessageUserIdList
* public BMXErrorCode getGroupPlayAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息已播放用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已播放用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息已播放的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupUnPlayAckMessageUserIdList
* public BMXErrorCode getGroupUnPlayAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息未播放用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取未播放用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息未播放的用户id列表，初始传入为空列表
Returns BMXErrorCode
addChatListener
* public void addChatListener(BMXChatServiceListener listener);
* 添加聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
removeChatListener
* public void removeChatListener(BMXChatServiceListener listener);
* 移除聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatService
# BMXChatService
最近更新时间: 2022-07-22 22:44:26
class im.floo.floolib.BMXChatService
聊天Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* sendMessage
* resendMessage
* recallMessage
* forwardMessage
* forwardMessage
* ackMessage
* ackMessageDelivered
* ackPlayMessage
* readCancel
* readAllMessage
* removeMessage
* removeMessage
* downloadThumbnail
* downloadThumbnail
* downloadAttachment
* downloadAttachmentByUrl
* cancelUploadAttachment
* cancelDownloadAttachment
* transferingNum
* insertMessages
* getMessage
* deleteConversation
* deleteConversation
* openConversation
* openConversation
* attachmentDir
* attachmentDirForConversation
* getAllConversations
* getAllConversationsUnreadCount
* retrieveHistoryMessages
* searchMessagesByKeyWords
* searchMessagesByKeyWords
* searchMessages
* searchMessages
* getGroupAckMessageUserIdList
* getGroupAckMessageUnreadUserIdList
* getGroupPlayAckMessageUserIdList
* getGroupUnPlayAckMessageUserIdList
* addChatListener
* removeChatListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXChatService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
sendMessage
* public void sendMessage(BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发送的消息
Returns void
resendMessage
* public void resendMessage(BMXMessage msg);
* 重新发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
重新发送的消息
Returns void
recallMessage
* public void recallMessage(BMXMessage msg);
* 撤回消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回的消息
Returns void
forwardMessage
* public BMXErrorCode forwardMessage(BMXMessageList list, BMXConversation to, BMXMessage newMsg);
* 合并转发消息
Parameters
* list: BMXMessageList
转发的消息列表
* to: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
消息被转发到的会话
* newMsg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息列表合并后生成的新的单条转发消息
Returns BMXErrorCode
forwardMessage
* public void forwardMessage(BMXMessage msg);
* 简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息
Returns void
ackMessage
* public void ackMessage(BMXMessage msg);
* 发送已读回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送已读回执的消息
Returns void
ackMessageDelivered
* public void ackMessageDelivered(BMXMessage msg);
* 发送送达回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送送达回执的消息
Returns void
ackPlayMessage
* public void ackPlayMessage(BMXMessage msg);
* 发送已播放回执
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送已读回播放的消息
Returns void
readCancel
* public void readCancel(BMXMessage msg);
* 标记此消息为未读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要发送消息已读取消的消息
Returns void
readAllMessage
* public void readAllMessage(BMXMessage msg);
* 标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要标记为此消息以前全部消息为已读的消息
Returns void
removeMessage
* public void removeMessage(BMXMessage msg, boolean synchronize);
* 删除此消息，该消息同步到当前用户的其它设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要删除的消息
* synchronize: boolean
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Returns void
removeMessage
* public void removeMessage(BMXMessage msg);
* Returns void
downloadThumbnail
* public void downloadThumbnail(BMXMessage msg, BMXChatService.ThumbnailStrategy strategy);
* 下载缩略图，下载状态变化和进度通过listener通知 缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载缩略图的消息
* strategy: ThumbnailStrategy
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Returns void
downloadThumbnail
* public void downloadThumbnail(BMXMessage msg);
* Returns void
downloadAttachment
* public void downloadAttachment(BMXMessage msg);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
downloadAttachmentByUrl
* public void downloadAttachmentByUrl(long msgId, String url, String path);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msgId: long
需要下载附件的消息
* url: String
文件远程地址
* path: String
文件本地路径
Returns void
cancelUploadAttachment
* public void cancelUploadAttachment(BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要取消上传附件的消息
Returns void
cancelDownloadAttachment
* public void cancelDownloadAttachment(BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要取消上传附件的消息
Returns void
transferingNum
* public int transferingNum();
* 上传或下载中的文件数
Returns int
insertMessages
* public BMXErrorCode insertMessages(BMXMessageList list);
* 插入消息
Parameters
* list: BMXMessageList
插入消息列表
Returns BMXErrorCode
getMessage
* public BMXMessage getMessage(long msgId);
* 读取一条消息
Parameters
* msgId: long
需要获取消息的消息id
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
deleteConversation
* public void deleteConversation(long conversationId, boolean synchronize);
* 删除会话
Parameters
* conversationId: long
需要删除会话的会话id
* synchronize: boolean
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Returns void
deleteConversation
* public void deleteConversation(long conversationId);
* Returns void
openConversation
* public BMXConversation openConversation(long conversationId, BMXConversation.Type type, boolean createIfNotExist);
* 打开一个会话
Parameters
* conversationId: long
需要打开的会话的会话id
* type: Type
会话的类型，单聊还是群聊。
* createIfNotExist: boolean
会话不存在的情况下是否要创建本地会话，默认为创建
Returns [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-
conversation)
openConversation
* public BMXConversation openConversation(long conversationId, BMXConversation.Type type);
* Returns [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
attachmentDir
* public String attachmentDir();
* 获取附件保存路径
Returns String
attachmentDirForConversation
* public String attachmentDirForConversation(long conversationId);
* 获取会话的附件保存路径
Parameters
* conversationId: long
需要获取会话附件路径的会话id
Returns String
getAllConversations
* public BMXConversationList getAllConversations();
* 获取所有会话
Returns BMXConversationList
getAllConversationsUnreadCount
* public int getAllConversationsUnreadCount();
* 获取所有会话的全部未读数（标记为屏蔽的个人和群组的未读数不统计在内）
Returns int
retrieveHistoryMessages
* public BMXErrorCode retrieveHistoryMessages(BMXConversation conversation, long refMsgId, long size, BMXMessageList result);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
需要拉取历史消息的会话
* refMsgId: long
拉取会话消息的起始消息Id
* size: long
拉取的最大消息条数
* result: BMXMessageList
拉取操作获取的消息列表，外部初始化传入空列表。
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageListList result, BMXConversation.Direction arg4);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* result: BMXMessageListList
搜索到的消息结果列表，外部初始化传入空列表。
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageListList result);
* Returns BMXErrorCode
searchMessages
* public BMXErrorCode searchMessages(String keywords, long refTime, long size, BMXMessageListList result, BMXConversation.Direction arg4);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* result: BMXMessageListList
搜索到的消息结果列表，外部初始化传入空列表。
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessages
* public BMXErrorCode searchMessages(String keywords, long refTime, long size, BMXMessageListList result);
* Returns BMXErrorCode
getGroupAckMessageUserIdList
* public BMXErrorCode getGroupAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息已读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已读用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息已读的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupAckMessageUnreadUserIdList
* public BMXErrorCode getGroupAckMessageUnreadUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息未读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取未读用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息未读的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupPlayAckMessageUserIdList
* public BMXErrorCode getGroupPlayAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息已播放用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已播放用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息已播放的用户id列表，初始传入为空列表
Returns BMXErrorCode
getGroupUnPlayAckMessageUserIdList
* public BMXErrorCode getGroupUnPlayAckMessageUserIdList(BMXMessage msg, ListOfLongLong groupMemberIdList);
* 获取发送的群组消息未播放用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取未播放用户id列表的消息
* groupMemberIdList: ListOfLongLong
对该条消息未播放的用户id列表，初始传入为空列表
Returns BMXErrorCode
addChatListener
* public void addChatListener(BMXChatServiceListener listener);
* 添加聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
removeChatListener
* public void removeChatListener(BMXChatServiceListener listener);
* 移除聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,584 |
BMXChatService.ThumbnailStrategy | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice) >
BMXChatService.ThumbnailStrategy
# BMXChatService.ThumbnailStrategy
最近更新时间: 2022-07-22 22:36:11
class im.floo.floolib.BMXChatService.ThumbnailStrategy
缩略图生成策略,
Index
字段
* ThirdpartyServerCreate
* LocalServerCreate
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
ThirdpartyServerCreate
* public static final ThumbnailStrategy ThirdpartyServerCreate
*
LocalServerCreate
* public static final ThumbnailStrategy LocalServerCreate
*
方法
values
* public static im.floo.floolib.BMXChatService.ThumbnailStrategy[] values();
* Returns ThumbnailStrategy
valueOf
* public static im.floo.floolib.BMXChatService.ThumbnailStrategy valueOf(java.lang.String name);
* Returns ThumbnailStrategy
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ThumbnailStrategy swigToEnum(int swigValue);
* Returns ThumbnailStrategy
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice) >
BMXChatService.ThumbnailStrategy
# BMXChatService.ThumbnailStrategy
最近更新时间: 2022-07-22 22:36:11
class im.floo.floolib.BMXChatService.ThumbnailStrategy
缩略图生成策略,
Index
字段
* ThirdpartyServerCreate
* LocalServerCreate
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
ThirdpartyServerCreate
* public static final ThumbnailStrategy ThirdpartyServerCreate
*
LocalServerCreate
* public static final ThumbnailStrategy LocalServerCreate
*
方法
values
* public static im.floo.floolib.BMXChatService.ThumbnailStrategy[] values();
* Returns ThumbnailStrategy
valueOf
* public static im.floo.floolib.BMXChatService.ThumbnailStrategy valueOf(java.lang.String name);
* Returns ThumbnailStrategy
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ThumbnailStrategy swigToEnum(int swigValue);
* Returns ThumbnailStrategy
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,601 |
BMXChatServiceListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatServiceListener
# BMXChatServiceListener
最近更新时间: 2022-07-22 22:59:05
class im.floo.floolib.BMXChatServiceListener
聊天监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onStatusChanged
* onAttachmentUploadProgressChanged
* onRecallStatusChanged
* onReceive
* onReceiveCommandMessages
* onReceiveSystemMessages
* onReceiveReadAcks
* onReceiveDeliverAcks
* onReceiveRecallMessages
* onReceiveReadCancels
* onReceiveReadAllMessages
* onReceiveDeleteMessages
* onReceivePlayAcks
* onAttachmentStatusChanged
* onAttachmentDownloadByUrlStatusChanged
* onRetrieveHistoryMessages
* onLoadAllConversation
* onConversationCreate
* onConversationDelete
* onTotalUnreadCountChanged
* registerChatService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXChatServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onStatusChanged
* public void onStatusChanged(BMXMessage msg, BMXErrorCode error);
* 消息发送状态发生变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生状态变化的消息
* error: BMXErrorCode
状态错误码
Returns void
onAttachmentUploadProgressChanged
* public void onAttachmentUploadProgressChanged(BMXMessage msg, int percent);
* 附件上传进度发送变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
上传附件的消息
* percent: int
附件上传的进度
Returns void
onRecallStatusChanged
* public void onRecallStatusChanged(BMXMessage msg, BMXErrorCode error);
* 消息撤回状态发送变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回状态发生变化的消息
* error: BMXErrorCode
状态错误码
Returns void
onReceive
* public void onReceive(BMXMessageList list);
* 收到消息
Parameters
* list: BMXMessageList
接收到的消息列表
Returns void
onReceiveCommandMessages
* public void onReceiveCommandMessages(BMXMessageList list);
* 收到命令消息
Parameters
* list: BMXMessageList
接收到的消息列表
Returns void
onReceiveSystemMessages
* public void onReceiveSystemMessages(BMXMessageList list);
* 收到系统通知消息
Parameters
* list: BMXMessageList
接收到的系统消息列表
Returns void
onReceiveReadAcks
* public void onReceiveReadAcks(BMXMessageList list);
* 收到消息已读回执
Parameters
* list: BMXMessageList
接收到的已读回执消息列表
Returns void
onReceiveDeliverAcks
* public void onReceiveDeliverAcks(BMXMessageList list);
* 收到消息已送达回执
Parameters
* list: BMXMessageList
接收到的已送达回执消息列表
Returns void
onReceiveRecallMessages
* public void onReceiveRecallMessages(BMXMessageList list);
* 收到撤回消息
Parameters
* list: BMXMessageList
接收到的撤回消息列表
Returns void
onReceiveReadCancels
* public void onReceiveReadCancels(BMXMessageList list);
* 收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
Parameters
* list: BMXMessageList
接收到的消息已读取消消息列表
Returns void
onReceiveReadAllMessages
* public void onReceiveReadAllMessages(BMXMessageList list);
* 收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
Parameters
* list: BMXMessageList
接收到的消息全部已读消息列表
Returns void
onReceiveDeleteMessages
* public void onReceiveDeleteMessages(BMXMessageList list);
* 收到删除消息 （多设备同步删除消息）
Parameters
* list: BMXMessageList
接收到的删除消息列表
Returns void
onReceivePlayAcks
* public void onReceivePlayAcks(BMXMessageList list);
* 收到消息已播放回执
Parameters
* list: BMXMessageList
接收到的已读回执消息列表
Returns void
onAttachmentStatusChanged
* public void onAttachmentStatusChanged(BMXMessage msg, BMXErrorCode error, int percent);
* 附件下载状态发生变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生下载状态变化的消息
* error: BMXErrorCode
状态错误码
* percent: int
附件下载的进度
Returns void
onAttachmentDownloadByUrlStatusChanged
* public void onAttachmentDownloadByUrlStatusChanged(long msgId, BMXErrorCode error, int percent);
* 附件下载状态发生变化
Parameters
* msgId: long
发生下载状态变化的消息ID
* error: BMXErrorCode
状态错误码
* percent: int
附件下载的进度
Returns void
onRetrieveHistoryMessages
* public void onRetrieveHistoryMessages(BMXConversation conversation);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
发生了拉取指历史消息的会话
Returns void
onLoadAllConversation
* public void onLoadAllConversation();
* 已经加载完未读会话列表
Returns void
onConversationCreate
* public void onConversationCreate(BMXConversation conversation, BMXMessage msg);
* 本地创建新会话
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
新创建的本地会话
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
会话的最新消息，存在返回不存在返回为空
Returns void
onConversationDelete
* public void onConversationDelete(long conversationId, BMXErrorCode error);
* 删除会话
Parameters
* conversationId: long
删除的本地会话id
* error: BMXErrorCode
状态错误码
Returns void
onTotalUnreadCountChanged
* public void onTotalUnreadCountChanged(int unreadCount);
* 更新总未读数
Parameters
* unreadCount: int
本地全部会话未读总数
Returns void
registerChatService
* public void registerChatService(BMXChatService service);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatServiceListener
# BMXChatServiceListener
最近更新时间: 2022-07-22 22:59:05
class im.floo.floolib.BMXChatServiceListener
聊天监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onStatusChanged
* onAttachmentUploadProgressChanged
* onRecallStatusChanged
* onReceive
* onReceiveCommandMessages
* onReceiveSystemMessages
* onReceiveReadAcks
* onReceiveDeliverAcks
* onReceiveRecallMessages
* onReceiveReadCancels
* onReceiveReadAllMessages
* onReceiveDeleteMessages
* onReceivePlayAcks
* onAttachmentStatusChanged
* onAttachmentDownloadByUrlStatusChanged
* onRetrieveHistoryMessages
* onLoadAllConversation
* onConversationCreate
* onConversationDelete
* onTotalUnreadCountChanged
* registerChatService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXChatServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onStatusChanged
* public void onStatusChanged(BMXMessage msg, BMXErrorCode error);
* 消息发送状态发生变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生状态变化的消息
* error: BMXErrorCode
状态错误码
Returns void
onAttachmentUploadProgressChanged
* public void onAttachmentUploadProgressChanged(BMXMessage msg, int percent);
* 附件上传进度发送变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
上传附件的消息
* percent: int
附件上传的进度
Returns void
onRecallStatusChanged
* public void onRecallStatusChanged(BMXMessage msg, BMXErrorCode error);
* 消息撤回状态发送变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回状态发生变化的消息
* error: BMXErrorCode
状态错误码
Returns void
onReceive
* public void onReceive(BMXMessageList list);
* 收到消息
Parameters
* list: BMXMessageList
接收到的消息列表
Returns void
onReceiveCommandMessages
* public void onReceiveCommandMessages(BMXMessageList list);
* 收到命令消息
Parameters
* list: BMXMessageList
接收到的消息列表
Returns void
onReceiveSystemMessages
* public void onReceiveSystemMessages(BMXMessageList list);
* 收到系统通知消息
Parameters
* list: BMXMessageList
接收到的系统消息列表
Returns void
onReceiveReadAcks
* public void onReceiveReadAcks(BMXMessageList list);
* 收到消息已读回执
Parameters
* list: BMXMessageList
接收到的已读回执消息列表
Returns void
onReceiveDeliverAcks
* public void onReceiveDeliverAcks(BMXMessageList list);
* 收到消息已送达回执
Parameters
* list: BMXMessageList
接收到的已送达回执消息列表
Returns void
onReceiveRecallMessages
* public void onReceiveRecallMessages(BMXMessageList list);
* 收到撤回消息
Parameters
* list: BMXMessageList
接收到的撤回消息列表
Returns void
onReceiveReadCancels
* public void onReceiveReadCancels(BMXMessageList list);
* 收到消息已读取消（多设备其他设备同步消息已读状态变为未读）
Parameters
* list: BMXMessageList
接收到的消息已读取消消息列表
Returns void
onReceiveReadAllMessages
* public void onReceiveReadAllMessages(BMXMessageList list);
* 收到消息全部已读（多设备同步某消息之前消息全部设置为已读）
Parameters
* list: BMXMessageList
接收到的消息全部已读消息列表
Returns void
onReceiveDeleteMessages
* public void onReceiveDeleteMessages(BMXMessageList list);
* 收到删除消息 （多设备同步删除消息）
Parameters
* list: BMXMessageList
接收到的删除消息列表
Returns void
onReceivePlayAcks
* public void onReceivePlayAcks(BMXMessageList list);
* 收到消息已播放回执
Parameters
* list: BMXMessageList
接收到的已读回执消息列表
Returns void
onAttachmentStatusChanged
* public void onAttachmentStatusChanged(BMXMessage msg, BMXErrorCode error, int percent);
* 附件下载状态发生变化
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生下载状态变化的消息
* error: BMXErrorCode
状态错误码
* percent: int
附件下载的进度
Returns void
onAttachmentDownloadByUrlStatusChanged
* public void onAttachmentDownloadByUrlStatusChanged(long msgId, BMXErrorCode error, int percent);
* 附件下载状态发生变化
Parameters
* msgId: long
发生下载状态变化的消息ID
* error: BMXErrorCode
状态错误码
* percent: int
附件下载的进度
Returns void
onRetrieveHistoryMessages
* public void onRetrieveHistoryMessages(BMXConversation conversation);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
发生了拉取指历史消息的会话
Returns void
onLoadAllConversation
* public void onLoadAllConversation();
* 已经加载完未读会话列表
Returns void
onConversationCreate
* public void onConversationCreate(BMXConversation conversation, BMXMessage msg);
* 本地创建新会话
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
新创建的本地会话
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
会话的最新消息，存在返回不存在返回为空
Returns void
onConversationDelete
* public void onConversationDelete(long conversationId, BMXErrorCode error);
* 删除会话
Parameters
* conversationId: long
删除的本地会话id
* error: BMXErrorCode
状态错误码
Returns void
onTotalUnreadCountChanged
* public void onTotalUnreadCountChanged(int unreadCount);
* 更新总未读数
Parameters
* unreadCount: int
本地全部会话未读总数
Returns void
registerChatService
* public void registerChatService(BMXChatService service);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,603 |
BMXClientType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXClientType
# BMXClientType
最近更新时间: 2022-07-26 14:11:34
class im.floo.floolib.BMXClientType
客户端类型
Index
字段
* Unknown
* iOS
* Android
* Windows
* macOS
* Linux
* Web
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Unknown
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Unknown
*
iOS
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) iOS
*
Android
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Android
*
Windows
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Windows
*
macOS
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) macOS
*
Linux
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Linux
*
Web
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Web
*
方法
values
* public static im.floo.floolib.BMXClientType[] values();
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
valueOf
* public static im.floo.floolib.BMXClientType valueOf(java.lang.String name);
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXClientType swigToEnum(int swigValue);
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXClientType
# BMXClientType
最近更新时间: 2022-07-26 14:11:34
class im.floo.floolib.BMXClientType
客户端类型
Index
字段
* Unknown
* iOS
* Android
* Windows
* macOS
* Linux
* Web
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Unknown
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Unknown
*
iOS
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) iOS
*
Android
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Android
*
Windows
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Windows
*
macOS
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) macOS
*
Linux
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Linux
*
Web
* public static final [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype) Web
*
方法
values
* public static im.floo.floolib.BMXClientType[] values();
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
valueOf
* public static im.floo.floolib.BMXClientType valueOf(java.lang.String name);
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXClientType swigToEnum(int swigValue);
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,613 |
BXMChatRoomManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomManager
# BXMChatRoomManager
最近更新时间: 2022-07-22 22:41:49
## 类 BXMChatRoomManager
* java.lang.Object
* * com.qiniu.droid.imsdk.BXMChatRoomManager
* * * *
public class BXMChatRoomManager
extends java.lang.Object
聊天室
* * ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BXMChatRoomManager(im.floo.floolib.BMXGroupManager groupManager)`
* ### 方法概要
所有方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`void` | `create(java.lang.String name, im.floo.BMXDataCallBack<im.floo.floolib.BMXGroup> callBack)` 创建聊天室
`void` | `removeGroupListener(BMXGroupServiceListener listener)` 移除群组变化监听者
`void` | `addGroupListener(BMXGroupServiceListener listener)` 添加群组变化监听者
`void` | `destroy(long groupId, im.floo.BMXCallBack callBack)` 销毁聊天室
`void` | `getMembers(long groupId, boolean forceUpdate, im.floo.BMXDataCallBack<im.floo.floolib.BMXGroupMemberList> callBack)` 获取群成员
`void` | `join(long groupId, im.floo.BMXCallBack callBack)` 加入聊天室
`void` | `leave(long groupId, im.floo.BMXCallBack callBack)` 退出聊天室
* ### 从类继承的方法 java.lang.Object ###
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BXMChatRoomManager
protected BXMChatRoomManager(im.floo.floolib.BMXGroupManager groupManager)
* ### 方法详细资料
* #### create
public void create(java.lang.String name,
im.floo.BMXDataCallBack<im.floo.floolib.BMXGroup> callBack)
创建聊天室
参数:
`name` \- 聊天室名字
`callBack` \- 回调
* #### join
public void join(long groupId,
im.floo.BMXCallBack callBack)
加入聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### leave
public void leave(long groupId,
im.floo.BMXCallBack callBack)
退出聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### destroy
public void destroy(long groupId,
im.floo.BMXCallBack callBack)
销毁聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### getMembers
public void getMembers(long groupId,
boolean forceUpdate,
im.floo.BMXDataCallBack<im.floo.floolib.BMXGroupMemberList> callBack)
获取群成员
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### addGroupListener
public void addGroupListener(BMXGroupServiceListener listener)
添加群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### removeGroupListener
public void removeGroupListener(BMXGroupServiceListener listener)
移除群组变化监听者
参数:
`listener` \- 群组变化监听者
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomManager
# BXMChatRoomManager
最近更新时间: 2022-07-22 22:41:49
## 类 BXMChatRoomManager
* java.lang.Object
* * com.qiniu.droid.imsdk.BXMChatRoomManager
* * * *
public class BXMChatRoomManager
extends java.lang.Object
聊天室
* * ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BXMChatRoomManager(im.floo.floolib.BMXGroupManager groupManager)`
* ### 方法概要
所有方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`void` | `create(java.lang.String name, im.floo.BMXDataCallBack<im.floo.floolib.BMXGroup> callBack)` 创建聊天室
`void` | `removeGroupListener(BMXGroupServiceListener listener)` 移除群组变化监听者
`void` | `addGroupListener(BMXGroupServiceListener listener)` 添加群组变化监听者
`void` | `destroy(long groupId, im.floo.BMXCallBack callBack)` 销毁聊天室
`void` | `getMembers(long groupId, boolean forceUpdate, im.floo.BMXDataCallBack<im.floo.floolib.BMXGroupMemberList> callBack)` 获取群成员
`void` | `join(long groupId, im.floo.BMXCallBack callBack)` 加入聊天室
`void` | `leave(long groupId, im.floo.BMXCallBack callBack)` 退出聊天室
* ### 从类继承的方法 java.lang.Object ###
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BXMChatRoomManager
protected BXMChatRoomManager(im.floo.floolib.BMXGroupManager groupManager)
* ### 方法详细资料
* #### create
public void create(java.lang.String name,
im.floo.BMXDataCallBack<im.floo.floolib.BMXGroup> callBack)
创建聊天室
参数:
`name` \- 聊天室名字
`callBack` \- 回调
* #### join
public void join(long groupId,
im.floo.BMXCallBack callBack)
加入聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### leave
public void leave(long groupId,
im.floo.BMXCallBack callBack)
退出聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### destroy
public void destroy(long groupId,
im.floo.BMXCallBack callBack)
销毁聊天室
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### getMembers
public void getMembers(long groupId,
boolean forceUpdate,
im.floo.BMXDataCallBack<im.floo.floolib.BMXGroupMemberList> callBack)
获取群成员
参数:
`groupId` \- 群ID
`callBack` \- 回调
* #### addGroupListener
public void addGroupListener(BMXGroupServiceListener listener)
添加群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### removeGroupListener
public void removeGroupListener(BMXGroupServiceListener listener)
移除群组变化监听者
参数:
`listener` \- 群组变化监听者
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,615 |
BXMChatRoomService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomService
# BXMChatRoomService
最近更新时间: 2022-07-22 22:43:02
class com.qiniu.droid.imsdk.BXMChatRoomService
聊天室
Index
方法
* create
* join
* leave
* destroy
* getMembers
* getMembers
* addGroupListener
* removeGroupListener
方法
create
* public BMXErrorCode create(String name, BMXGroup group);
* 创建聊天室
Parameters
* name: String
聊天室名字
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
空的群对象容器
Returns BMXErrorCode
join
* public BMXErrorCode join(long groupId);
* 加入聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
leave
* public BMXErrorCode leave(long groupId);
* 退出聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
destroy
* public BMXErrorCode destroy(long groupId);
* 销毁聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(long groupId, BMXGroupMemberList list, boolean forceRefresh);
* 获取群成员
Parameters
* groupId: long
群ID
* list: BMXGroupMemberList
数据结果
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(long groupId, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 获取群成员
Parameters
* groupId: long
群ID
* result: BMXGroupMemberResultPage
分页获取的群成员列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群监听
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomService
# BXMChatRoomService
最近更新时间: 2022-07-22 22:43:02
class com.qiniu.droid.imsdk.BXMChatRoomService
聊天室
Index
方法
* create
* join
* leave
* destroy
* getMembers
* getMembers
* addGroupListener
* removeGroupListener
方法
create
* public BMXErrorCode create(String name, BMXGroup group);
* 创建聊天室
Parameters
* name: String
聊天室名字
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
空的群对象容器
Returns BMXErrorCode
join
* public BMXErrorCode join(long groupId);
* 加入聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
leave
* public BMXErrorCode leave(long groupId);
* 退出聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
destroy
* public BMXErrorCode destroy(long groupId);
* 销毁聊天室
Parameters
* groupId: long
群ID
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(long groupId, BMXGroupMemberList list, boolean forceRefresh);
* 获取群成员
Parameters
* groupId: long
群ID
* list: BMXGroupMemberList
数据结果
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(long groupId, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 获取群成员
Parameters
* groupId: long
群ID
* result: BMXGroupMemberResultPage
分页获取的群成员列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群监听
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,619 |
BMXChatManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatManager
# BMXChatManager
最近更新时间: 2022-07-22 22:43:10
class im.floo.floolib.BMXChatManager
聊天管理器
Index
方法
* sendMessage
* resendMessage
* recallMessage
* forwardMessage
* forwardMessage
* readAllMessage
* removeMessage
* removeMessage
* ackMessage
* readCancel
* downloadThumbnail
* downloadAttachment
* cancelDownloadAttachment
* cancelUploadAttachment
* transferingNum
* insertMessages
* getMessage
* deleteConversation
* openConversation
* getAllConversations
* getAllConversationsUnreadCount
* retrieveHistoryMessages
* searchMessages
* searchMessages
* getGroupAckMessageUserIdList
* addChatListener
* removeChatListener
方法
sendMessage
* public void sendMessage(final BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发送的消息
Returns void
resendMessage
* public void resendMessage(final BMXMessage msg);
* 重新发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
重新发送的消息
Returns void
recallMessage
* public void recallMessage(final BMXMessage msg);
* 撤回消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回的消息
Returns void
forwardMessage
* public void forwardMessage(final BMXMessageList list, final BMXConversation to, final BMXMessage newMsg, final BMXCallBack callBack);
* 合并转发消息
Parameters
* list: BMXMessageList
转发的消息列表
* to: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
消息被转发到的会话
* newMsg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息列表合并后生成的新的单条转发消息
* callBack: BMXCallBack
BMXErrorCode
Returns void
forwardMessage
* public void forwardMessage(final BMXMessage msg);
* 简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息
Returns void
readAllMessage
* public void readAllMessage(final BMXMessage msg);
* 标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要标记为此消息以前全部消息为已读的消息
Returns void
removeMessage
* public void removeMessage(final BMXMessage msg, final boolean synchronize);
* 删除此消息，该消息同步到当前用户的其它设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要删除的消息
* synchronize: boolean
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Returns void
removeMessage
* public void removeMessage(final BMXMessage msg);
* Returns void
ackMessage
* public void ackMessage(final BMXMessage msg);
* 发送已读回执
Returns void
readCancel
* public void readCancel(final BMXMessage msg);
* 设置未读
Returns void
downloadThumbnail
* public void downloadThumbnail(final BMXMessage msg);
* 下载缩略图，下载状态变化和进度通过listener通知 缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载缩略图的消息
Returns void
downloadAttachment
* public void downloadAttachment(final BMXMessage msg);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
cancelDownloadAttachment
* public void cancelDownloadAttachment(final BMXMessage msg);
* 取消下载附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
cancelUploadAttachment
* public void cancelUploadAttachment(final BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要上传附件的消息
Returns void
transferingNum
* public int transferingNum();
* 正在上传或下载中的文件数
Returns int
insertMessages
* public void insertMessages(final BMXMessageList list, final BMXCallBack callBack);
* 插入消息
Parameters
* list: BMXMessageList
插入消息列表
* callBack: BMXCallBack
BMXErrorCode
Returns void
getMessage
* public void getMessage(final long msgId, final BMXDataCallBack<BMXMessage> callBack);
* 读取一条消息
Parameters
* msgId: long
需要获取消息的消息id
* callBack: <any>
BMXMessage
Returns void
deleteConversation
* public void deleteConversation(final long conversationId, final Boolean sync);
* 删除会话
Parameters
* conversationId: long
需要删除会话的会话id
* sync: Boolean
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Returns void
openConversation
* public void openConversation(final long conversationId, final BMXConversation.Type type, final boolean createIfNotExist, final BMXDataCallBack<BMXConversation> callBack);
* 打开一个会话
Parameters
* conversationId: long
需要打开的会话的会话id
* type: Type
会话的类型，单聊还是群聊。
* createIfNotExist: boolean
会话不存在的情况下是否要创建本地会话，默认为创建
* callBack: <any>
BMXConversation
Returns void
getAllConversations
* public void getAllConversations(final BMXDataCallBack<BMXConversationList> callBack);
* 获取所有会话
Parameters
* callBack: <any>
BMXConversationList
Returns void
getAllConversationsUnreadCount
* public void getAllConversationsUnreadCount(final BMXDataCallBack<Integer> callBack);
* 获取所有会话的全部未读数（标记为屏蔽的个人和群组的未读数不统计在内）
Parameters
* callBack: <any>
未读数
Returns void
retrieveHistoryMessages
* public void retrieveHistoryMessages(final BMXConversation conversation, final long refMsgId, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
需要拉取历史消息的会话
* refMsgId: long
拉取会话消息的起始消息Id
* size: long
拉取的最大消息条数
* callBack: <any>
BMXErrorCode，拉取操作获取的消息列表
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageListList> callBack);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
BMXErrorCode，搜索到的消息结果列表
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXDataCallBack<BMXMessageListList> callBack);
* Returns void
getGroupAckMessageUserIdList
* public void getGroupAckMessageUserIdList(final BMXMessage msg, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取发送的群组消息已读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已读用户id列表的消息
* callBack: <any>
BMXErrorCode,对该条消息已读的用户id列表
Returns void
addChatListener
* public void addChatListener(BMXChatServiceListener listener);
* 添加聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
removeChatListener
* public void removeChatListener(BMXChatServiceListener listener);
* 移除聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXChatManager
# BMXChatManager
最近更新时间: 2022-07-22 22:43:10
class im.floo.floolib.BMXChatManager
聊天管理器
Index
方法
* sendMessage
* resendMessage
* recallMessage
* forwardMessage
* forwardMessage
* readAllMessage
* removeMessage
* removeMessage
* ackMessage
* readCancel
* downloadThumbnail
* downloadAttachment
* cancelDownloadAttachment
* cancelUploadAttachment
* transferingNum
* insertMessages
* getMessage
* deleteConversation
* openConversation
* getAllConversations
* getAllConversationsUnreadCount
* retrieveHistoryMessages
* searchMessages
* searchMessages
* getGroupAckMessageUserIdList
* addChatListener
* removeChatListener
方法
sendMessage
* public void sendMessage(final BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发送的消息
Returns void
resendMessage
* public void resendMessage(final BMXMessage msg);
* 重新发送消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
重新发送的消息
Returns void
recallMessage
* public void recallMessage(final BMXMessage msg);
* 撤回消息，消息状态变化会通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
撤回的消息
Returns void
forwardMessage
* public void forwardMessage(final BMXMessageList list, final BMXConversation to, final BMXMessage newMsg, final BMXCallBack callBack);
* 合并转发消息
Parameters
* list: BMXMessageList
转发的消息列表
* to: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
消息被转发到的会话
* newMsg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息列表合并后生成的新的单条转发消息
* callBack: BMXCallBack
BMXErrorCode
Returns void
forwardMessage
* public void forwardMessage(final BMXMessage msg);
* 简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
转发的消息
Returns void
readAllMessage
* public void readAllMessage(final BMXMessage msg);
* 标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要标记为此消息以前全部消息为已读的消息
Returns void
removeMessage
* public void removeMessage(final BMXMessage msg, final boolean synchronize);
* 删除此消息，该消息同步到当前用户的其它设备
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要删除的消息
* synchronize: boolean
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Returns void
removeMessage
* public void removeMessage(final BMXMessage msg);
* Returns void
ackMessage
* public void ackMessage(final BMXMessage msg);
* 发送已读回执
Returns void
readCancel
* public void readCancel(final BMXMessage msg);
* 设置未读
Returns void
downloadThumbnail
* public void downloadThumbnail(final BMXMessage msg);
* 下载缩略图，下载状态变化和进度通过listener通知 缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载缩略图的消息
Returns void
downloadAttachment
* public void downloadAttachment(final BMXMessage msg);
* 下载附件，下载状态变化和进度通过listener通知
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
cancelDownloadAttachment
* public void cancelDownloadAttachment(final BMXMessage msg);
* 取消下载附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要下载附件的消息
Returns void
cancelUploadAttachment
* public void cancelUploadAttachment(final BMXMessage msg);
* 取消上传附件
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要上传附件的消息
Returns void
transferingNum
* public int transferingNum();
* 正在上传或下载中的文件数
Returns int
insertMessages
* public void insertMessages(final BMXMessageList list, final BMXCallBack callBack);
* 插入消息
Parameters
* list: BMXMessageList
插入消息列表
* callBack: BMXCallBack
BMXErrorCode
Returns void
getMessage
* public void getMessage(final long msgId, final BMXDataCallBack<BMXMessage> callBack);
* 读取一条消息
Parameters
* msgId: long
需要获取消息的消息id
* callBack: <any>
BMXMessage
Returns void
deleteConversation
* public void deleteConversation(final long conversationId, final Boolean sync);
* 删除会话
Parameters
* conversationId: long
需要删除会话的会话id
* sync: Boolean
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Returns void
openConversation
* public void openConversation(final long conversationId, final BMXConversation.Type type, final boolean createIfNotExist, final BMXDataCallBack<BMXConversation> callBack);
* 打开一个会话
Parameters
* conversationId: long
需要打开的会话的会话id
* type: Type
会话的类型，单聊还是群聊。
* createIfNotExist: boolean
会话不存在的情况下是否要创建本地会话，默认为创建
* callBack: <any>
BMXConversation
Returns void
getAllConversations
* public void getAllConversations(final BMXDataCallBack<BMXConversationList> callBack);
* 获取所有会话
Parameters
* callBack: <any>
BMXConversationList
Returns void
getAllConversationsUnreadCount
* public void getAllConversationsUnreadCount(final BMXDataCallBack<Integer> callBack);
* 获取所有会话的全部未读数（标记为屏蔽的个人和群组的未读数不统计在内）
Parameters
* callBack: <any>
未读数
Returns void
retrieveHistoryMessages
* public void retrieveHistoryMessages(final BMXConversation conversation, final long refMsgId, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* 拉取历史消息
Parameters
* conversation: [BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation)
需要拉取历史消息的会话
* refMsgId: long
拉取会话消息的起始消息Id
* size: long
拉取的最大消息条数
* callBack: <any>
BMXErrorCode，拉取操作获取的消息列表
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageListList> callBack);
* 搜索消息
Parameters
* keywords: String
搜索的关键字
* refTime: long
搜索消息的起始时间
* size: long
搜索的最大消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
BMXErrorCode，搜索到的消息结果列表
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXDataCallBack<BMXMessageListList> callBack);
* Returns void
getGroupAckMessageUserIdList
* public void getGroupAckMessageUserIdList(final BMXMessage msg, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取发送的群组消息已读用户id列表
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要获取已读用户id列表的消息
* callBack: <any>
BMXErrorCode,对该条消息已读的用户id列表
Returns void
addChatListener
* public void addChatListener(BMXChatServiceListener listener);
* 添加聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
removeChatListener
* public void removeChatListener(BMXChatServiceListener listener);
* 移除聊天监听者
Parameters
* listener: [BMXChatServiceListener](https://developer.qiniu.com/IM/api/8197/bmxchatservicelistener)
聊天监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,622 |
BMXConnectStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXConnectStatus
# BMXConnectStatus
最近更新时间: 2022-07-22 22:40:13
class im.floo.floolib.BMXConnectStatus
网络连接状态
Index
字段
* Disconnected
* Connected
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Disconnected
* public static final [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) Disconnected
*
Connected
* public static final [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) Connected
*
方法
values
* public static im.floo.floolib.BMXConnectStatus[] values();
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
valueOf
* public static im.floo.floolib.BMXConnectStatus valueOf(java.lang.String name);
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXConnectStatus swigToEnum(int swigValue);
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXConnectStatus
# BMXConnectStatus
最近更新时间: 2022-07-22 22:40:13
class im.floo.floolib.BMXConnectStatus
网络连接状态
Index
字段
* Disconnected
* Connected
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Disconnected
* public static final [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) Disconnected
*
Connected
* public static final [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) Connected
*
方法
values
* public static im.floo.floolib.BMXConnectStatus[] values();
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
valueOf
* public static im.floo.floolib.BMXConnectStatus valueOf(java.lang.String name);
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXConnectStatus swigToEnum(int swigValue);
* Returns [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,631 |
BMXConversation.Direction | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) >
BMXConversation.Direction
# BMXConversation.Direction
最近更新时间: 2022-07-22 22:44:44
## 枚举 BMXConversation.Direction
* java.lang.Object
* * java.lang.Enum<BMXConversation.Direction>
* * im.floo.floolib.BMXConversation.Direction
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXConversation.Direction>
封闭类:
BMXConversation
* * *
public static enum BMXConversation.Direction
extends java.lang.Enum<BMXConversation.Direction>
消息搜索方向
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Down`
`Up`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXConversation.Direction` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXConversation.Direction` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXConversation.Direction[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Up
public static final BMXConversation.Direction Up
* #### Down
public static final BMXConversation.Direction Down
* ### 方法详细资料
* #### values
public static BMXConversation.Direction[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXConversation.Direction c : BMXConversation.Direction.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXConversation.Direction valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXConversation.Direction swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus) >
BMXConversation.Direction
# BMXConversation.Direction
最近更新时间: 2022-07-22 22:44:44
## 枚举 BMXConversation.Direction
* java.lang.Object
* * java.lang.Enum<BMXConversation.Direction>
* * im.floo.floolib.BMXConversation.Direction
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXConversation.Direction>
封闭类:
BMXConversation
* * *
public static enum BMXConversation.Direction
extends java.lang.Enum<BMXConversation.Direction>
消息搜索方向
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Down`
`Up`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXConversation.Direction` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXConversation.Direction` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXConversation.Direction[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Up
public static final BMXConversation.Direction Up
* #### Down
public static final BMXConversation.Direction Down
* ### 方法详细资料
* #### values
public static BMXConversation.Direction[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXConversation.Direction c : BMXConversation.Direction.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXConversation.Direction valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXConversation.Direction swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,633 |
BMXConversation | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXConversation
# BMXConversation
最近更新时间: 2022-07-26 14:08:04
class im.floo.floolib.BMXConversation
会话
Index
方法
* getCPtr
* finalize
* delete
* conversationId
* type
* lastMsg
* unreadNumber
* messageCount
* isMuteNotification
* extension
* setExtension
* editMessage
* setEditMessage
* searchMessagesByKeyWords
* searchMessagesByKeyWords
* searchMessagesByType
* searchMessagesByType
* setMessagePlayedStatus
* setMessageReadStatus
* setAllMessagesRead
* updateMessageExtension
* insertMessage
* loadMessage
* removeAllMessages
* loadMessages
* loadMessages
* searchMessages
* searchMessages
* searchMessages
* searchMessages
* refreshConversation
方法
getCPtr
* protected static long getCPtr(BMXConversation obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* @Override() public synchronized void delete();
* Returns void
conversationId
* public long conversationId();
* 会话Id
Returns long
type
* public BMXConversation.Type type();
* 会话类型
Returns Type
lastMsg
* public BMXMessage lastMsg();
* 最新消息
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
unreadNumber
* public int unreadNumber();
* 未读消息数
Returns int
messageCount
* public int messageCount();
* 会话中所有消息的数量
Returns int
isMuteNotification
* public boolean isMuteNotification();
* 是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
Returns boolean
extension
* public String extension();
* 扩展信息
Returns String
setExtension
* public BMXErrorCode setExtension(String ext);
* 设置扩展信息
Parameters
* ext: String
会话扩展消息
Returns BMXErrorCode
editMessage
* public String editMessage();
* 编辑消息
Returns String
setEditMessage
* public BMXErrorCode setEditMessage(String editMessage);
* 设置编辑消息
Parameters
* editMessage: String
会话正在编辑的文本消息
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageList result, BMXConversation.Direction arg4);
* 搜索消息，如果不指定则从最新消息开始
Parameters
* keywords: String
搜索消息的关键字
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* result: BMXMessageList
搜索到的消息结果列表
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageList result);
* Returns BMXErrorCode
searchMessagesByType
* public BMXErrorCode searchMessagesByType(BMXMessage.ContentType type, long refTime, long size, BMXMessageList result, BMXConversation.Direction arg4);
* 按照类型搜索消息，如果不指定则从最新消息开始
Parameters
* type: ContentType
搜索消息的类型
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* result: BMXMessageList
搜索到的消息结果列表
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByType
* public BMXErrorCode searchMessagesByType(BMXMessage.ContentType type, long refTime, long size, BMXMessageList result);
* Returns BMXErrorCode
setMessagePlayedStatus
* public void setMessagePlayedStatus(final BMXMessage msg, final boolean status, final BMXCallBack callBack);
* 设置消息播放状态（只对语音/视频消息有效）
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要设置播放状态的消息
* status: boolean
消息是否已经播放
* callBack: BMXCallBack
回调
Returns void
setMessageReadStatus
* public void setMessageReadStatus(final BMXMessage msg, final boolean status, final BMXCallBack callBack);
* 设置消息未读状态，更新未读消息数
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要设置消息已读状态的消息
* status: boolean
消息是否设置已读
* callBack: BMXCallBack
回调
Returns void
setAllMessagesRead
* public void setAllMessagesRead(final BMXCallBack callBack);
* 把所有消息设置为已读，更新未读消息数
Parameters
* callBack: BMXCallBack
回调
Returns void
updateMessageExtension
* public void updateMessageExtension(final BMXMessage msg, final BMXCallBack callBack);
* 更新一条数据库存储消息的扩展字段信息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要更改扩展信息的消息此时msg部分已经更新扩展字椴信息
* callBack: BMXCallBack
回调
Returns void
insertMessage
* public void insertMessage(final BMXMessage msg, final BMXCallBack callBack);
* 插入一条消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
插入的消息
* callBack: BMXCallBack
回调
Returns void
loadMessage
* public void loadMessage(final long msgId, final BMXDataCallBack<BMXMessage> callBack);
* 读取一条消息
Parameters
* msgId: long
需要读取的消息的消息id
* callBack: <any>
回调
Returns void
removeAllMessages
* public void removeAllMessages(final BMXCallBack callBack);
* 删除会话中的所有消息
Parameters
* callBack: BMXCallBack
回调
Returns void
loadMessages
* public void loadMessages(final long refMsgId, final long size, final BMXConversation.Direction arg3, final BMXDataCallBack<BMXMessageList> callBack);
* 加载消息，如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载消息的起始id
* size: long
最大加载消息条数
* arg3: Direction
加载消息的方向，默认是加载更早的消息
* callBack: <any>
回调
Returns void
loadMessages
* public void loadMessages(final long refMsgId, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageList> callBack);
* 搜索消息，如果不指定则从最新消息开始
Parameters
* keywords: String
搜索消息的关键字
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
回调
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
searchMessages
* public void searchMessages(final BMXMessage.ContentType type, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageList> callBack);
* 按照类型搜索消息，如果不指定则从最新消息开始
Parameters
* type: ContentType
搜索消息的类型
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
回调
Returns void
searchMessages
* public void searchMessages(final BMXMessage.ContentType type, final long refTime, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
refreshConversation
* public void refreshConversation(final BMXCallBack callBack);
* 读取数据库当前会话所有消息数量，强制更新conversation的消息总数和未读消息数。
Parameters
* callBack: BMXCallBack
回调
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXConversation
# BMXConversation
最近更新时间: 2022-07-26 14:08:04
class im.floo.floolib.BMXConversation
会话
Index
方法
* getCPtr
* finalize
* delete
* conversationId
* type
* lastMsg
* unreadNumber
* messageCount
* isMuteNotification
* extension
* setExtension
* editMessage
* setEditMessage
* searchMessagesByKeyWords
* searchMessagesByKeyWords
* searchMessagesByType
* searchMessagesByType
* setMessagePlayedStatus
* setMessageReadStatus
* setAllMessagesRead
* updateMessageExtension
* insertMessage
* loadMessage
* removeAllMessages
* loadMessages
* loadMessages
* searchMessages
* searchMessages
* searchMessages
* searchMessages
* refreshConversation
方法
getCPtr
* protected static long getCPtr(BMXConversation obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* @Override() public synchronized void delete();
* Returns void
conversationId
* public long conversationId();
* 会话Id
Returns long
type
* public BMXConversation.Type type();
* 会话类型
Returns Type
lastMsg
* public BMXMessage lastMsg();
* 最新消息
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
unreadNumber
* public int unreadNumber();
* 未读消息数
Returns int
messageCount
* public int messageCount();
* 会话中所有消息的数量
Returns int
isMuteNotification
* public boolean isMuteNotification();
* 是否提醒用户消息,不提醒的情况下会话总未读数不会统计该会话计数。
Returns boolean
extension
* public String extension();
* 扩展信息
Returns String
setExtension
* public BMXErrorCode setExtension(String ext);
* 设置扩展信息
Parameters
* ext: String
会话扩展消息
Returns BMXErrorCode
editMessage
* public String editMessage();
* 编辑消息
Returns String
setEditMessage
* public BMXErrorCode setEditMessage(String editMessage);
* 设置编辑消息
Parameters
* editMessage: String
会话正在编辑的文本消息
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageList result, BMXConversation.Direction arg4);
* 搜索消息，如果不指定则从最新消息开始
Parameters
* keywords: String
搜索消息的关键字
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* result: BMXMessageList
搜索到的消息结果列表
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByKeyWords
* public BMXErrorCode searchMessagesByKeyWords(String keywords, long refTime, long size, BMXMessageList result);
* Returns BMXErrorCode
searchMessagesByType
* public BMXErrorCode searchMessagesByType(BMXMessage.ContentType type, long refTime, long size, BMXMessageList result, BMXConversation.Direction arg4);
* 按照类型搜索消息，如果不指定则从最新消息开始
Parameters
* type: ContentType
搜索消息的类型
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* result: BMXMessageList
搜索到的消息结果列表
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Returns BMXErrorCode
searchMessagesByType
* public BMXErrorCode searchMessagesByType(BMXMessage.ContentType type, long refTime, long size, BMXMessageList result);
* Returns BMXErrorCode
setMessagePlayedStatus
* public void setMessagePlayedStatus(final BMXMessage msg, final boolean status, final BMXCallBack callBack);
* 设置消息播放状态（只对语音/视频消息有效）
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要设置播放状态的消息
* status: boolean
消息是否已经播放
* callBack: BMXCallBack
回调
Returns void
setMessageReadStatus
* public void setMessageReadStatus(final BMXMessage msg, final boolean status, final BMXCallBack callBack);
* 设置消息未读状态，更新未读消息数
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要设置消息已读状态的消息
* status: boolean
消息是否设置已读
* callBack: BMXCallBack
回调
Returns void
setAllMessagesRead
* public void setAllMessagesRead(final BMXCallBack callBack);
* 把所有消息设置为已读，更新未读消息数
Parameters
* callBack: BMXCallBack
回调
Returns void
updateMessageExtension
* public void updateMessageExtension(final BMXMessage msg, final BMXCallBack callBack);
* 更新一条数据库存储消息的扩展字段信息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
需要更改扩展信息的消息此时msg部分已经更新扩展字椴信息
* callBack: BMXCallBack
回调
Returns void
insertMessage
* public void insertMessage(final BMXMessage msg, final BMXCallBack callBack);
* 插入一条消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
插入的消息
* callBack: BMXCallBack
回调
Returns void
loadMessage
* public void loadMessage(final long msgId, final BMXDataCallBack<BMXMessage> callBack);
* 读取一条消息
Parameters
* msgId: long
需要读取的消息的消息id
* callBack: <any>
回调
Returns void
removeAllMessages
* public void removeAllMessages(final BMXCallBack callBack);
* 删除会话中的所有消息
Parameters
* callBack: BMXCallBack
回调
Returns void
loadMessages
* public void loadMessages(final long refMsgId, final long size, final BMXConversation.Direction arg3, final BMXDataCallBack<BMXMessageList> callBack);
* 加载消息，如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载消息的起始id
* size: long
最大加载消息条数
* arg3: Direction
加载消息的方向，默认是加载更早的消息
* callBack: <any>
回调
Returns void
loadMessages
* public void loadMessages(final long refMsgId, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageList> callBack);
* 搜索消息，如果不指定则从最新消息开始
Parameters
* keywords: String
搜索消息的关键字
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
回调
Returns void
searchMessages
* public void searchMessages(final String keywords, final long refTime, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
searchMessages
* public void searchMessages(final BMXMessage.ContentType type, final long refTime, final long size, final BMXConversation.Direction arg4, final BMXDataCallBack<BMXMessageList> callBack);
* 按照类型搜索消息，如果不指定则从最新消息开始
Parameters
* type: ContentType
搜索消息的类型
* refTime: long
搜索消息的起始时间
* size: long
最大加载消息条数
* arg4: Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
* callBack: <any>
回调
Returns void
searchMessages
* public void searchMessages(final BMXMessage.ContentType type, final long refTime, final long size, final BMXDataCallBack<BMXMessageList> callBack);
* Returns void
refreshConversation
* public void refreshConversation(final BMXCallBack callBack);
* 读取数据库当前会话所有消息数量，强制更新conversation的消息总数和未读消息数。
Parameters
* callBack: BMXCallBack
回调
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,637 |
BMXConversation.Type | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation) >
BMXConversation.Type
# BMXConversation.Type
最近更新时间: 2022-07-22 23:00:43
class im.floo.floolib.BMXConversation.Type
会话类型
Index
字段
* Single
* Group
* System
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Single
* public static final Type Single
*
Group
* public static final Type Group
*
System
* public static final Type System
*
方法
values
* public static im.floo.floolib.BMXConversation.Type[] values();
* Returns Type
valueOf
* public static im.floo.floolib.BMXConversation.Type valueOf(java.lang.String name);
* Returns Type
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Type swigToEnum(int swigValue);
* Returns Type
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation) >
BMXConversation.Type
# BMXConversation.Type
最近更新时间: 2022-07-22 23:00:43
class im.floo.floolib.BMXConversation.Type
会话类型
Index
字段
* Single
* Group
* System
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Single
* public static final Type Single
*
Group
* public static final Type Group
*
System
* public static final Type System
*
方法
values
* public static im.floo.floolib.BMXConversation.Type[] values();
* Returns Type
valueOf
* public static im.floo.floolib.BMXConversation.Type valueOf(java.lang.String name);
* Returns Type
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Type swigToEnum(int swigValue);
* Returns Type
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,646 |
BMXConversation.Direction | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation) >
BMXConversation.Direction
# BMXConversation.Direction
最近更新时间: 2022-07-22 23:00:54
class im.floo.floolib.BMXConversation.Direction
消息搜索方向
Index
字段
* Up
* Down
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Up
* public static final Direction Up
*
Down
* public static final Direction Down
*
方法
values
* public static im.floo.floolib.BMXConversation.Direction[] values();
* Returns Direction
valueOf
* public static im.floo.floolib.BMXConversation.Direction valueOf(java.lang.String name);
* Returns Direction
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Direction swigToEnum(int swigValue);
* Returns Direction
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXConversation](https://developer.qiniu.com/IM/api/8207/bmx-conversation) >
BMXConversation.Direction
# BMXConversation.Direction
最近更新时间: 2022-07-22 23:00:54
class im.floo.floolib.BMXConversation.Direction
消息搜索方向
Index
字段
* Up
* Down
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Up
* public static final Direction Up
*
Down
* public static final Direction Down
*
方法
values
* public static im.floo.floolib.BMXConversation.Direction[] values();
* Returns Direction
valueOf
* public static im.floo.floolib.BMXConversation.Direction valueOf(java.lang.String name);
* Returns Direction
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Direction swigToEnum(int swigValue);
* Returns Direction
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,648 |
BMXDevice | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXDevice
# BMXDevice
最近更新时间: 2022-07-22 22:35:22
class im.floo.floolib.BMXDevice
设备信息
Index
方法
* getCPtr
* finalize
* delete
* deviceSN
* userId
* platform
* userAgent
* setUserAgent
* isCurrentDevice
方法
getCPtr
* protected static long getCPtr(BMXDevice obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
deviceSN
* public int deviceSN();
* 设备序列号
Returns int
userId
* public long userId();
* 用户id
Returns long
platform
* public int platform();
* 软件平台
Returns int
userAgent
* public String userAgent();
* 用户代理信息
Returns String
setUserAgent
* public void setUserAgent(String userAgent);
* 设置用户代理信息
Parameters
* userAgent: String
用户代理信息
Returns void
isCurrentDevice
* public boolean isCurrentDevice();
* 是否是当前设备
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXDevice
# BMXDevice
最近更新时间: 2022-07-22 22:35:22
class im.floo.floolib.BMXDevice
设备信息
Index
方法
* getCPtr
* finalize
* delete
* deviceSN
* userId
* platform
* userAgent
* setUserAgent
* isCurrentDevice
方法
getCPtr
* protected static long getCPtr(BMXDevice obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
deviceSN
* public int deviceSN();
* 设备序列号
Returns int
userId
* public long userId();
* 用户id
Returns long
platform
* public int platform();
* 软件平台
Returns int
userAgent
* public String userAgent();
* 用户代理信息
Returns String
setUserAgent
* public void setUserAgent(String userAgent);
* 设置用户代理信息
Parameters
* userAgent: String
用户代理信息
Returns void
isCurrentDevice
* public boolean isCurrentDevice();
* 是否是当前设备
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,650 |
BMXFileAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXFileAttachment
# BMXFileAttachment
最近更新时间: 2022-07-22 22:46:47
class im.floo.floolib.BMXFileAttachment
消息文件附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* path
* displayName
* ratelUrl
* url
* fileLength
* downloadStatus
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXFileAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回文件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
path
* public String path();
* 本地路径
Returns String
displayName
* public String displayName();
* 显示名
Returns String
ratelUrl
* public String ratelUrl();
* Returns String
url
* public String url();
* 远程URL
Returns String
fileLength
* public long fileLength();
* 文件长度
Returns long
downloadStatus
* public BMXMessageAttachment.DownloadStatus downloadStatus();
* 附件下载状态
Returns DownloadStatus
dynamic_cast
* public static BMXFileAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXFileAttachment](https://developer.qiniu.com/IM/api/8210/bmxfileattachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXFileAttachment
# BMXFileAttachment
最近更新时间: 2022-07-22 22:46:47
class im.floo.floolib.BMXFileAttachment
消息文件附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* path
* displayName
* ratelUrl
* url
* fileLength
* downloadStatus
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXFileAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回文件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
path
* public String path();
* 本地路径
Returns String
displayName
* public String displayName();
* 显示名
Returns String
ratelUrl
* public String ratelUrl();
* Returns String
url
* public String url();
* 远程URL
Returns String
fileLength
* public long fileLength();
* 文件长度
Returns long
downloadStatus
* public BMXMessageAttachment.DownloadStatus downloadStatus();
* 附件下载状态
Returns DownloadStatus
dynamic_cast
* public static BMXFileAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXFileAttachment](https://developer.qiniu.com/IM/api/8210/bmxfileattachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,652 |
BMXGroup | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroup
# BMXGroup
最近更新时间: 2022-07-22 22:41:38
class im.floo.floolib.BMXGroup
群组
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* groupId
* groupType
* myNickname
* name
* description
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailUrl
* avatarThumbnailPath
* createTime
* extension
* ownerId
* capacity
* membersCount
* adminsCount
* blockListSize
* bannedListSize
* sharedFilesCount
* latestAnnouncementId
* msgPushMode
* modifyMode
* joinAuthMode
* inviteMode
* msgMuteMode
* groupStatus
* isMember
* enableReadAck
* historyVisible
* roleType
* banExpireTime
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXGroup obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
groupId
* public long groupId();
* 群Id
Returns long
groupType
* public BMXGroup.GroupType groupType();
* 当前群组的群组类型（Private 私有群组，Public 公开群组，Chatroom 聊天室）
Returns GroupType
myNickname
* public String myNickname();
* 在群里的昵称
Returns String
name
* public String name();
* 群名称
Returns String
description
* public String description();
* 群描述
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 群头像ratel地址
Returns String
avatarUrl
* public String avatarUrl();
* 群头像
Returns String
avatarPath
* public String avatarPath();
* 群头像下载后的本地路径
Returns String
avatarThumbnailUrl
* public String avatarThumbnailUrl();
* 群头像缩略图地址
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 群头像缩略图下载后的本地路径
Returns String
createTime
* public long createTime();
* 群创建时间
Returns long
extension
* public String extension();
* 群扩展信息
Returns String
ownerId
* public long ownerId();
* 群Owner
Returns long
capacity
* public int capacity();
* 最大人数
Returns int
membersCount
* public int membersCount();
* 群成员数量，包含Owner，admins 和members
Returns int
adminsCount
* public int adminsCount();
* 群管理员数量
Returns int
blockListSize
* public int blockListSize();
* 黑名单数量
Returns int
bannedListSize
* public int bannedListSize();
* 禁言数量
Returns int
sharedFilesCount
* public int sharedFilesCount();
* 群共享文件数量
Returns int
latestAnnouncementId
* public long latestAnnouncementId();
* 最新群公告id
Returns long
msgPushMode
* public BMXGroup.MsgPushMode msgPushMode();
* 群消息通知类型
Returns MsgPushMode
modifyMode
* public BMXGroup.ModifyMode modifyMode();
* 群信息修改模式
Returns ModifyMode
joinAuthMode
* public BMXGroup.JoinAuthMode joinAuthMode();
* 入群审批模式
Returns JoinAuthMode
inviteMode
* public BMXGroup.InviteMode inviteMode();
* 入群邀请模式
Returns InviteMode
msgMuteMode
* public BMXGroup.MsgMuteMode msgMuteMode();
* 群消息屏蔽模式
Returns MsgMuteMode
groupStatus
* public BMXGroup.GroupStatus groupStatus();
* 当前群组的状态。（Normal 正常， Destroyed 以销毁）
Returns GroupStatus
isMember
* public boolean isMember();
* Deprecated use roleType instead. 当前用户是否是群成员
Returns boolean
enableReadAck
* public boolean enableReadAck();
* 是否开启群消息已读功能
Returns boolean
historyVisible
* public boolean historyVisible();
* 是否可以加载显示历史聊天记录
Returns boolean
roleType
* public BMXGroup.MemberRoleType roleType();
* 成员在群组内的角色类型
Returns MemberRoleType
banExpireTime
* public long banExpireTime();
* 群组全员禁言到期时间
Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroup
# BMXGroup
最近更新时间: 2022-07-22 22:41:38
class im.floo.floolib.BMXGroup
群组
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* groupId
* groupType
* myNickname
* name
* description
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailUrl
* avatarThumbnailPath
* createTime
* extension
* ownerId
* capacity
* membersCount
* adminsCount
* blockListSize
* bannedListSize
* sharedFilesCount
* latestAnnouncementId
* msgPushMode
* modifyMode
* joinAuthMode
* inviteMode
* msgMuteMode
* groupStatus
* isMember
* enableReadAck
* historyVisible
* roleType
* banExpireTime
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXGroup obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
groupId
* public long groupId();
* 群Id
Returns long
groupType
* public BMXGroup.GroupType groupType();
* 当前群组的群组类型（Private 私有群组，Public 公开群组，Chatroom 聊天室）
Returns GroupType
myNickname
* public String myNickname();
* 在群里的昵称
Returns String
name
* public String name();
* 群名称
Returns String
description
* public String description();
* 群描述
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 群头像ratel地址
Returns String
avatarUrl
* public String avatarUrl();
* 群头像
Returns String
avatarPath
* public String avatarPath();
* 群头像下载后的本地路径
Returns String
avatarThumbnailUrl
* public String avatarThumbnailUrl();
* 群头像缩略图地址
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 群头像缩略图下载后的本地路径
Returns String
createTime
* public long createTime();
* 群创建时间
Returns long
extension
* public String extension();
* 群扩展信息
Returns String
ownerId
* public long ownerId();
* 群Owner
Returns long
capacity
* public int capacity();
* 最大人数
Returns int
membersCount
* public int membersCount();
* 群成员数量，包含Owner，admins 和members
Returns int
adminsCount
* public int adminsCount();
* 群管理员数量
Returns int
blockListSize
* public int blockListSize();
* 黑名单数量
Returns int
bannedListSize
* public int bannedListSize();
* 禁言数量
Returns int
sharedFilesCount
* public int sharedFilesCount();
* 群共享文件数量
Returns int
latestAnnouncementId
* public long latestAnnouncementId();
* 最新群公告id
Returns long
msgPushMode
* public BMXGroup.MsgPushMode msgPushMode();
* 群消息通知类型
Returns MsgPushMode
modifyMode
* public BMXGroup.ModifyMode modifyMode();
* 群信息修改模式
Returns ModifyMode
joinAuthMode
* public BMXGroup.JoinAuthMode joinAuthMode();
* 入群审批模式
Returns JoinAuthMode
inviteMode
* public BMXGroup.InviteMode inviteMode();
* 入群邀请模式
Returns InviteMode
msgMuteMode
* public BMXGroup.MsgMuteMode msgMuteMode();
* 群消息屏蔽模式
Returns MsgMuteMode
groupStatus
* public BMXGroup.GroupStatus groupStatus();
* 当前群组的状态。（Normal 正常， Destroyed 以销毁）
Returns GroupStatus
isMember
* public boolean isMember();
* Deprecated use roleType instead. 当前用户是否是群成员
Returns boolean
enableReadAck
* public boolean enableReadAck();
* 是否开启群消息已读功能
Returns boolean
historyVisible
* public boolean historyVisible();
* 是否可以加载显示历史聊天记录
Returns boolean
roleType
* public BMXGroup.MemberRoleType roleType();
* 成员在群组内的角色类型
Returns MemberRoleType
banExpireTime
* public long banExpireTime();
* 群组全员禁言到期时间
Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,655 |
BMXGroup.Announcement | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Announcement
# BMXGroup.Announcement
最近更新时间: 2022-07-22 23:12:11
class im.floo.floolib.BMXGroup.Announcement
群公告
Index
方法
* getCPtr
* finalize
* delete
* setMTitle
* getMTitle
* setMContent
* getMContent
* setMAuthor
* getMAuthor
* setMCreateTime
* getMCreateTime
* setMId
* getMId
方法
getCPtr
* protected static long getCPtr(Announcement obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMTitle
* public void setMTitle(String value);
* Returns void
getMTitle
* public String getMTitle();
* Returns String
setMContent
* public void setMContent(String value);
* Returns void
getMContent
* public String getMContent();
* Returns String
setMAuthor
* public void setMAuthor(long value);
* Returns void
getMAuthor
* public long getMAuthor();
* Returns long
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMId
* public void setMId(long value);
* Returns void
getMId
* public long getMId();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Announcement
# BMXGroup.Announcement
最近更新时间: 2022-07-22 23:12:11
class im.floo.floolib.BMXGroup.Announcement
群公告
Index
方法
* getCPtr
* finalize
* delete
* setMTitle
* getMTitle
* setMContent
* getMContent
* setMAuthor
* getMAuthor
* setMCreateTime
* getMCreateTime
* setMId
* getMId
方法
getCPtr
* protected static long getCPtr(Announcement obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMTitle
* public void setMTitle(String value);
* Returns void
getMTitle
* public String getMTitle();
* Returns String
setMContent
* public void setMContent(String value);
* Returns void
getMContent
* public String getMContent();
* Returns String
setMAuthor
* public void setMAuthor(long value);
* Returns void
getMAuthor
* public long getMAuthor();
* Returns long
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMId
* public void setMId(long value);
* Returns void
getMId
* public long getMId();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,661 |
BMXGroup.Application | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Application
# BMXGroup.Application
最近更新时间: 2022-07-26 14:11:17
class im.floo.floolib.BMXGroup.Application
群申请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMGroupId
* getMGroupId
* setMApplicationId
* getMApplicationId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Application obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMApplicationId
* public void setMApplicationId(long value);
* Returns void
getMApplicationId
* public long getMApplicationId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXGroup.ApplicationStatus value);
* Returns void
getMStatus
* public BMXGroup.ApplicationStatus getMStatus();
* Returns ApplicationStatus
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Application
# BMXGroup.Application
最近更新时间: 2022-07-26 14:11:17
class im.floo.floolib.BMXGroup.Application
群申请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMGroupId
* getMGroupId
* setMApplicationId
* getMApplicationId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Application obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMApplicationId
* public void setMApplicationId(long value);
* Returns void
getMApplicationId
* public long getMApplicationId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXGroup.ApplicationStatus value);
* Returns void
getMStatus
* public BMXGroup.ApplicationStatus getMStatus();
* Returns ApplicationStatus
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,664 |
BMXGroup.ApplicationStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.ApplicationStatus
# BMXGroup.ApplicationStatus
最近更新时间: 2022-07-22 22:52:06
## 枚举 BMXGroup.ApplicationStatus
* java.lang.Object
* * java.lang.Enum<BMXGroup.ApplicationStatus>
* * im.floo.floolib.BMXGroup.ApplicationStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXGroup.ApplicationStatus>
封闭类:
BMXGroup
* * *
public static enum BMXGroup.ApplicationStatus
extends java.lang.Enum<BMXGroup.ApplicationStatus>
群申请状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Accepted`
`Declined`
`Pending`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXGroup.ApplicationStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXGroup.ApplicationStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXGroup.ApplicationStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Pending
public static final BMXGroup.ApplicationStatus Pending
* #### Accepted
public static final BMXGroup.ApplicationStatus Accepted
* #### Declined
public static final BMXGroup.ApplicationStatus Declined
* ### 方法详细资料
* #### values
public static BMXGroup.ApplicationStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXGroup.ApplicationStatus c : BMXGroup.ApplicationStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXGroup.ApplicationStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXGroup.ApplicationStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.ApplicationStatus
# BMXGroup.ApplicationStatus
最近更新时间: 2022-07-22 22:52:06
## 枚举 BMXGroup.ApplicationStatus
* java.lang.Object
* * java.lang.Enum<BMXGroup.ApplicationStatus>
* * im.floo.floolib.BMXGroup.ApplicationStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXGroup.ApplicationStatus>
封闭类:
BMXGroup
* * *
public static enum BMXGroup.ApplicationStatus
extends java.lang.Enum<BMXGroup.ApplicationStatus>
群申请状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Accepted`
`Declined`
`Pending`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXGroup.ApplicationStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXGroup.ApplicationStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXGroup.ApplicationStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Pending
public static final BMXGroup.ApplicationStatus Pending
* #### Accepted
public static final BMXGroup.ApplicationStatus Accepted
* #### Declined
public static final BMXGroup.ApplicationStatus Declined
* ### 方法详细资料
* #### values
public static BMXGroup.ApplicationStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXGroup.ApplicationStatus c : BMXGroup.ApplicationStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXGroup.ApplicationStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXGroup.ApplicationStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,667 |
BMXGroup.BannedMember | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.BannedMember
# BMXGroup.BannedMember
最近更新时间: 2022-07-22 22:49:41
class im.floo.floolib.BMXGroup.BannedMember
群禁言成员
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMUid
* getMUid
* setMGroupNickname
* getMGroupNickname
* setMCreateTime
* getMCreateTime
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BannedMember obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMUid
* public void setMUid(long value);
* Returns void
getMUid
* public long getMUid();
* Returns long
setMGroupNickname
* public void setMGroupNickname(String value);
* Returns void
getMGroupNickname
* public String getMGroupNickname();
* Returns String
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.BannedMember
# BMXGroup.BannedMember
最近更新时间: 2022-07-22 22:49:41
class im.floo.floolib.BMXGroup.BannedMember
群禁言成员
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMUid
* getMUid
* setMGroupNickname
* getMGroupNickname
* setMCreateTime
* getMCreateTime
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BannedMember obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMUid
* public void setMUid(long value);
* Returns void
getMUid
* public long getMUid();
* Returns long
setMGroupNickname
* public void setMGroupNickname(String value);
* Returns void
getMGroupNickname
* public String getMGroupNickname();
* Returns String
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,671 |
BMXGroup.GroupStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.GroupStatus
# BMXGroup.GroupStatus
最近更新时间: 2022-07-22 23:02:36
class im.floo.floolib.BMXGroup.GroupStatus
群组状态
Index
字段
* Normal
* Destroyed
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Normal
* public static final GroupStatus Normal
*
Destroyed
* public static final GroupStatus Destroyed
*
方法
values
* public static im.floo.floolib.BMXGroup.GroupStatus[] values();
* Returns GroupStatus
valueOf
* public static im.floo.floolib.BMXGroup.GroupStatus valueOf(java.lang.String name);
* Returns GroupStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static GroupStatus swigToEnum(int swigValue);
* Returns GroupStatus
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.GroupStatus
# BMXGroup.GroupStatus
最近更新时间: 2022-07-22 23:02:36
class im.floo.floolib.BMXGroup.GroupStatus
群组状态
Index
字段
* Normal
* Destroyed
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Normal
* public static final GroupStatus Normal
*
Destroyed
* public static final GroupStatus Destroyed
*
方法
values
* public static im.floo.floolib.BMXGroup.GroupStatus[] values();
* Returns GroupStatus
valueOf
* public static im.floo.floolib.BMXGroup.GroupStatus valueOf(java.lang.String name);
* Returns GroupStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static GroupStatus swigToEnum(int swigValue);
* Returns GroupStatus
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,674 |
BMXGroup.GroupType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.GroupType
# BMXGroup.GroupType
最近更新时间: 2021-07-19 14:25:09
## 枚举 BMXGroup.GroupType
* java.lang.Object
* * java.lang.Enum<BMXGroup.GroupType>
* * im.floo.floolib.BMXGroup.GroupType
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXGroup.GroupType>
封闭类:
BMXGroup
* * *
public static enum BMXGroup.GroupType
extends java.lang.Enum<BMXGroup.GroupType>
群类型
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Chatroom`
`Private`
`Public`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXGroup.GroupType` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXGroup.GroupType` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXGroup.GroupType[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Private
public static final BMXGroup.GroupType Private
* #### Public
public static final BMXGroup.GroupType Public
* #### Chatroom
public static final BMXGroup.GroupType Chatroom
* ### 方法详细资料
* #### values
public static BMXGroup.GroupType[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXGroup.GroupType c : BMXGroup.GroupType.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXGroup.GroupType valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXGroup.GroupType swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.GroupType
# BMXGroup.GroupType
最近更新时间: 2021-07-19 14:25:09
## 枚举 BMXGroup.GroupType
* java.lang.Object
* * java.lang.Enum<BMXGroup.GroupType>
* * im.floo.floolib.BMXGroup.GroupType
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXGroup.GroupType>
封闭类:
BMXGroup
* * *
public static enum BMXGroup.GroupType
extends java.lang.Enum<BMXGroup.GroupType>
群类型
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Chatroom`
`Private`
`Public`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXGroup.GroupType` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXGroup.GroupType` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXGroup.GroupType[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Private
public static final BMXGroup.GroupType Private
* #### Public
public static final BMXGroup.GroupType Public
* #### Chatroom
public static final BMXGroup.GroupType Chatroom
* ### 方法详细资料
* #### values
public static BMXGroup.GroupType[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXGroup.GroupType c : BMXGroup.GroupType.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXGroup.GroupType valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXGroup.GroupType swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,676 |
BMXGroup.Invitation | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Invitation
# BMXGroup.Invitation
最近更新时间: 2022-07-26 14:08:27
class im.floo.floolib.BMXGroup.Invitation
群邀请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMGroupId
* getMGroupId
* setMInviterId
* getMInviterId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Invitation obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMInviterId
* public void setMInviterId(long value);
* Returns void
getMInviterId
* public long getMInviterId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXGroup.InvitationStatus value);
* Returns void
getMStatus
* public BMXGroup.InvitationStatus getMStatus();
* Returns InvitationStatus
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.Invitation
# BMXGroup.Invitation
最近更新时间: 2022-07-26 14:08:27
class im.floo.floolib.BMXGroup.Invitation
群邀请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMGroupId
* getMGroupId
* setMInviterId
* getMInviterId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpired
* getMExpired
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Invitation obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMInviterId
* public void setMInviterId(long value);
* Returns void
getMInviterId
* public long getMInviterId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXGroup.InvitationStatus value);
* Returns void
getMStatus
* public BMXGroup.InvitationStatus getMStatus();
* Returns InvitationStatus
setMExpired
* public void setMExpired(long value);
* Returns void
getMExpired
* public long getMExpired();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,680 |
BMXGroup.InviteMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.InviteMode
# BMXGroup.InviteMode
最近更新时间: 2022-07-22 22:50:25
class im.floo.floolib.BMXGroup.InviteMode
邀请入群模式
Index
字段
* AdminOnly
* Open
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AdminOnly
* public static final InviteMode AdminOnly
*
Open
* public static final InviteMode Open
*
方法
values
* public static im.floo.floolib.BMXGroup.InviteMode[] values();
* Returns InviteMode
valueOf
* public static im.floo.floolib.BMXGroup.InviteMode valueOf(java.lang.String name);
* Returns InviteMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static InviteMode swigToEnum(int swigValue);
* Returns InviteMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.InviteMode
# BMXGroup.InviteMode
最近更新时间: 2022-07-22 22:50:25
class im.floo.floolib.BMXGroup.InviteMode
邀请入群模式
Index
字段
* AdminOnly
* Open
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AdminOnly
* public static final InviteMode AdminOnly
*
Open
* public static final InviteMode Open
*
方法
values
* public static im.floo.floolib.BMXGroup.InviteMode[] values();
* Returns InviteMode
valueOf
* public static im.floo.floolib.BMXGroup.InviteMode valueOf(java.lang.String name);
* Returns InviteMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static InviteMode swigToEnum(int swigValue);
* Returns InviteMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,683 |
BMXGroup.JoinAuthMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.JoinAuthMode
# BMXGroup.JoinAuthMode
最近更新时间: 2022-07-22 22:42:15
class im.floo.floolib.BMXGroup.JoinAuthMode
进群验证方式
Index
字段
* Open
* NeedApproval
* RejectAll
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Open
* public static final JoinAuthMode Open
*
NeedApproval
* public static final JoinAuthMode NeedApproval
*
RejectAll
* public static final JoinAuthMode RejectAll
*
方法
values
* public static im.floo.floolib.BMXGroup.JoinAuthMode[] values();
* Returns JoinAuthMode
valueOf
* public static im.floo.floolib.BMXGroup.JoinAuthMode valueOf(java.lang.String name);
* Returns JoinAuthMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static JoinAuthMode swigToEnum(int swigValue);
* Returns JoinAuthMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.JoinAuthMode
# BMXGroup.JoinAuthMode
最近更新时间: 2022-07-22 22:42:15
class im.floo.floolib.BMXGroup.JoinAuthMode
进群验证方式
Index
字段
* Open
* NeedApproval
* RejectAll
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Open
* public static final JoinAuthMode Open
*
NeedApproval
* public static final JoinAuthMode NeedApproval
*
RejectAll
* public static final JoinAuthMode RejectAll
*
方法
values
* public static im.floo.floolib.BMXGroup.JoinAuthMode[] values();
* Returns JoinAuthMode
valueOf
* public static im.floo.floolib.BMXGroup.JoinAuthMode valueOf(java.lang.String name);
* Returns JoinAuthMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static JoinAuthMode swigToEnum(int swigValue);
* Returns JoinAuthMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,685 |
BMXGroup.Member | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) > BMXGroup.Member
# BMXGroup.Member
最近更新时间: 2022-07-22 23:13:11
class im.floo.floolib.BMXGroup.Member
群成员
Index
方法
* getCPtr
* finalize
* delete
* setMUid
* getMUid
* setMGroupNickname
* getMGroupNickname
* setMCreateTime
* getMCreateTime
方法
getCPtr
* protected static long getCPtr(Member obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMUid
* public void setMUid(long value);
* Returns void
getMUid
* public long getMUid();
* Returns long
setMGroupNickname
* public void setMGroupNickname(String value);
* Returns void
getMGroupNickname
* public String getMGroupNickname();
* Returns String
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) > BMXGroup.Member
# BMXGroup.Member
最近更新时间: 2022-07-22 23:13:11
class im.floo.floolib.BMXGroup.Member
群成员
Index
方法
* getCPtr
* finalize
* delete
* setMUid
* getMUid
* setMGroupNickname
* getMGroupNickname
* setMCreateTime
* getMCreateTime
方法
getCPtr
* protected static long getCPtr(Member obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMUid
* public void setMUid(long value);
* Returns void
getMUid
* public long getMUid();
* Returns long
setMGroupNickname
* public void setMGroupNickname(String value);
* Returns void
getMGroupNickname
* public String getMGroupNickname();
* Returns String
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,687 |
BMXGroup.MemberRoleType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MemberRoleType
# BMXGroup.MemberRoleType
最近更新时间: 2022-07-22 23:00:02
class im.floo.floolib.BMXGroup.MemberRoleType
群成员角色
Index
字段
* GroupMember
* GroupAdmin
* GroupOwner
* NotGroupMember
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
GroupMember
* public static final MemberRoleType GroupMember
*
GroupAdmin
* public static final MemberRoleType GroupAdmin
*
GroupOwner
* public static final MemberRoleType GroupOwner
*
NotGroupMember
* public static final MemberRoleType NotGroupMember
*
方法
values
* public static im.floo.floolib.BMXGroup.MemberRoleType[] values();
* Returns MemberRoleType
valueOf
* public static im.floo.floolib.BMXGroup.MemberRoleType valueOf(java.lang.String name);
* Returns MemberRoleType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MemberRoleType swigToEnum(int swigValue);
* Returns MemberRoleType
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MemberRoleType
# BMXGroup.MemberRoleType
最近更新时间: 2022-07-22 23:00:02
class im.floo.floolib.BMXGroup.MemberRoleType
群成员角色
Index
字段
* GroupMember
* GroupAdmin
* GroupOwner
* NotGroupMember
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
GroupMember
* public static final MemberRoleType GroupMember
*
GroupAdmin
* public static final MemberRoleType GroupAdmin
*
GroupOwner
* public static final MemberRoleType GroupOwner
*
NotGroupMember
* public static final MemberRoleType NotGroupMember
*
方法
values
* public static im.floo.floolib.BMXGroup.MemberRoleType[] values();
* Returns MemberRoleType
valueOf
* public static im.floo.floolib.BMXGroup.MemberRoleType valueOf(java.lang.String name);
* Returns MemberRoleType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MemberRoleType swigToEnum(int swigValue);
* Returns MemberRoleType
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,689 |
BMXGroup.ModifyMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.ModifyMode
# BMXGroup.ModifyMode
最近更新时间: 2022-07-22 23:10:06
class im.floo.floolib.BMXGroup.ModifyMode
群信息修改模式
Index
字段
* AdminOnly
* Open
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AdminOnly
* public static final ModifyMode AdminOnly
*
Open
* public static final ModifyMode Open
*
方法
values
* public static im.floo.floolib.BMXGroup.ModifyMode[] values();
* Returns ModifyMode
valueOf
* public static im.floo.floolib.BMXGroup.ModifyMode valueOf(java.lang.String name);
* Returns ModifyMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ModifyMode swigToEnum(int swigValue);
* Returns ModifyMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.ModifyMode
# BMXGroup.ModifyMode
最近更新时间: 2022-07-22 23:10:06
class im.floo.floolib.BMXGroup.ModifyMode
群信息修改模式
Index
字段
* AdminOnly
* Open
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AdminOnly
* public static final ModifyMode AdminOnly
*
Open
* public static final ModifyMode Open
*
方法
values
* public static im.floo.floolib.BMXGroup.ModifyMode[] values();
* Returns ModifyMode
valueOf
* public static im.floo.floolib.BMXGroup.ModifyMode valueOf(java.lang.String name);
* Returns ModifyMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ModifyMode swigToEnum(int swigValue);
* Returns ModifyMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,691 |
BMXGroup.MsgMuteMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MsgMuteMode
# BMXGroup.MsgMuteMode
最近更新时间: 2022-07-22 23:02:24
class im.floo.floolib.BMXGroup.MsgMuteMode
群组消息屏蔽模式
Index
字段
* None
* MuteNotification
* MuteChat
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
None
* public static final MsgMuteMode None
*
MuteNotification
* public static final MsgMuteMode MuteNotification
*
MuteChat
* public static final MsgMuteMode MuteChat
*
方法
values
* public static im.floo.floolib.BMXGroup.MsgMuteMode[] values();
* Returns MsgMuteMode
valueOf
* public static im.floo.floolib.BMXGroup.MsgMuteMode valueOf(java.lang.String name);
* Returns MsgMuteMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MsgMuteMode swigToEnum(int swigValue);
* Returns MsgMuteMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MsgMuteMode
# BMXGroup.MsgMuteMode
最近更新时间: 2022-07-22 23:02:24
class im.floo.floolib.BMXGroup.MsgMuteMode
群组消息屏蔽模式
Index
字段
* None
* MuteNotification
* MuteChat
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
None
* public static final MsgMuteMode None
*
MuteNotification
* public static final MsgMuteMode MuteNotification
*
MuteChat
* public static final MsgMuteMode MuteChat
*
方法
values
* public static im.floo.floolib.BMXGroup.MsgMuteMode[] values();
* Returns MsgMuteMode
valueOf
* public static im.floo.floolib.BMXGroup.MsgMuteMode valueOf(java.lang.String name);
* Returns MsgMuteMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MsgMuteMode swigToEnum(int swigValue);
* Returns MsgMuteMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,693 |
BMXGroup.MsgPushMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MsgPushMode
# BMXGroup.MsgPushMode
最近更新时间: 2022-07-22 23:10:26
class im.floo.floolib.BMXGroup.MsgPushMode
消息通知类型
Index
字段
* All
* None
* AdminOrAt
* Admin
* At
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
All
* public static final MsgPushMode All
*
None
* public static final MsgPushMode None
*
AdminOrAt
* public static final MsgPushMode AdminOrAt
*
Admin
* public static final MsgPushMode Admin
*
At
* public static final MsgPushMode At
*
方法
values
* public static im.floo.floolib.BMXGroup.MsgPushMode[] values();
* Returns MsgPushMode
valueOf
* public static im.floo.floolib.BMXGroup.MsgPushMode valueOf(java.lang.String name);
* Returns MsgPushMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MsgPushMode swigToEnum(int swigValue);
* Returns MsgPushMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.MsgPushMode
# BMXGroup.MsgPushMode
最近更新时间: 2022-07-22 23:10:26
class im.floo.floolib.BMXGroup.MsgPushMode
消息通知类型
Index
字段
* All
* None
* AdminOrAt
* Admin
* At
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
All
* public static final MsgPushMode All
*
None
* public static final MsgPushMode None
*
AdminOrAt
* public static final MsgPushMode AdminOrAt
*
Admin
* public static final MsgPushMode Admin
*
At
* public static final MsgPushMode At
*
方法
values
* public static im.floo.floolib.BMXGroup.MsgPushMode[] values();
* Returns MsgPushMode
valueOf
* public static im.floo.floolib.BMXGroup.MsgPushMode valueOf(java.lang.String name);
* Returns MsgPushMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MsgPushMode swigToEnum(int swigValue);
* Returns MsgPushMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,695 |
BMXGroup.UpdateInfoType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.UpdateInfoType
# BMXGroup.UpdateInfoType
最近更新时间: 2022-07-26 14:11:51
class im.floo.floolib.BMXGroup.UpdateInfoType
群组信息更新类型
Index
字段
* UnKnown
* Name
* Description
* Avatar
* Owner
* Ext
* NickName
* ModifyMode
* JoinAuthMode
* InviteMode
* MsgPushMode
* MsgMuteMode
* ReadAckMode
* HistoryVisibleMode
* BanExpireTime
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
UnKnown
* public static final UpdateInfoType UnKnown
*
Name
* public static final UpdateInfoType Name
*
Description
* public static final UpdateInfoType Description
*
Avatar
* public static final UpdateInfoType Avatar
*
Owner
* public static final UpdateInfoType Owner
*
Ext
* public static final UpdateInfoType Ext
*
NickName
* public static final UpdateInfoType NickName
*
ModifyMode
* public static final UpdateInfoType ModifyMode
*
JoinAuthMode
* public static final UpdateInfoType JoinAuthMode
*
InviteMode
* public static final UpdateInfoType InviteMode
*
MsgPushMode
* public static final UpdateInfoType MsgPushMode
*
MsgMuteMode
* public static final UpdateInfoType MsgMuteMode
*
ReadAckMode
* public static final UpdateInfoType ReadAckMode
*
HistoryVisibleMode
* public static final UpdateInfoType HistoryVisibleMode
*
BanExpireTime
* public static final UpdateInfoType BanExpireTime
*
方法
values
* public static im.floo.floolib.BMXGroup.UpdateInfoType[] values();
* Returns UpdateInfoType
valueOf
* public static im.floo.floolib.BMXGroup.UpdateInfoType valueOf(java.lang.String name);
* Returns UpdateInfoType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static UpdateInfoType swigToEnum(int swigValue);
* Returns UpdateInfoType
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.UpdateInfoType
# BMXGroup.UpdateInfoType
最近更新时间: 2022-07-26 14:11:51
class im.floo.floolib.BMXGroup.UpdateInfoType
群组信息更新类型
Index
字段
* UnKnown
* Name
* Description
* Avatar
* Owner
* Ext
* NickName
* ModifyMode
* JoinAuthMode
* InviteMode
* MsgPushMode
* MsgMuteMode
* ReadAckMode
* HistoryVisibleMode
* BanExpireTime
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
UnKnown
* public static final UpdateInfoType UnKnown
*
Name
* public static final UpdateInfoType Name
*
Description
* public static final UpdateInfoType Description
*
Avatar
* public static final UpdateInfoType Avatar
*
Owner
* public static final UpdateInfoType Owner
*
Ext
* public static final UpdateInfoType Ext
*
NickName
* public static final UpdateInfoType NickName
*
ModifyMode
* public static final UpdateInfoType ModifyMode
*
JoinAuthMode
* public static final UpdateInfoType JoinAuthMode
*
InviteMode
* public static final UpdateInfoType InviteMode
*
MsgPushMode
* public static final UpdateInfoType MsgPushMode
*
MsgMuteMode
* public static final UpdateInfoType MsgMuteMode
*
ReadAckMode
* public static final UpdateInfoType ReadAckMode
*
HistoryVisibleMode
* public static final UpdateInfoType HistoryVisibleMode
*
BanExpireTime
* public static final UpdateInfoType BanExpireTime
*
方法
values
* public static im.floo.floolib.BMXGroup.UpdateInfoType[] values();
* Returns UpdateInfoType
valueOf
* public static im.floo.floolib.BMXGroup.UpdateInfoType valueOf(java.lang.String name);
* Returns UpdateInfoType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static UpdateInfoType swigToEnum(int swigValue);
* Returns UpdateInfoType
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,698 |
BMXGroup.SharedFile | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.SharedFile
# BMXGroup.SharedFile
最近更新时间: 2022-07-22 22:51:06
class im.floo.floolib.BMXGroup.SharedFile
群共享文件
Index
方法
* getCPtr
* finalize
* delete
* setMFileId
* getMFileId
* setMGroupId
* getMGroupId
* setMUploader
* getMUploader
* setMSize
* getMSize
* setMCreateTime
* getMCreateTime
* setMUpdateTime
* getMUpdateTime
* setMRatelUrl
* getMRatelUrl
* setMUrl
* getMUrl
* setMPath
* getMPath
* setMDisplayName
* getMDisplayName
* setMType
* getMType
方法
getCPtr
* protected static long getCPtr(SharedFile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMFileId
* public void setMFileId(long value);
* Returns void
getMFileId
* public long getMFileId();
* Returns long
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMUploader
* public void setMUploader(long value);
* Returns void
getMUploader
* public long getMUploader();
* Returns long
setMSize
* public void setMSize(int value);
* Returns void
getMSize
* public int getMSize();
* Returns int
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMUpdateTime
* public void setMUpdateTime(long value);
* Returns void
getMUpdateTime
* public long getMUpdateTime();
* Returns long
setMRatelUrl
* public void setMRatelUrl(String value);
* Returns void
getMRatelUrl
* public String getMRatelUrl();
* Returns String
setMUrl
* public void setMUrl(String value);
* Returns void
getMUrl
* public String getMUrl();
* Returns String
setMPath
* public void setMPath(String value);
* Returns void
getMPath
* public String getMPath();
* Returns String
setMDisplayName
* public void setMDisplayName(String value);
* Returns void
getMDisplayName
* public String getMDisplayName();
* Returns String
setMType
* public void setMType(String value);
* Returns void
getMType
* public String getMType();
* Returns String
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup) >
BMXGroup.SharedFile
# BMXGroup.SharedFile
最近更新时间: 2022-07-22 22:51:06
class im.floo.floolib.BMXGroup.SharedFile
群共享文件
Index
方法
* getCPtr
* finalize
* delete
* setMFileId
* getMFileId
* setMGroupId
* getMGroupId
* setMUploader
* getMUploader
* setMSize
* getMSize
* setMCreateTime
* getMCreateTime
* setMUpdateTime
* getMUpdateTime
* setMRatelUrl
* getMRatelUrl
* setMUrl
* getMUrl
* setMPath
* getMPath
* setMDisplayName
* getMDisplayName
* setMType
* getMType
方法
getCPtr
* protected static long getCPtr(SharedFile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMFileId
* public void setMFileId(long value);
* Returns void
getMFileId
* public long getMFileId();
* Returns long
setMGroupId
* public void setMGroupId(long value);
* Returns void
getMGroupId
* public long getMGroupId();
* Returns long
setMUploader
* public void setMUploader(long value);
* Returns void
getMUploader
* public long getMUploader();
* Returns long
setMSize
* public void setMSize(int value);
* Returns void
getMSize
* public int getMSize();
* Returns int
setMCreateTime
* public void setMCreateTime(long value);
* Returns void
getMCreateTime
* public long getMCreateTime();
* Returns long
setMUpdateTime
* public void setMUpdateTime(long value);
* Returns void
getMUpdateTime
* public long getMUpdateTime();
* Returns long
setMRatelUrl
* public void setMRatelUrl(String value);
* Returns void
getMRatelUrl
* public String getMRatelUrl();
* Returns String
setMUrl
* public void setMUrl(String value);
* Returns void
getMUrl
* public String getMUrl();
* Returns String
setMPath
* public void setMPath(String value);
* Returns void
getMPath
* public String getMPath();
* Returns String
setMDisplayName
* public void setMDisplayName(String value);
* Returns void
getMDisplayName
* public String getMDisplayName();
* Returns String
setMType
* public void setMType(String value);
* Returns void
getMType
* public String getMType();
* Returns String
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,702 |
BMXGroupManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupManager
# BMXGroupManager
最近更新时间: 2021-07-19 15:01:53
## 类 BMXGroupManager
* java.lang.Object
* * im.floo.floolib.BMXGroupManager
* * * *
public class BMXGroupManager
extends java.lang.Object
群组管理器
* * ### 构造器概要
构造器 构造器和说明
---
`BMXGroupManager(BMXGroupService service)`
* ### 方法概要
所有方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`void` | `acceptApplication(BMXGroup group, long applicantId, BMXCallBack callBack)` 接受入群申请
`void` | `acceptInvitation(BMXGroup group, long inviter, BMXCallBack callBack)` 接受入群邀请
`void` | `addAdmins(BMXGroup group, ListOfLongLong admins, java.lang.String message, BMXCallBack callBack)` 添加管理员
`void` | `addGroupListener(BMXGroupServiceListener listener)` 添加群组变化监听者
`void` | `addMembers(BMXGroup group, ListOfLongLong members, java.lang.String message, BMXCallBack callBack)` 添加群成员
`void` | `banMembers(BMXGroup group, ListOfLongLong members, long duration, java.lang.String reason, BMXCallBack callBack)` 禁言
`void` | `blockMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 添加黑名单
`void` | `changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, java.lang.String name, BMXCallBack callBack)` 修改群共享文件名称
`void` | `create(BMXGroupService.CreateGroupOptions options, <any> callBack)` 创建群
`void` | `declineApplication(BMXGroup group, long applicantId, java.lang.String reason, BMXCallBack callBack)` 拒绝入群申请
`void` | `declineInvitation(BMXGroup group, long inviter, BMXCallBack callBack)` 拒绝入群邀请
`void` | `deleteAnnouncement(BMXGroup group, long announcementId, BMXCallBack callBack)` 删除群公告
`void` | `destroy(BMXGroup group, BMXCallBack callBack)` 销毁群
`void` | `downloadAvatar(BMXGroup group, FileProgressListener listener, BMXCallBack callBack)` 下载群头像
`void` | `downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, FileProgressListener listener, BMXCallBack callBack)` 下载群共享文件
`void` | `editAnnouncement(BMXGroup group, java.lang.String title, java.lang.String content, BMXCallBack callBack)` 设置群公告
`void` | `getAdmins(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取Admins列表，如果设置了forceRefresh则从服务器拉取
`void` | `getAnnouncementList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群公告列表
`void` | `getApplicationList(BMXGroupList list, java.lang.String cursor, int pageSize, <any> callBack)` 分页获取群组申请列表
`void` | `getBannedMembers(BMXGroup group, <any> callBack)` 获取禁言列表
`void` | `getBlockList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取黑名单
`void` | `getGroupList(boolean forceRefresh, <any> callBack)` 获取群组列表，如果设置了forceRefresh则从服务器拉取
`void` | `getGroupList(ListOfLongLong groupIdList, boolean forceRefresh, <any> callBack)` 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
`void` | `getGroupList(long groupId, boolean forceUpdate, <any> callBack)` 获取群信息，如果设置了forceRefresh则从服务器拉取
`void` | `getInfo(BMXGroup group, <any> callBack)` 获取群详情，从服务端拉取最新信息
`void` | `getInvitationList(java.lang.String cursor, int pageSize, <any> callBack)` 分页获取群组邀请列表
`void` | `getLatestAnnouncement(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取最新的群公告
`void` | `getMembers(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
`void` | `getSharedFilesList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群共享文件列表
`void` | `join(BMXGroup group, java.lang.String message, BMXCallBack callBack)` 加入一个群，根据群设置可能需要管理员批准
`void` | `leave(BMXGroup group, BMXCallBack callBack)` 退出群
`void` | `muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode, BMXCallBack callBack)` 设置是否屏蔽群消息
`void` | `removeAdmins(BMXGroup group, ListOfLongLong admins, java.lang.String reason, BMXCallBack callBack)` 删除管理员
`void` | `removeGroupListener(BMXGroupServiceListener listener)` 移除群组变化监听者
`void` | `removeMembers(BMXGroup group, ListOfLongLong members, java.lang.String reason, BMXCallBack callBack)` 删除群成员
`void` | `removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, BMXCallBack callBack)` 移除群共享文件
`void` | `setAvatar(BMXGroup group, java.lang.String avatarPath, FileProgressListener listener, BMXCallBack callBack)` 设置群头像
`void` | `setDescription(BMXGroup group, java.lang.String description, BMXCallBack callBack)` 设置群描述信息
`void` | `setEnableReadAck(BMXGroup group, boolean enable, BMXCallBack callBack)` 设置是否开启群消息已读功能
`void` | `setExtension(BMXGroup group, java.lang.String extension, BMXCallBack callBack)` 设置群扩展信息
`void` | `setInviteMode(BMXGroup group, BMXGroup.InviteMode mode, BMXCallBack callBack)` 设置邀请模式
`void` | `setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode, BMXCallBack callBack)` 设置入群审批模式
`void` | `setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode, BMXCallBack callBack)` 设置群消息通知模式
`void` | `setMyNickname(BMXGroup group, java.lang.String nickname, BMXCallBack callBack)` 设置在群里的昵称
`void` | `setName(BMXGroup group, java.lang.String name, BMXCallBack callBack)` 设置群名称
`void` | `transferOwner(BMXGroup group, long newOwnerId, BMXCallBack callBack)` 转移群主
`void` | `unbanMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 解除禁言
`void` | `unblockMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 从黑名单删除
`void` | `uploadSharedFile(BMXGroup group, java.lang.String filePath, java.lang.String displayName, java.lang.String extensionName, FileProgressListener listener, BMXCallBack callBack)` 添加群共享文件
* ### 从类继承的方法 java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait`
* * ### 构造器详细资料
* #### BMXGroupManager
public BMXGroupManager(BMXGroupService service)
* ### 方法详细资料
* #### getGroupList
public void getGroupList(boolean forceRefresh,
<any> callBack)
获取群组列表，如果设置了forceRefresh则从服务器拉取
参数:
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群组id列表
* #### getGroupList
public void getGroupList(ListOfLongLong groupIdList,
boolean forceRefresh,
<any> callBack)
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
参数:
`groupIdList` \- 群组id列表
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群组详细信息列表
* #### getGroupList
public void getGroupList(long groupId,
boolean forceUpdate,
<any> callBack)
获取群信息，如果设置了forceRefresh则从服务器拉取
参数:
`groupId` \- 要搜索的群组id
`forceUpdate` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,搜索返回的群组信息
* #### getInvitationList
public void getInvitationList(java.lang.String cursor,
int pageSize,
<any> callBack)
分页获取群组邀请列表
参数:
`cursor` \- 分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
`pageSize` \- 分页大小
`callBack` \- BMXErrorCode,分页获取的群组邀请列表
* #### getApplicationList
public void getApplicationList(BMXGroupList list,
java.lang.String cursor,
int pageSize,
<any> callBack)
分页获取群组申请列表
参数:
`list` \- 需要获取群组申请列表信息的群组id列表
`cursor` \- 分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
`pageSize` \- 分页大小
`callBack` \- BMXErrorCode,分页获取的群组申请列表
* #### create
public void create(BMXGroupService.CreateGroupOptions options,
<any> callBack)
创建群
参数:
`options` \- 创建群组时传入的参数选项
`callBack` \- BMXErrorCode,创建好的群
* #### destroy
public void destroy(BMXGroup group,
BMXCallBack callBack)
销毁群
参数:
`callBack` \- BMXErrorCode，要销毁的群组
* #### join
public void join(BMXGroup group,
java.lang.String message,
BMXCallBack callBack)
加入一个群，根据群设置可能需要管理员批准
参数:
`group` \- 要加入的群组
`message` \- 申请入群的信息
`callBack` \- BMXErrorCode
* #### leave
public void leave(BMXGroup group,
BMXCallBack callBack)
退出群
参数:
`group` \- 要退出的群组
`callBack` \- BMXErrorCode
* #### getInfo
public void getInfo(BMXGroup group,
<any> callBack)
获取群详情，从服务端拉取最新信息
参数:
`callBack` \- BMXErrorCode,要获取群组最新信息的群组
* #### getMembers
public void getMembers(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群成员列表
* #### addMembers
public void addMembers(BMXGroup group,
ListOfLongLong members,
java.lang.String message,
BMXCallBack callBack)
添加群成员
参数:
`group` \- 进行操作的群组
`members` \- 要添加进群的成员id列表
`message` \- 添加成员原因信息
`callBack` \- BMXErrorCode
* #### removeMembers
public void removeMembers(BMXGroup group,
ListOfLongLong members,
java.lang.String reason,
BMXCallBack callBack)
删除群成员
参数:
`group` \- 进行操作的群组
`members` \- 要删除的群组成员id列表
`reason` \- 删除的原因
`callBack` \- BMXErrorCode
* #### addAdmins
public void addAdmins(BMXGroup group,
ListOfLongLong admins,
java.lang.String message,
BMXCallBack callBack)
添加管理员
参数:
`group` \- 进行操作的群组
`admins` \- 要添加为管理员的成员id列表
`message` \- 添加为管理员的原因
`callBack` \- BMXErrorCode
* #### removeAdmins
public void removeAdmins(BMXGroup group,
ListOfLongLong admins,
java.lang.String reason,
BMXCallBack callBack)
删除管理员
参数:
`group` \- 进行操作的群组
`admins` \- 要从管理员移除的成员id列表
`reason` \- 要移除管理员的原因
`callBack` \- BMXErrorCode
* #### getAdmins
public void getAdmins(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取Admins列表，如果设置了forceRefresh则从服务器拉取
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群管理员列表
* #### blockMembers
public void blockMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
添加黑名单
参数:
`group` \- 进行操作的群组
`members` \- 要加入黑名单的群成员id列表
`callBack` \- BMXErrorCode
* #### unblockMembers
public void unblockMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
从黑名单删除
参数:
`group` \- 进行操作的群组
`members` \- 从黑名单移除的用户id列表
`callBack` \- BMXErrorCode
* #### getBlockList
public void getBlockList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取黑名单
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群黑名单列表
* #### banMembers
public void banMembers(BMXGroup group,
ListOfLongLong members,
long duration,
java.lang.String reason,
BMXCallBack callBack)
禁言
参数:
`group` \- 进行操作的群组
`members` \- 被禁言的群成员id列表
`duration` \- 禁言时长
`reason` \- 禁言原因
`callBack` \- BMXErrorCode
* #### unbanMembers
public void unbanMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
解除禁言
参数:
`group` \- 进行操作的群组
`members` \- 被解除禁言的群成员id列表
`callBack` \- BMXErrorCode
* #### getBannedMembers
public void getBannedMembers(BMXGroup group,
<any> callBack)
获取禁言列表
参数:
`group` \- 进行操作的群组
`callBack` \- BMXErrorCode 群禁言列表
* #### muteMessage
public void muteMessage(BMXGroup group,
BMXGroup.MsgMuteMode mode,
BMXCallBack callBack)
设置是否屏蔽群消息
参数:
`group` \- 进行操作的群组
`mode` \- 群屏蔽的模式
`callBack` \- BMXErrorCode
* #### acceptApplication
public void acceptApplication(BMXGroup group,
long applicantId,
BMXCallBack callBack)
接受入群申请
参数:
`group` \- 进行操作的群组
`applicantId` \- 申请进群的用户id
`callBack` \- BMXErrorCode
* #### declineApplication
public void declineApplication(BMXGroup group,
long applicantId,
java.lang.String reason,
BMXCallBack callBack)
拒绝入群申请
参数:
`group` \- 进行操作的群组
`applicantId` \- 申请进群的用户id
`reason` \- 拒绝的原因
`callBack` \- BMXErrorCode
* #### acceptInvitation
public void acceptInvitation(BMXGroup group,
long inviter,
BMXCallBack callBack)
接受入群邀请
参数:
`group` \- 进行操作的群组
`inviter` \- 邀请者id
`callBack` \- BMXErrorCode
* #### declineInvitation
public void declineInvitation(BMXGroup group,
long inviter,
BMXCallBack callBack)
拒绝入群邀请
参数:
`group` \- 进行操作的群组
`inviter` \- 邀请者id
`callBack` \- BMXErrorCode
* #### transferOwner
public void transferOwner(BMXGroup group,
long newOwnerId,
BMXCallBack callBack)
转移群主
参数:
`group` \- 进行操作的群组
`newOwnerId` \- 转让为新群主的用户id
`callBack` \- BMXErrorCode
* #### uploadSharedFile
public void uploadSharedFile(BMXGroup group,
java.lang.String filePath,
java.lang.String displayName,
java.lang.String extensionName,
FileProgressListener listener,
BMXCallBack callBack)
添加群共享文件
参数:
`group` \- 进行操作的群组
`filePath` \- 文件的本地路径
`displayName` \- 文件的展示名
`extensionName` \- 文件的扩展名
`listener` \- 上传回调函数
`callBack` \- BMXErrorCode
* #### removeSharedFile
public void removeSharedFile(BMXGroup group,
BMXGroup.SharedFile sharedFile,
BMXCallBack callBack)
移除群共享文件
参数:
`group` \- 进行操作的群组
`sharedFile` \- 删除的群共享文件
`callBack` \- BMXErrorCode
* #### downloadSharedFile
public void downloadSharedFile(BMXGroup group,
BMXGroup.SharedFile sharedFile,
FileProgressListener listener,
BMXCallBack callBack)
下载群共享文件
参数:
`group` \- 进行操作的群组
`sharedFile` \- 下载的群共享文件
`listener` \- 下载回调函数
`callBack` \- BMXErrorCode
* #### getSharedFilesList
public void getSharedFilesList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群共享文件列表
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode 群共享文件列表
* #### changeSharedFileName
public void changeSharedFileName(BMXGroup group,
BMXGroup.SharedFile sharedFile,
java.lang.String name,
BMXCallBack callBack)
修改群共享文件名称
参数:
`group` \- 进行操作的群组
`sharedFile` \- 进行更改的群共享文件
`name` \- 修改的群共享文件名称
`callBack` \- BMXErrorCode
* #### getLatestAnnouncement
public void getLatestAnnouncement(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取最新的群公告
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode 最新的群组公告
* #### getAnnouncementList
public void getAnnouncementList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群公告列表
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode, 群公告列表
* #### editAnnouncement
public void editAnnouncement(BMXGroup group,
java.lang.String title,
java.lang.String content,
BMXCallBack callBack)
设置群公告
参数:
`group` \- 进行操作的群组
`title` \- 群公告的标题
`content` \- 群公告的内容
`callBack` \- BMXErrorCode
* #### deleteAnnouncement
public void deleteAnnouncement(BMXGroup group,
long announcementId,
BMXCallBack callBack)
删除群公告
参数:
`group` \- 进行操作的群组
`announcementId` \- 删除的群公告id
`callBack` \- BMXErrorCode
* #### setName
public void setName(BMXGroup group,
java.lang.String name,
BMXCallBack callBack)
设置群名称
参数:
`group` \- 进行操作的群组
`name` \- 群组名称
`callBack` \- BMXErrorCode
* #### setDescription
public void setDescription(BMXGroup group,
java.lang.String description,
BMXCallBack callBack)
设置群描述信息
参数:
`group` \- 进行操作的群组
`description` \- 群组描述
`callBack` \- BMXErrorCode
* #### setExtension
public void setExtension(BMXGroup group,
java.lang.String extension,
BMXCallBack callBack)
设置群扩展信息
参数:
`group` \- 进行操作的群组
`extension` \- 群组的扩展信息
`callBack` \- BMXErrorCode
* #### setMyNickname
public void setMyNickname(BMXGroup group,
java.lang.String nickname,
BMXCallBack callBack)
设置在群里的昵称
参数:
`group` \- 进行操作的群组
`nickname` \- 用户在群组内的昵称
`callBack` \- BMXErrorCode
* #### setMsgPushMode
public void setMsgPushMode(BMXGroup group,
BMXGroup.MsgPushMode mode,
BMXCallBack callBack)
设置群消息通知模式
参数:
`group` \- 进行操作的群组
`mode` \- 群消息通知模式
`callBack` \- BMXErrorCode
* #### setJoinAuthMode
public void setJoinAuthMode(BMXGroup group,
BMXGroup.JoinAuthMode mode,
BMXCallBack callBack)
设置入群审批模式
参数:
`group` \- 进行操作的群组
`mode` \- 入群审批模式
`callBack` \- BMXErrorCode
* #### setInviteMode
public void setInviteMode(BMXGroup group,
BMXGroup.InviteMode mode,
BMXCallBack callBack)
设置邀请模式
参数:
`group` \- 进行操作的群组
`mode` \- 群组的邀请模式
`callBack` \- BMXErrorCode
* #### setAvatar
public void setAvatar(BMXGroup group,
java.lang.String avatarPath,
FileProgressListener listener,
BMXCallBack callBack)
设置群头像
参数:
`group` \- 进行操作的群组
`avatarPath` \- 群头像文件的本地路径
`listener` \- 上传回调函数
`callBack` \- BMXErrorCode
* #### downloadAvatar
public void downloadAvatar(BMXGroup group,
FileProgressListener listener,
BMXCallBack callBack)
下载群头像
参数:
`group` \- 进行操作的群组
`listener` \- 下载回调函数
`callBack` \- BMXErrorCode
* #### addGroupListener
public void addGroupListener(BMXGroupServiceListener listener)
添加群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### removeGroupListener
public void removeGroupListener(BMXGroupServiceListener listener)
移除群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### setEnableReadAck
public void setEnableReadAck(BMXGroup group,
boolean enable,
BMXCallBack callBack)
设置是否开启群消息已读功能
参数:
`group` \- 进行操作的群组
`enable` \- 是否开启
`callBack` \- BMXErrorCode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupManager
# BMXGroupManager
最近更新时间: 2021-07-19 15:01:53
## 类 BMXGroupManager
* java.lang.Object
* * im.floo.floolib.BMXGroupManager
* * * *
public class BMXGroupManager
extends java.lang.Object
群组管理器
* * ### 构造器概要
构造器 构造器和说明
---
`BMXGroupManager(BMXGroupService service)`
* ### 方法概要
所有方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`void` | `acceptApplication(BMXGroup group, long applicantId, BMXCallBack callBack)` 接受入群申请
`void` | `acceptInvitation(BMXGroup group, long inviter, BMXCallBack callBack)` 接受入群邀请
`void` | `addAdmins(BMXGroup group, ListOfLongLong admins, java.lang.String message, BMXCallBack callBack)` 添加管理员
`void` | `addGroupListener(BMXGroupServiceListener listener)` 添加群组变化监听者
`void` | `addMembers(BMXGroup group, ListOfLongLong members, java.lang.String message, BMXCallBack callBack)` 添加群成员
`void` | `banMembers(BMXGroup group, ListOfLongLong members, long duration, java.lang.String reason, BMXCallBack callBack)` 禁言
`void` | `blockMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 添加黑名单
`void` | `changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, java.lang.String name, BMXCallBack callBack)` 修改群共享文件名称
`void` | `create(BMXGroupService.CreateGroupOptions options, <any> callBack)` 创建群
`void` | `declineApplication(BMXGroup group, long applicantId, java.lang.String reason, BMXCallBack callBack)` 拒绝入群申请
`void` | `declineInvitation(BMXGroup group, long inviter, BMXCallBack callBack)` 拒绝入群邀请
`void` | `deleteAnnouncement(BMXGroup group, long announcementId, BMXCallBack callBack)` 删除群公告
`void` | `destroy(BMXGroup group, BMXCallBack callBack)` 销毁群
`void` | `downloadAvatar(BMXGroup group, FileProgressListener listener, BMXCallBack callBack)` 下载群头像
`void` | `downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, FileProgressListener listener, BMXCallBack callBack)` 下载群共享文件
`void` | `editAnnouncement(BMXGroup group, java.lang.String title, java.lang.String content, BMXCallBack callBack)` 设置群公告
`void` | `getAdmins(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取Admins列表，如果设置了forceRefresh则从服务器拉取
`void` | `getAnnouncementList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群公告列表
`void` | `getApplicationList(BMXGroupList list, java.lang.String cursor, int pageSize, <any> callBack)` 分页获取群组申请列表
`void` | `getBannedMembers(BMXGroup group, <any> callBack)` 获取禁言列表
`void` | `getBlockList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取黑名单
`void` | `getGroupList(boolean forceRefresh, <any> callBack)` 获取群组列表，如果设置了forceRefresh则从服务器拉取
`void` | `getGroupList(ListOfLongLong groupIdList, boolean forceRefresh, <any> callBack)` 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
`void` | `getGroupList(long groupId, boolean forceUpdate, <any> callBack)` 获取群信息，如果设置了forceRefresh则从服务器拉取
`void` | `getInfo(BMXGroup group, <any> callBack)` 获取群详情，从服务端拉取最新信息
`void` | `getInvitationList(java.lang.String cursor, int pageSize, <any> callBack)` 分页获取群组邀请列表
`void` | `getLatestAnnouncement(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取最新的群公告
`void` | `getMembers(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
`void` | `getSharedFilesList(BMXGroup group, boolean forceRefresh, <any> callBack)` 获取群共享文件列表
`void` | `join(BMXGroup group, java.lang.String message, BMXCallBack callBack)` 加入一个群，根据群设置可能需要管理员批准
`void` | `leave(BMXGroup group, BMXCallBack callBack)` 退出群
`void` | `muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode, BMXCallBack callBack)` 设置是否屏蔽群消息
`void` | `removeAdmins(BMXGroup group, ListOfLongLong admins, java.lang.String reason, BMXCallBack callBack)` 删除管理员
`void` | `removeGroupListener(BMXGroupServiceListener listener)` 移除群组变化监听者
`void` | `removeMembers(BMXGroup group, ListOfLongLong members, java.lang.String reason, BMXCallBack callBack)` 删除群成员
`void` | `removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, BMXCallBack callBack)` 移除群共享文件
`void` | `setAvatar(BMXGroup group, java.lang.String avatarPath, FileProgressListener listener, BMXCallBack callBack)` 设置群头像
`void` | `setDescription(BMXGroup group, java.lang.String description, BMXCallBack callBack)` 设置群描述信息
`void` | `setEnableReadAck(BMXGroup group, boolean enable, BMXCallBack callBack)` 设置是否开启群消息已读功能
`void` | `setExtension(BMXGroup group, java.lang.String extension, BMXCallBack callBack)` 设置群扩展信息
`void` | `setInviteMode(BMXGroup group, BMXGroup.InviteMode mode, BMXCallBack callBack)` 设置邀请模式
`void` | `setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode, BMXCallBack callBack)` 设置入群审批模式
`void` | `setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode, BMXCallBack callBack)` 设置群消息通知模式
`void` | `setMyNickname(BMXGroup group, java.lang.String nickname, BMXCallBack callBack)` 设置在群里的昵称
`void` | `setName(BMXGroup group, java.lang.String name, BMXCallBack callBack)` 设置群名称
`void` | `transferOwner(BMXGroup group, long newOwnerId, BMXCallBack callBack)` 转移群主
`void` | `unbanMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 解除禁言
`void` | `unblockMembers(BMXGroup group, ListOfLongLong members, BMXCallBack callBack)` 从黑名单删除
`void` | `uploadSharedFile(BMXGroup group, java.lang.String filePath, java.lang.String displayName, java.lang.String extensionName, FileProgressListener listener, BMXCallBack callBack)` 添加群共享文件
* ### 从类继承的方法 java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait`
* * ### 构造器详细资料
* #### BMXGroupManager
public BMXGroupManager(BMXGroupService service)
* ### 方法详细资料
* #### getGroupList
public void getGroupList(boolean forceRefresh,
<any> callBack)
获取群组列表，如果设置了forceRefresh则从服务器拉取
参数:
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群组id列表
* #### getGroupList
public void getGroupList(ListOfLongLong groupIdList,
boolean forceRefresh,
<any> callBack)
获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
参数:
`groupIdList` \- 群组id列表
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群组详细信息列表
* #### getGroupList
public void getGroupList(long groupId,
boolean forceUpdate,
<any> callBack)
获取群信息，如果设置了forceRefresh则从服务器拉取
参数:
`groupId` \- 要搜索的群组id
`forceUpdate` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,搜索返回的群组信息
* #### getInvitationList
public void getInvitationList(java.lang.String cursor,
int pageSize,
<any> callBack)
分页获取群组邀请列表
参数:
`cursor` \- 分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
`pageSize` \- 分页大小
`callBack` \- BMXErrorCode,分页获取的群组邀请列表
* #### getApplicationList
public void getApplicationList(BMXGroupList list,
java.lang.String cursor,
int pageSize,
<any> callBack)
分页获取群组申请列表
参数:
`list` \- 需要获取群组申请列表信息的群组id列表
`cursor` \- 分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
`pageSize` \- 分页大小
`callBack` \- BMXErrorCode,分页获取的群组申请列表
* #### create
public void create(BMXGroupService.CreateGroupOptions options,
<any> callBack)
创建群
参数:
`options` \- 创建群组时传入的参数选项
`callBack` \- BMXErrorCode,创建好的群
* #### destroy
public void destroy(BMXGroup group,
BMXCallBack callBack)
销毁群
参数:
`callBack` \- BMXErrorCode，要销毁的群组
* #### join
public void join(BMXGroup group,
java.lang.String message,
BMXCallBack callBack)
加入一个群，根据群设置可能需要管理员批准
参数:
`group` \- 要加入的群组
`message` \- 申请入群的信息
`callBack` \- BMXErrorCode
* #### leave
public void leave(BMXGroup group,
BMXCallBack callBack)
退出群
参数:
`group` \- 要退出的群组
`callBack` \- BMXErrorCode
* #### getInfo
public void getInfo(BMXGroup group,
<any> callBack)
获取群详情，从服务端拉取最新信息
参数:
`callBack` \- BMXErrorCode,要获取群组最新信息的群组
* #### getMembers
public void getMembers(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群成员列表
* #### addMembers
public void addMembers(BMXGroup group,
ListOfLongLong members,
java.lang.String message,
BMXCallBack callBack)
添加群成员
参数:
`group` \- 进行操作的群组
`members` \- 要添加进群的成员id列表
`message` \- 添加成员原因信息
`callBack` \- BMXErrorCode
* #### removeMembers
public void removeMembers(BMXGroup group,
ListOfLongLong members,
java.lang.String reason,
BMXCallBack callBack)
删除群成员
参数:
`group` \- 进行操作的群组
`members` \- 要删除的群组成员id列表
`reason` \- 删除的原因
`callBack` \- BMXErrorCode
* #### addAdmins
public void addAdmins(BMXGroup group,
ListOfLongLong admins,
java.lang.String message,
BMXCallBack callBack)
添加管理员
参数:
`group` \- 进行操作的群组
`admins` \- 要添加为管理员的成员id列表
`message` \- 添加为管理员的原因
`callBack` \- BMXErrorCode
* #### removeAdmins
public void removeAdmins(BMXGroup group,
ListOfLongLong admins,
java.lang.String reason,
BMXCallBack callBack)
删除管理员
参数:
`group` \- 进行操作的群组
`admins` \- 要从管理员移除的成员id列表
`reason` \- 要移除管理员的原因
`callBack` \- BMXErrorCode
* #### getAdmins
public void getAdmins(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取Admins列表，如果设置了forceRefresh则从服务器拉取
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群管理员列表
* #### blockMembers
public void blockMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
添加黑名单
参数:
`group` \- 进行操作的群组
`members` \- 要加入黑名单的群成员id列表
`callBack` \- BMXErrorCode
* #### unblockMembers
public void unblockMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
从黑名单删除
参数:
`group` \- 进行操作的群组
`members` \- 从黑名单移除的用户id列表
`callBack` \- BMXErrorCode
* #### getBlockList
public void getBlockList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取黑名单
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode,群黑名单列表
* #### banMembers
public void banMembers(BMXGroup group,
ListOfLongLong members,
long duration,
java.lang.String reason,
BMXCallBack callBack)
禁言
参数:
`group` \- 进行操作的群组
`members` \- 被禁言的群成员id列表
`duration` \- 禁言时长
`reason` \- 禁言原因
`callBack` \- BMXErrorCode
* #### unbanMembers
public void unbanMembers(BMXGroup group,
ListOfLongLong members,
BMXCallBack callBack)
解除禁言
参数:
`group` \- 进行操作的群组
`members` \- 被解除禁言的群成员id列表
`callBack` \- BMXErrorCode
* #### getBannedMembers
public void getBannedMembers(BMXGroup group,
<any> callBack)
获取禁言列表
参数:
`group` \- 进行操作的群组
`callBack` \- BMXErrorCode 群禁言列表
* #### muteMessage
public void muteMessage(BMXGroup group,
BMXGroup.MsgMuteMode mode,
BMXCallBack callBack)
设置是否屏蔽群消息
参数:
`group` \- 进行操作的群组
`mode` \- 群屏蔽的模式
`callBack` \- BMXErrorCode
* #### acceptApplication
public void acceptApplication(BMXGroup group,
long applicantId,
BMXCallBack callBack)
接受入群申请
参数:
`group` \- 进行操作的群组
`applicantId` \- 申请进群的用户id
`callBack` \- BMXErrorCode
* #### declineApplication
public void declineApplication(BMXGroup group,
long applicantId,
java.lang.String reason,
BMXCallBack callBack)
拒绝入群申请
参数:
`group` \- 进行操作的群组
`applicantId` \- 申请进群的用户id
`reason` \- 拒绝的原因
`callBack` \- BMXErrorCode
* #### acceptInvitation
public void acceptInvitation(BMXGroup group,
long inviter,
BMXCallBack callBack)
接受入群邀请
参数:
`group` \- 进行操作的群组
`inviter` \- 邀请者id
`callBack` \- BMXErrorCode
* #### declineInvitation
public void declineInvitation(BMXGroup group,
long inviter,
BMXCallBack callBack)
拒绝入群邀请
参数:
`group` \- 进行操作的群组
`inviter` \- 邀请者id
`callBack` \- BMXErrorCode
* #### transferOwner
public void transferOwner(BMXGroup group,
long newOwnerId,
BMXCallBack callBack)
转移群主
参数:
`group` \- 进行操作的群组
`newOwnerId` \- 转让为新群主的用户id
`callBack` \- BMXErrorCode
* #### uploadSharedFile
public void uploadSharedFile(BMXGroup group,
java.lang.String filePath,
java.lang.String displayName,
java.lang.String extensionName,
FileProgressListener listener,
BMXCallBack callBack)
添加群共享文件
参数:
`group` \- 进行操作的群组
`filePath` \- 文件的本地路径
`displayName` \- 文件的展示名
`extensionName` \- 文件的扩展名
`listener` \- 上传回调函数
`callBack` \- BMXErrorCode
* #### removeSharedFile
public void removeSharedFile(BMXGroup group,
BMXGroup.SharedFile sharedFile,
BMXCallBack callBack)
移除群共享文件
参数:
`group` \- 进行操作的群组
`sharedFile` \- 删除的群共享文件
`callBack` \- BMXErrorCode
* #### downloadSharedFile
public void downloadSharedFile(BMXGroup group,
BMXGroup.SharedFile sharedFile,
FileProgressListener listener,
BMXCallBack callBack)
下载群共享文件
参数:
`group` \- 进行操作的群组
`sharedFile` \- 下载的群共享文件
`listener` \- 下载回调函数
`callBack` \- BMXErrorCode
* #### getSharedFilesList
public void getSharedFilesList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群共享文件列表
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode 群共享文件列表
* #### changeSharedFileName
public void changeSharedFileName(BMXGroup group,
BMXGroup.SharedFile sharedFile,
java.lang.String name,
BMXCallBack callBack)
修改群共享文件名称
参数:
`group` \- 进行操作的群组
`sharedFile` \- 进行更改的群共享文件
`name` \- 修改的群共享文件名称
`callBack` \- BMXErrorCode
* #### getLatestAnnouncement
public void getLatestAnnouncement(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取最新的群公告
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode 最新的群组公告
* #### getAnnouncementList
public void getAnnouncementList(BMXGroup group,
boolean forceRefresh,
<any> callBack)
获取群公告列表
参数:
`group` \- 进行操作的群组
`forceRefresh` \- 设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
`callBack` \- BMXErrorCode, 群公告列表
* #### editAnnouncement
public void editAnnouncement(BMXGroup group,
java.lang.String title,
java.lang.String content,
BMXCallBack callBack)
设置群公告
参数:
`group` \- 进行操作的群组
`title` \- 群公告的标题
`content` \- 群公告的内容
`callBack` \- BMXErrorCode
* #### deleteAnnouncement
public void deleteAnnouncement(BMXGroup group,
long announcementId,
BMXCallBack callBack)
删除群公告
参数:
`group` \- 进行操作的群组
`announcementId` \- 删除的群公告id
`callBack` \- BMXErrorCode
* #### setName
public void setName(BMXGroup group,
java.lang.String name,
BMXCallBack callBack)
设置群名称
参数:
`group` \- 进行操作的群组
`name` \- 群组名称
`callBack` \- BMXErrorCode
* #### setDescription
public void setDescription(BMXGroup group,
java.lang.String description,
BMXCallBack callBack)
设置群描述信息
参数:
`group` \- 进行操作的群组
`description` \- 群组描述
`callBack` \- BMXErrorCode
* #### setExtension
public void setExtension(BMXGroup group,
java.lang.String extension,
BMXCallBack callBack)
设置群扩展信息
参数:
`group` \- 进行操作的群组
`extension` \- 群组的扩展信息
`callBack` \- BMXErrorCode
* #### setMyNickname
public void setMyNickname(BMXGroup group,
java.lang.String nickname,
BMXCallBack callBack)
设置在群里的昵称
参数:
`group` \- 进行操作的群组
`nickname` \- 用户在群组内的昵称
`callBack` \- BMXErrorCode
* #### setMsgPushMode
public void setMsgPushMode(BMXGroup group,
BMXGroup.MsgPushMode mode,
BMXCallBack callBack)
设置群消息通知模式
参数:
`group` \- 进行操作的群组
`mode` \- 群消息通知模式
`callBack` \- BMXErrorCode
* #### setJoinAuthMode
public void setJoinAuthMode(BMXGroup group,
BMXGroup.JoinAuthMode mode,
BMXCallBack callBack)
设置入群审批模式
参数:
`group` \- 进行操作的群组
`mode` \- 入群审批模式
`callBack` \- BMXErrorCode
* #### setInviteMode
public void setInviteMode(BMXGroup group,
BMXGroup.InviteMode mode,
BMXCallBack callBack)
设置邀请模式
参数:
`group` \- 进行操作的群组
`mode` \- 群组的邀请模式
`callBack` \- BMXErrorCode
* #### setAvatar
public void setAvatar(BMXGroup group,
java.lang.String avatarPath,
FileProgressListener listener,
BMXCallBack callBack)
设置群头像
参数:
`group` \- 进行操作的群组
`avatarPath` \- 群头像文件的本地路径
`listener` \- 上传回调函数
`callBack` \- BMXErrorCode
* #### downloadAvatar
public void downloadAvatar(BMXGroup group,
FileProgressListener listener,
BMXCallBack callBack)
下载群头像
参数:
`group` \- 进行操作的群组
`listener` \- 下载回调函数
`callBack` \- BMXErrorCode
* #### addGroupListener
public void addGroupListener(BMXGroupServiceListener listener)
添加群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### removeGroupListener
public void removeGroupListener(BMXGroupServiceListener listener)
移除群组变化监听者
参数:
`listener` \- 群组变化监听者
* #### setEnableReadAck
public void setEnableReadAck(BMXGroup group,
boolean enable,
BMXCallBack callBack)
设置是否开启群消息已读功能
参数:
`group` \- 进行操作的群组
`enable` \- 是否开启
`callBack` \- BMXErrorCode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,706 |
BMXGroupService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupService
# BMXGroupService
最近更新时间: 2022-07-22 22:41:28
class im.floo.floolib.BMXGroupService
群组Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* get
* search
* fetchGroupsByIdList
* search
* fetchGroupById
* search
* fetchLocalGroupsByName
* search
* create
* destroy
* join
* leave
* getInfo
* getMembersNickname
* getInvitationList
* getApplicationList
* getMembers
* getMembers
* addMembers
* removeMembers
* addAdmins
* removeAdmins
* getAdmins
* blockMembers
* unblockMembers
* getBlockList
* getBlockList
* banMembers
* banMembers
* banGroup
* unbanMembers
* unbanGroup
* getBannedMembers
* getBannedMembers
* muteMessage
* acceptApplication
* declineApplication
* declineApplication
* acceptInvitation
* declineInvitation
* declineInvitation
* transferOwner
* uploadSharedFile
* cancelUploadSharedFile
* removeSharedFile
* downloadSharedFile
* cancelDownloadSharedFile
* getSharedFilesList
* changeSharedFileName
* getLatestAnnouncement
* getAnnouncementList
* editAnnouncement
* deleteAnnouncement
* setName
* setDescription
* setExtension
* setMyNickname
* setMsgPushMode
* setJoinAuthMode
* setInviteMode
* setAllowMemberModify
* setEnableReadAck
* setHistoryVisible
* setAvatar
* downloadAvatar
* addGroupListener
* removeGroupListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXGroupService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
get
* public BMXErrorCode get(BMXGroupList list, boolean forceRefresh);
* 获取群组列表，如果设置了forceRefresh则从服务器拉取
Parameters
* list: BMXGroupList
群组id列表，传入空列表函数返回后从此处获取返回的群组id列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(BMXGroupList list, boolean forceRefresh);
* 获取群组列表，如果设置了forceRefresh则从服务器拉取
Parameters
* list: BMXGroupList
群组id列表，传入空列表函数返回后从此处获取返回的群组id列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchGroupsByIdList
* public BMXErrorCode fetchGroupsByIdList(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh);
* 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
Parameters
* groupIdList: ListOfLongLong
群组id列表
* list: BMXGroupList
群组详细信息列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh);
* 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
Parameters
* groupIdList: ListOfLongLong
群组id列表
* list: BMXGroupList
群组详细信息列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchGroupById
* public BMXErrorCode fetchGroupById(long groupId, BMXGroup group, boolean forceRefresh);
* 获取群信息，如果设置了forceRefresh则从服务器拉取
Parameters
* groupId: long
要搜索的群组id
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
搜索返回的群组信息，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(long groupId, BMXGroup group, boolean forceUpdate);
* 获取群信息，如果设置了forceRefresh则从服务器拉取
Parameters
* groupId: long
要搜索的群组id
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
搜索返回的群组信息，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
* forceUpdate: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchLocalGroupsByName
* public BMXErrorCode fetchLocalGroupsByName(BMXGroupList list, String name);
* 通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
Parameters
* list: BMXGroupList
搜索结果返回的群列表信息
* name: String
查询的群名称关键字
Returns BMXErrorCode
search
* public BMXErrorCode search(BMXGroupList list, String name);
* 通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
Parameters
* list: BMXGroupList
搜索结果返回的群列表信息
* name: String
查询的群名称关键字
Returns BMXErrorCode
create
* public BMXErrorCode create(BMXGroupService.CreateGroupOptions options, BMXGroup group);
* 创建群
Parameters
* options: CreateGroupOptions
创建群组时传入的参数选项
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
创建好的群，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
Returns BMXErrorCode
destroy
* public BMXErrorCode destroy(BMXGroup group);
* 销毁群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要销毁的群组
Returns BMXErrorCode
join
* public BMXErrorCode join(BMXGroup group, String message);
* 加入一个群，根据群设置可能需要管理员批准
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要加入的群组
* message: String
申请入群的信息
Returns BMXErrorCode
leave
* public BMXErrorCode leave(BMXGroup group);
* 退出群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要退出的群组
Returns BMXErrorCode
getInfo
* public BMXErrorCode getInfo(BMXGroup group);
* 获取群详情，从服务端拉取最新信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要获取群组最新信息的群组
Returns BMXErrorCode
getMembersNickname
* public BMXErrorCode getMembersNickname(BMXGroup group, ListOfLongLong members, BMXGroupMemberList list);
* 获取群组成员详细信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要获取群组成员信息详情的群成员id
* list: BMXGroupMemberList
返回的群成员详细，传入空列表在函数操作后从此处获取群成员详细信息列表
Returns BMXErrorCode
getInvitationList
* public BMXErrorCode getInvitationList(GroupInvitaionPage result, String cursor, int pageSize);
* 分页获取群组邀请列表
Parameters
* result: GroupInvitaionPage
分页获取的群组邀请列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getApplicationList
* public BMXErrorCode getApplicationList(BMXGroupList list, GroupApplicationPage result, String cursor, int pageSize);
* 分页获取群组申请列表
Parameters
* list: BMXGroupList
需要获取群组申请列表信息的群组id列表
* result: GroupApplicationPage
分页获取的群组申请列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 分页获取群成员列表，如果设置了forceRefresh则从服务器拉取，单页最大数量为500.
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupMemberResultPage
分页获取的群成员列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群成员列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
addMembers
* public BMXErrorCode addMembers(BMXGroup group, ListOfLongLong members, String message);
* 添加群成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要添加进群的成员id列表
* message: String
添加成员原因信息
Returns BMXErrorCode
removeMembers
* public BMXErrorCode removeMembers(BMXGroup group, ListOfLongLong members, String reason);
* 删除群成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要删除的群组成员id列表
* reason: String
删除的原因
Returns BMXErrorCode
addAdmins
* public BMXErrorCode addAdmins(BMXGroup group, ListOfLongLong admins, String message);
* 添加管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* admins: ListOfLongLong
要添加为管理员的成员id列表
* message: String
添加为管理员的原因
Returns BMXErrorCode
removeAdmins
* public BMXErrorCode removeAdmins(BMXGroup group, ListOfLongLong admins, String reason);
* 删除管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* admins: ListOfLongLong
要从管理员移除的成员id列表
* reason: String
要移除管理员的原因
Returns BMXErrorCode
getAdmins
* public BMXErrorCode getAdmins(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取Admins列表，如果设置了forceRefresh则从服务器拉取
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群管理员列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
blockMembers
* public BMXErrorCode blockMembers(BMXGroup group, ListOfLongLong members);
* 添加黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要加入黑名单的群成员id列表
Returns BMXErrorCode
unblockMembers
* public BMXErrorCode unblockMembers(BMXGroup group, ListOfLongLong members);
* 从黑名单删除
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
从黑名单移除的用户id列表
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 分页获取黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupMemberResultPage
分页获取的黑名单列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群黑名单列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
banMembers
* public BMXErrorCode banMembers(BMXGroup group, ListOfLongLong members, long duration, String reason);
* 禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
被禁言的群成员id列表
* duration: long
禁言时长
* reason: String
禁言原因
Returns BMXErrorCode
banMembers
* public BMXErrorCode banMembers(BMXGroup group, ListOfLongLong members, long duration);
* Returns BMXErrorCode
banGroup
* public BMXErrorCode banGroup(BMXGroup group, long duration);
* Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* duration: long
禁言时长(分钟)
Returns BMXErrorCode
unbanMembers
* public BMXErrorCode unbanMembers(BMXGroup group, ListOfLongLong members);
* 解除禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
被解除禁言的群成员id列表
Returns BMXErrorCode
unbanGroup
* public BMXErrorCode unbanGroup(BMXGroup group);
* Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
Returns BMXErrorCode
getBannedMembers
* public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberResultPage result, String cursor, int pageSize);
* 分页获取禁言列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupBannedMemberResultPage
分页获取的禁言列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getBannedMembers
* public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberList list);
* 获取禁言列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupBannedMemberList
群禁言列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
Returns BMXErrorCode
muteMessage
* public BMXErrorCode muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode);
* 设置是否屏蔽群消息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: MsgMuteMode
群屏蔽的模式
Returns BMXErrorCode
acceptApplication
* public BMXErrorCode acceptApplication(BMXGroup group, long applicantId);
* 接受入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* applicantId: long
申请进群的用户id
Returns BMXErrorCode
declineApplication
* public BMXErrorCode declineApplication(BMXGroup group, long applicantId, String reason);
* 拒绝入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* applicantId: long
申请进群的用户id
* reason: String
拒绝的原因
Returns BMXErrorCode
declineApplication
* public BMXErrorCode declineApplication(BMXGroup group, long applicantId);
* Returns BMXErrorCode
acceptInvitation
* public BMXErrorCode acceptInvitation(BMXGroup group, long inviter);
* 接受入群邀请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* inviter: long
邀请者id
Returns BMXErrorCode
declineInvitation
* public BMXErrorCode declineInvitation(BMXGroup group, long inviter, String reason);
* 拒绝入群邀请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* inviter: long
邀请者id
* reason: String
拒绝的原因
Returns BMXErrorCode
declineInvitation
* public BMXErrorCode declineInvitation(BMXGroup group, long inviter);
* Returns BMXErrorCode
transferOwner
* public BMXErrorCode transferOwner(BMXGroup group, long newOwnerId);
* 转移群主
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* newOwnerId: long
转让为新群主的用户id
Returns BMXErrorCode
uploadSharedFile
* public BMXErrorCode uploadSharedFile(BMXGroup group, String filePath, String displayName, String extensionName, FileProgressListener arg4);
* 添加群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* filePath: String
文件的本地路径
* displayName: String
文件的展示名
* extensionName: String
文件的扩展名
* arg4: FileProgressListener
上传回调函数
Returns BMXErrorCode
cancelUploadSharedFile
* public BMXErrorCode cancelUploadSharedFile(BMXGroup group, String filePath);
* 取消上传群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* filePath: String
文件的本地路径
Returns BMXErrorCode
removeSharedFile
* public BMXErrorCode removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 移除群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
删除的群共享文件
Returns BMXErrorCode
downloadSharedFile
* public BMXErrorCode downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, FileProgressListener arg2);
* 下载群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
下载的群共享文件
* arg2: FileProgressListener
下载回调函数
Returns BMXErrorCode
cancelDownloadSharedFile
* public BMXErrorCode cancelDownloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 取消下载群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
下载的群共享文件
Returns BMXErrorCode
getSharedFilesList
* public BMXErrorCode getSharedFilesList(BMXGroup group, BMXGroupSharedFileList list, boolean forceRefresh);
* 获取群共享文件列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupSharedFileList
群共享文件列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
changeSharedFileName
* public BMXErrorCode changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, String name);
* 修改群共享文件名称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
进行更改的群共享文件
* name: String
修改的群共享文件名称
Returns BMXErrorCode
getLatestAnnouncement
* public BMXErrorCode getLatestAnnouncement(BMXGroup group, BMXGroup.Announcement announcement, boolean forceRefresh);
* 获取最新的群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* announcement: Announcement
最新的群组公告，传入指向为空的shared_ptr对象函数返回后从此处获取最新的群组公告
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
getAnnouncementList
* public BMXErrorCode getAnnouncementList(BMXGroup group, BMXGroupAnnouncementList list, boolean forceRefresh);
* 获取群公告列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupAnnouncementList
群公告列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
editAnnouncement
* public BMXErrorCode editAnnouncement(BMXGroup group, String title, String content);
* 设置群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* title: String
群公告的标题
* content: String
群公告的内容
Returns BMXErrorCode
deleteAnnouncement
* public BMXErrorCode deleteAnnouncement(BMXGroup group, long announcementId);
* 删除群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* announcementId: long
删除的群公告id
Returns BMXErrorCode
setName
* public BMXErrorCode setName(BMXGroup group, String name);
* 设置群名称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* name: String
群组名称
Returns BMXErrorCode
setDescription
* public BMXErrorCode setDescription(BMXGroup group, String description);
* 设置群描述信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* description: String
群组描述
Returns BMXErrorCode
setExtension
* public BMXErrorCode setExtension(BMXGroup group, String extension);
* 设置群扩展信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* extension: String
群组的扩展信息
Returns BMXErrorCode
setMyNickname
* public BMXErrorCode setMyNickname(BMXGroup group, String nickname);
* 设置在群里的昵称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* nickname: String
用户在群组内的昵称
Returns BMXErrorCode
setMsgPushMode
* public BMXErrorCode setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode);
* 设置群消息通知模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: MsgPushMode
群消息通知模式
Returns BMXErrorCode
setJoinAuthMode
* public BMXErrorCode setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode);
* 设置入群审批模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: JoinAuthMode
入群审批模式
Returns BMXErrorCode
setInviteMode
* public BMXErrorCode setInviteMode(BMXGroup group, BMXGroup.InviteMode mode);
* 设置邀请模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: InviteMode
群组的邀请模式
Returns BMXErrorCode
setAllowMemberModify
* public BMXErrorCode setAllowMemberModify(BMXGroup group, boolean enable);
* 设置是否允许群成员设置群信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否允许操作
Returns BMXErrorCode
setEnableReadAck
* public BMXErrorCode setEnableReadAck(BMXGroup group, boolean enable);
* 设置是否开启群消息已读功能
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否开启
Returns BMXErrorCode
setHistoryVisible
* public BMXErrorCode setHistoryVisible(BMXGroup group, boolean enable);
* 设置群成员是否开可见群历史聊天记录
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否开启
Returns BMXErrorCode
setAvatar
* public BMXErrorCode setAvatar(BMXGroup group, String avatarPath, FileProgressListener arg2);
* 设置群头像
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* avatarPath: String
群头像文件的本地路径
* arg2: FileProgressListener
上传回调函数
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXGroup group, boolean thumbnail, FileProgressListener arg2);
* 下载群头像
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* thumbnail: boolean
设置为true下载缩略图，false下载原图
* arg2: FileProgressListener
下载回调函数
Returns BMXErrorCode
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupService
# BMXGroupService
最近更新时间: 2022-07-22 22:41:28
class im.floo.floolib.BMXGroupService
群组Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* get
* search
* fetchGroupsByIdList
* search
* fetchGroupById
* search
* fetchLocalGroupsByName
* search
* create
* destroy
* join
* leave
* getInfo
* getMembersNickname
* getInvitationList
* getApplicationList
* getMembers
* getMembers
* addMembers
* removeMembers
* addAdmins
* removeAdmins
* getAdmins
* blockMembers
* unblockMembers
* getBlockList
* getBlockList
* banMembers
* banMembers
* banGroup
* unbanMembers
* unbanGroup
* getBannedMembers
* getBannedMembers
* muteMessage
* acceptApplication
* declineApplication
* declineApplication
* acceptInvitation
* declineInvitation
* declineInvitation
* transferOwner
* uploadSharedFile
* cancelUploadSharedFile
* removeSharedFile
* downloadSharedFile
* cancelDownloadSharedFile
* getSharedFilesList
* changeSharedFileName
* getLatestAnnouncement
* getAnnouncementList
* editAnnouncement
* deleteAnnouncement
* setName
* setDescription
* setExtension
* setMyNickname
* setMsgPushMode
* setJoinAuthMode
* setInviteMode
* setAllowMemberModify
* setEnableReadAck
* setHistoryVisible
* setAvatar
* downloadAvatar
* addGroupListener
* removeGroupListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXGroupService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
get
* public BMXErrorCode get(BMXGroupList list, boolean forceRefresh);
* 获取群组列表，如果设置了forceRefresh则从服务器拉取
Parameters
* list: BMXGroupList
群组id列表，传入空列表函数返回后从此处获取返回的群组id列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(BMXGroupList list, boolean forceRefresh);
* 获取群组列表，如果设置了forceRefresh则从服务器拉取
Parameters
* list: BMXGroupList
群组id列表，传入空列表函数返回后从此处获取返回的群组id列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchGroupsByIdList
* public BMXErrorCode fetchGroupsByIdList(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh);
* 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
Parameters
* groupIdList: ListOfLongLong
群组id列表
* list: BMXGroupList
群组详细信息列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh);
* 获取传入群组id的群组信息列表，如果设置了forceRefresh则从服务器拉取
Parameters
* groupIdList: ListOfLongLong
群组id列表
* list: BMXGroupList
群组详细信息列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchGroupById
* public BMXErrorCode fetchGroupById(long groupId, BMXGroup group, boolean forceRefresh);
* 获取群信息，如果设置了forceRefresh则从服务器拉取
Parameters
* groupId: long
要搜索的群组id
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
搜索返回的群组信息，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(long groupId, BMXGroup group, boolean forceUpdate);
* 获取群信息，如果设置了forceRefresh则从服务器拉取
Parameters
* groupId: long
要搜索的群组id
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
搜索返回的群组信息，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
* forceUpdate: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
fetchLocalGroupsByName
* public BMXErrorCode fetchLocalGroupsByName(BMXGroupList list, String name);
* 通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
Parameters
* list: BMXGroupList
搜索结果返回的群列表信息
* name: String
查询的群名称关键字
Returns BMXErrorCode
search
* public BMXErrorCode search(BMXGroupList list, String name);
* 通过群名称查询本地群信息，从本地数据库中通过群名称查询获取群组
Parameters
* list: BMXGroupList
搜索结果返回的群列表信息
* name: String
查询的群名称关键字
Returns BMXErrorCode
create
* public BMXErrorCode create(BMXGroupService.CreateGroupOptions options, BMXGroup group);
* 创建群
Parameters
* options: CreateGroupOptions
创建群组时传入的参数选项
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
创建好的群，传入指向为空的shared_ptr对象函数执行后从此获取返回结果
Returns BMXErrorCode
destroy
* public BMXErrorCode destroy(BMXGroup group);
* 销毁群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要销毁的群组
Returns BMXErrorCode
join
* public BMXErrorCode join(BMXGroup group, String message);
* 加入一个群，根据群设置可能需要管理员批准
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要加入的群组
* message: String
申请入群的信息
Returns BMXErrorCode
leave
* public BMXErrorCode leave(BMXGroup group);
* 退出群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要退出的群组
Returns BMXErrorCode
getInfo
* public BMXErrorCode getInfo(BMXGroup group);
* 获取群详情，从服务端拉取最新信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
要获取群组最新信息的群组
Returns BMXErrorCode
getMembersNickname
* public BMXErrorCode getMembersNickname(BMXGroup group, ListOfLongLong members, BMXGroupMemberList list);
* 获取群组成员详细信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要获取群组成员信息详情的群成员id
* list: BMXGroupMemberList
返回的群成员详细，传入空列表在函数操作后从此处获取群成员详细信息列表
Returns BMXErrorCode
getInvitationList
* public BMXErrorCode getInvitationList(GroupInvitaionPage result, String cursor, int pageSize);
* 分页获取群组邀请列表
Parameters
* result: GroupInvitaionPage
分页获取的群组邀请列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getApplicationList
* public BMXErrorCode getApplicationList(BMXGroupList list, GroupApplicationPage result, String cursor, int pageSize);
* 分页获取群组申请列表
Parameters
* list: BMXGroupList
需要获取群组申请列表信息的群组id列表
* result: GroupApplicationPage
分页获取的群组申请列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 分页获取群成员列表，如果设置了forceRefresh则从服务器拉取，单页最大数量为500.
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupMemberResultPage
分页获取的群成员列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getMembers
* public BMXErrorCode getMembers(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取群成员列表，如果设置了forceRefresh则从服务器拉取，最多拉取1000人
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群成员列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
addMembers
* public BMXErrorCode addMembers(BMXGroup group, ListOfLongLong members, String message);
* 添加群成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要添加进群的成员id列表
* message: String
添加成员原因信息
Returns BMXErrorCode
removeMembers
* public BMXErrorCode removeMembers(BMXGroup group, ListOfLongLong members, String reason);
* 删除群成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要删除的群组成员id列表
* reason: String
删除的原因
Returns BMXErrorCode
addAdmins
* public BMXErrorCode addAdmins(BMXGroup group, ListOfLongLong admins, String message);
* 添加管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* admins: ListOfLongLong
要添加为管理员的成员id列表
* message: String
添加为管理员的原因
Returns BMXErrorCode
removeAdmins
* public BMXErrorCode removeAdmins(BMXGroup group, ListOfLongLong admins, String reason);
* 删除管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* admins: ListOfLongLong
要从管理员移除的成员id列表
* reason: String
要移除管理员的原因
Returns BMXErrorCode
getAdmins
* public BMXErrorCode getAdmins(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取Admins列表，如果设置了forceRefresh则从服务器拉取
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群管理员列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
blockMembers
* public BMXErrorCode blockMembers(BMXGroup group, ListOfLongLong members);
* 添加黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
要加入黑名单的群成员id列表
Returns BMXErrorCode
unblockMembers
* public BMXErrorCode unblockMembers(BMXGroup group, ListOfLongLong members);
* 从黑名单删除
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
从黑名单移除的用户id列表
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);
* 分页获取黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupMemberResultPage
分页获取的黑名单列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh);
* 获取黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupMemberList
群黑名单列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
banMembers
* public BMXErrorCode banMembers(BMXGroup group, ListOfLongLong members, long duration, String reason);
* 禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
被禁言的群成员id列表
* duration: long
禁言时长
* reason: String
禁言原因
Returns BMXErrorCode
banMembers
* public BMXErrorCode banMembers(BMXGroup group, ListOfLongLong members, long duration);
* Returns BMXErrorCode
banGroup
* public BMXErrorCode banGroup(BMXGroup group, long duration);
* Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* duration: long
禁言时长(分钟)
Returns BMXErrorCode
unbanMembers
* public BMXErrorCode unbanMembers(BMXGroup group, ListOfLongLong members);
* 解除禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* members: ListOfLongLong
被解除禁言的群成员id列表
Returns BMXErrorCode
unbanGroup
* public BMXErrorCode unbanGroup(BMXGroup group);
* Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
Returns BMXErrorCode
getBannedMembers
* public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberResultPage result, String cursor, int pageSize);
* 分页获取禁言列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* result: BMXGroupBannedMemberResultPage
分页获取的禁言列表，传入指向为空的shared_ptr对象函数执行后从此处获取结果
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
getBannedMembers
* public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberList list);
* 获取禁言列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupBannedMemberList
群禁言列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
Returns BMXErrorCode
muteMessage
* public BMXErrorCode muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode);
* 设置是否屏蔽群消息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: MsgMuteMode
群屏蔽的模式
Returns BMXErrorCode
acceptApplication
* public BMXErrorCode acceptApplication(BMXGroup group, long applicantId);
* 接受入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* applicantId: long
申请进群的用户id
Returns BMXErrorCode
declineApplication
* public BMXErrorCode declineApplication(BMXGroup group, long applicantId, String reason);
* 拒绝入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* applicantId: long
申请进群的用户id
* reason: String
拒绝的原因
Returns BMXErrorCode
declineApplication
* public BMXErrorCode declineApplication(BMXGroup group, long applicantId);
* Returns BMXErrorCode
acceptInvitation
* public BMXErrorCode acceptInvitation(BMXGroup group, long inviter);
* 接受入群邀请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* inviter: long
邀请者id
Returns BMXErrorCode
declineInvitation
* public BMXErrorCode declineInvitation(BMXGroup group, long inviter, String reason);
* 拒绝入群邀请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* inviter: long
邀请者id
* reason: String
拒绝的原因
Returns BMXErrorCode
declineInvitation
* public BMXErrorCode declineInvitation(BMXGroup group, long inviter);
* Returns BMXErrorCode
transferOwner
* public BMXErrorCode transferOwner(BMXGroup group, long newOwnerId);
* 转移群主
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* newOwnerId: long
转让为新群主的用户id
Returns BMXErrorCode
uploadSharedFile
* public BMXErrorCode uploadSharedFile(BMXGroup group, String filePath, String displayName, String extensionName, FileProgressListener arg4);
* 添加群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* filePath: String
文件的本地路径
* displayName: String
文件的展示名
* extensionName: String
文件的扩展名
* arg4: FileProgressListener
上传回调函数
Returns BMXErrorCode
cancelUploadSharedFile
* public BMXErrorCode cancelUploadSharedFile(BMXGroup group, String filePath);
* 取消上传群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* filePath: String
文件的本地路径
Returns BMXErrorCode
removeSharedFile
* public BMXErrorCode removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 移除群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
删除的群共享文件
Returns BMXErrorCode
downloadSharedFile
* public BMXErrorCode downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, FileProgressListener arg2);
* 下载群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
下载的群共享文件
* arg2: FileProgressListener
下载回调函数
Returns BMXErrorCode
cancelDownloadSharedFile
* public BMXErrorCode cancelDownloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 取消下载群共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
下载的群共享文件
Returns BMXErrorCode
getSharedFilesList
* public BMXErrorCode getSharedFilesList(BMXGroup group, BMXGroupSharedFileList list, boolean forceRefresh);
* 获取群共享文件列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupSharedFileList
群共享文件列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
changeSharedFileName
* public BMXErrorCode changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, String name);
* 修改群共享文件名称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* sharedFile: SharedFile
进行更改的群共享文件
* name: String
修改的群共享文件名称
Returns BMXErrorCode
getLatestAnnouncement
* public BMXErrorCode getLatestAnnouncement(BMXGroup group, BMXGroup.Announcement announcement, boolean forceRefresh);
* 获取最新的群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* announcement: Announcement
最新的群组公告，传入指向为空的shared_ptr对象函数返回后从此处获取最新的群组公告
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
getAnnouncementList
* public BMXErrorCode getAnnouncementList(BMXGroup group, BMXGroupAnnouncementList list, boolean forceRefresh);
* 获取群公告列表
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* list: BMXGroupAnnouncementList
群公告列表，传入空列表函数返回后从此处获取返回的群组详细信息列表
* forceRefresh: boolean
设置为true强制从服务器获取，本地获取失败的情况sdk会自动从服务器获取
Returns BMXErrorCode
editAnnouncement
* public BMXErrorCode editAnnouncement(BMXGroup group, String title, String content);
* 设置群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* title: String
群公告的标题
* content: String
群公告的内容
Returns BMXErrorCode
deleteAnnouncement
* public BMXErrorCode deleteAnnouncement(BMXGroup group, long announcementId);
* 删除群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* announcementId: long
删除的群公告id
Returns BMXErrorCode
setName
* public BMXErrorCode setName(BMXGroup group, String name);
* 设置群名称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* name: String
群组名称
Returns BMXErrorCode
setDescription
* public BMXErrorCode setDescription(BMXGroup group, String description);
* 设置群描述信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* description: String
群组描述
Returns BMXErrorCode
setExtension
* public BMXErrorCode setExtension(BMXGroup group, String extension);
* 设置群扩展信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* extension: String
群组的扩展信息
Returns BMXErrorCode
setMyNickname
* public BMXErrorCode setMyNickname(BMXGroup group, String nickname);
* 设置在群里的昵称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* nickname: String
用户在群组内的昵称
Returns BMXErrorCode
setMsgPushMode
* public BMXErrorCode setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode);
* 设置群消息通知模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: MsgPushMode
群消息通知模式
Returns BMXErrorCode
setJoinAuthMode
* public BMXErrorCode setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode);
* 设置入群审批模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: JoinAuthMode
入群审批模式
Returns BMXErrorCode
setInviteMode
* public BMXErrorCode setInviteMode(BMXGroup group, BMXGroup.InviteMode mode);
* 设置邀请模式
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* mode: InviteMode
群组的邀请模式
Returns BMXErrorCode
setAllowMemberModify
* public BMXErrorCode setAllowMemberModify(BMXGroup group, boolean enable);
* 设置是否允许群成员设置群信息
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否允许操作
Returns BMXErrorCode
setEnableReadAck
* public BMXErrorCode setEnableReadAck(BMXGroup group, boolean enable);
* 设置是否开启群消息已读功能
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否开启
Returns BMXErrorCode
setHistoryVisible
* public BMXErrorCode setHistoryVisible(BMXGroup group, boolean enable);
* 设置群成员是否开可见群历史聊天记录
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* enable: boolean
是否开启
Returns BMXErrorCode
setAvatar
* public BMXErrorCode setAvatar(BMXGroup group, String avatarPath, FileProgressListener arg2);
* 设置群头像
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* avatarPath: String
群头像文件的本地路径
* arg2: FileProgressListener
上传回调函数
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXGroup group, boolean thumbnail, FileProgressListener arg2);
* 下载群头像
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
进行操作的群组
* thumbnail: boolean
设置为true下载缩略图，false下载原图
* arg2: FileProgressListener
下载回调函数
Returns BMXErrorCode
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群组变化监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,739 |
BMXGroupService.CreateGroupOptions | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice) >
BMXGroupService.CreateGroupOptions
# BMXGroupService.CreateGroupOptions
最近更新时间: 2022-07-22 22:50:03
class im.floo.floolib.BMXGroupService.CreateGroupOptions
创建群组选项
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMName
* getMName
* setMDescription
* getMDescription
* setMIsPublic
* getMIsPublic
* setMIsChatroom
* getMIsChatroom
* setMMessage
* getMMessage
* setMMembers
* getMMembers
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(CreateGroupOptions obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMName
* public void setMName(String value);
* Returns void
getMName
* public String getMName();
* Returns String
setMDescription
* public void setMDescription(String value);
* Returns void
getMDescription
* public String getMDescription();
* Returns String
setMIsPublic
* public void setMIsPublic(boolean value);
* Returns void
getMIsPublic
* public boolean getMIsPublic();
* Returns boolean
setMIsChatroom
* public void setMIsChatroom(boolean value);
* Returns void
getMIsChatroom
* public boolean getMIsChatroom();
* Returns boolean
setMMessage
* public void setMMessage(String value);
* Returns void
getMMessage
* public String getMMessage();
* Returns String
setMMembers
* public void setMMembers(ListOfLongLong value);
* Returns void
getMMembers
* public ListOfLongLong getMMembers();
* Returns ListOfLongLong
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice) >
BMXGroupService.CreateGroupOptions
# BMXGroupService.CreateGroupOptions
最近更新时间: 2022-07-22 22:50:03
class im.floo.floolib.BMXGroupService.CreateGroupOptions
创建群组选项
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMName
* getMName
* setMDescription
* getMDescription
* setMIsPublic
* getMIsPublic
* setMIsChatroom
* getMIsChatroom
* setMMessage
* getMMessage
* setMMembers
* getMMembers
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(CreateGroupOptions obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMName
* public void setMName(String value);
* Returns void
getMName
* public String getMName();
* Returns String
setMDescription
* public void setMDescription(String value);
* Returns void
getMDescription
* public String getMDescription();
* Returns String
setMIsPublic
* public void setMIsPublic(boolean value);
* Returns void
getMIsPublic
* public boolean getMIsPublic();
* Returns boolean
setMIsChatroom
* public void setMIsChatroom(boolean value);
* Returns void
getMIsChatroom
* public boolean getMIsChatroom();
* Returns boolean
setMMessage
* public void setMMessage(String value);
* Returns void
getMMessage
* public String getMMessage();
* Returns String
setMMembers
* public void setMMembers(ListOfLongLong value);
* Returns void
getMMembers
* public ListOfLongLong getMMembers();
* Returns ListOfLongLong
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,772 |
BMXGroupServiceListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupServiceListener
# BMXGroupServiceListener
最近更新时间: 2022-07-22 22:42:52
class im.floo.floolib.BMXGroupServiceListener
群组变化监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onGroupCreate
* onGroupListUpdate
* onGroupJoined
* onGroupLeft
* onInvitated
* onInvitationAccepted
* onInvitationDeclined
* onApplied
* onApplicationAccepted
* onApplicationDeclined
* onMembersBanned
* onMembersUnbanned
* onMemberJoined
* onMemberLeft
* onAdminsAdded
* onAdminsRemoved
* onOwnerAssigned
* onGroupInfoUpdate
* onMemberChangeNickName
* onAnnouncementUpdate
* onSharedFileUploaded
* onSharedFileDeleted
* onSharedFileUpdated
* onBlockListAdded
* onBlockListRemoved
* onGroupListUpdate
* registerGroupService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXGroupServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onGroupCreate
* public void onGroupCreate(BMXGroup group);
* 多设备同步创建群组
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
新创建的群组
Returns void
onGroupListUpdate
* public void onGroupListUpdate(BMXGroupList list);
* 群列表更新了
Parameters
* list: BMXGroupList
更新的群组列表
Returns void
onGroupJoined
* public void onGroupJoined(BMXGroup group);
* 加入了某群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
加入的群组
Returns void
onGroupLeft
* public void onGroupLeft(BMXGroup group, String reason);
* 退出了某群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
退出的群组
* reason: String
退出原因
Returns void
onInvitated
* public void onInvitated(long groupId, long inviter, String message);
* 收到入群邀请
Parameters
* groupId: long
邀请进入的群组id
* inviter: long
邀请者id
* message: String
邀请原因
Returns void
onInvitationAccepted
* public void onInvitationAccepted(BMXGroup group, long inviteeId);
* 入群邀请被接受
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
邀请被同意的群组
* inviteeId: long
被邀请者id
Returns void
onInvitationDeclined
* public void onInvitationDeclined(BMXGroup group, long inviteeId, String reason);
* 入群申请被拒绝
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
邀请被拒绝的群组
* inviteeId: long
被邀请者id
* reason: String
拒绝原因
Returns void
onApplied
* public void onApplied(BMXGroup group, long applicantId, String message);
* 收到入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
收到入群申请的群组
* applicantId: long
申请者id
* message: String
申请原因
Returns void
onApplicationAccepted
* public void onApplicationAccepted(BMXGroup group, long approver);
* 入群申请被接受
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
入群申请被接受的群组
* approver: long
申请的批准者
Returns void
onApplicationDeclined
* public void onApplicationDeclined(BMXGroup group, long approver, String reason);
* 入群申请被拒绝
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
入群申请被拒绝的群组
* approver: long
申请的批准者
* reason: String
拒绝的原因
Returns void
onMembersBanned
* public void onMembersBanned(BMXGroup group, ListOfLongLong members, long duration);
* 群成员被禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群成员被禁言的群组
* members: ListOfLongLong
被禁言的群成员id列表
* duration: long
禁言时长
Returns void
onMembersUnbanned
* public void onMembersUnbanned(BMXGroup group, ListOfLongLong members);
* 群成员被解除禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群成员被解除禁言的群组
* members: ListOfLongLong
被解除禁言的群成员id列表
Returns void
onMemberJoined
* public void onMemberJoined(BMXGroup group, long memberId, long inviter);
* 加入新成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
有成员加入的群组
* memberId: long
加入成员的id
* inviter: long
邀请者id
Returns void
onMemberLeft
* public void onMemberLeft(BMXGroup group, long memberId, String reason);
* 群成员退出
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
有成员退出的群组
* memberId: long
退出的群成员id
* reason: String
退出的原因
Returns void
onAdminsAdded
* public void onAdminsAdded(BMXGroup group, ListOfLongLong members);
* 添加了新管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生添加新管理员的群组
* members: ListOfLongLong
被提升为管理员的成员列表
Returns void
onAdminsRemoved
* public void onAdminsRemoved(BMXGroup group, ListOfLongLong members, String reason);
* 移除了管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生移除管理员的群组
* members: ListOfLongLong
被移除了管理员的成员列表
* reason: String
被移除的原因
Returns void
onOwnerAssigned
* public void onOwnerAssigned(BMXGroup group);
* 成为群主
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
被转让为群主的群组
Returns void
onGroupInfoUpdate
* public void onGroupInfoUpdate(BMXGroup group, BMXGroup.UpdateInfoType type);
* 群组信息变更
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群信息发生变更的群组
* type: UpdateInfoType
发生变更的群信息类型
Returns void
onMemberChangeNickName
* public void onMemberChangeNickName(BMXGroup group, long memberId, String nickName);
* 群成员更改群内昵称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群成员变更群昵称的群组
* memberId: long
变更群昵称的群成员id
* nickName: String
变更后的群昵称
Returns void
onAnnouncementUpdate
* public void onAnnouncementUpdate(BMXGroup group, BMXGroup.Announcement announcement);
* 收到群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群公告更新的群组
* announcement: Announcement
变更后的最新的群更高
Returns void
onSharedFileUploaded
* public void onSharedFileUploaded(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 收到共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件上传的群组
* sharedFile: SharedFile
新上传的群共享文件
Returns void
onSharedFileDeleted
* public void onSharedFileDeleted(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 删除了共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件删除的群组
* sharedFile: SharedFile
被删除的群共享文件
Returns void
onSharedFileUpdated
* public void onSharedFileUpdated(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 共享文件更新文件名
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件更新的群组
* sharedFile: SharedFile
更新的群共享文件
Returns void
onBlockListAdded
* public void onBlockListAdded(BMXGroup group, ListOfLongLong members);
* 添加黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
添加黑名单的群组
* members: ListOfLongLong
添加的黑名单成员列表
Returns void
onBlockListRemoved
* public void onBlockListRemoved(BMXGroup group, ListOfLongLong members);
* 删除黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
删除黑名单的群组
* members: ListOfLongLong
删除的黑名单成员列表
Returns void
onGroupListUpdate
* public void onGroupListUpdate();
* 客户端从服务器拉取到新群组时触发，用于用户群组列表更新，从SDK调用本地获取群组即可取得全部成员信息
Returns void
registerGroupService
* public void registerGroupService(BMXGroupService service);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXGroupServiceListener
# BMXGroupServiceListener
最近更新时间: 2022-07-22 22:42:52
class im.floo.floolib.BMXGroupServiceListener
群组变化监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onGroupCreate
* onGroupListUpdate
* onGroupJoined
* onGroupLeft
* onInvitated
* onInvitationAccepted
* onInvitationDeclined
* onApplied
* onApplicationAccepted
* onApplicationDeclined
* onMembersBanned
* onMembersUnbanned
* onMemberJoined
* onMemberLeft
* onAdminsAdded
* onAdminsRemoved
* onOwnerAssigned
* onGroupInfoUpdate
* onMemberChangeNickName
* onAnnouncementUpdate
* onSharedFileUploaded
* onSharedFileDeleted
* onSharedFileUpdated
* onBlockListAdded
* onBlockListRemoved
* onGroupListUpdate
* registerGroupService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXGroupServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onGroupCreate
* public void onGroupCreate(BMXGroup group);
* 多设备同步创建群组
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
新创建的群组
Returns void
onGroupListUpdate
* public void onGroupListUpdate(BMXGroupList list);
* 群列表更新了
Parameters
* list: BMXGroupList
更新的群组列表
Returns void
onGroupJoined
* public void onGroupJoined(BMXGroup group);
* 加入了某群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
加入的群组
Returns void
onGroupLeft
* public void onGroupLeft(BMXGroup group, String reason);
* 退出了某群
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
退出的群组
* reason: String
退出原因
Returns void
onInvitated
* public void onInvitated(long groupId, long inviter, String message);
* 收到入群邀请
Parameters
* groupId: long
邀请进入的群组id
* inviter: long
邀请者id
* message: String
邀请原因
Returns void
onInvitationAccepted
* public void onInvitationAccepted(BMXGroup group, long inviteeId);
* 入群邀请被接受
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
邀请被同意的群组
* inviteeId: long
被邀请者id
Returns void
onInvitationDeclined
* public void onInvitationDeclined(BMXGroup group, long inviteeId, String reason);
* 入群申请被拒绝
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
邀请被拒绝的群组
* inviteeId: long
被邀请者id
* reason: String
拒绝原因
Returns void
onApplied
* public void onApplied(BMXGroup group, long applicantId, String message);
* 收到入群申请
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
收到入群申请的群组
* applicantId: long
申请者id
* message: String
申请原因
Returns void
onApplicationAccepted
* public void onApplicationAccepted(BMXGroup group, long approver);
* 入群申请被接受
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
入群申请被接受的群组
* approver: long
申请的批准者
Returns void
onApplicationDeclined
* public void onApplicationDeclined(BMXGroup group, long approver, String reason);
* 入群申请被拒绝
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
入群申请被拒绝的群组
* approver: long
申请的批准者
* reason: String
拒绝的原因
Returns void
onMembersBanned
* public void onMembersBanned(BMXGroup group, ListOfLongLong members, long duration);
* 群成员被禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群成员被禁言的群组
* members: ListOfLongLong
被禁言的群成员id列表
* duration: long
禁言时长
Returns void
onMembersUnbanned
* public void onMembersUnbanned(BMXGroup group, ListOfLongLong members);
* 群成员被解除禁言
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群成员被解除禁言的群组
* members: ListOfLongLong
被解除禁言的群成员id列表
Returns void
onMemberJoined
* public void onMemberJoined(BMXGroup group, long memberId, long inviter);
* 加入新成员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
有成员加入的群组
* memberId: long
加入成员的id
* inviter: long
邀请者id
Returns void
onMemberLeft
* public void onMemberLeft(BMXGroup group, long memberId, String reason);
* 群成员退出
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
有成员退出的群组
* memberId: long
退出的群成员id
* reason: String
退出的原因
Returns void
onAdminsAdded
* public void onAdminsAdded(BMXGroup group, ListOfLongLong members);
* 添加了新管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生添加新管理员的群组
* members: ListOfLongLong
被提升为管理员的成员列表
Returns void
onAdminsRemoved
* public void onAdminsRemoved(BMXGroup group, ListOfLongLong members, String reason);
* 移除了管理员
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生移除管理员的群组
* members: ListOfLongLong
被移除了管理员的成员列表
* reason: String
被移除的原因
Returns void
onOwnerAssigned
* public void onOwnerAssigned(BMXGroup group);
* 成为群主
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
被转让为群主的群组
Returns void
onGroupInfoUpdate
* public void onGroupInfoUpdate(BMXGroup group, BMXGroup.UpdateInfoType type);
* 群组信息变更
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
群信息发生变更的群组
* type: UpdateInfoType
发生变更的群信息类型
Returns void
onMemberChangeNickName
* public void onMemberChangeNickName(BMXGroup group, long memberId, String nickName);
* 群成员更改群内昵称
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群成员变更群昵称的群组
* memberId: long
变更群昵称的群成员id
* nickName: String
变更后的群昵称
Returns void
onAnnouncementUpdate
* public void onAnnouncementUpdate(BMXGroup group, BMXGroup.Announcement announcement);
* 收到群公告
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群公告更新的群组
* announcement: Announcement
变更后的最新的群更高
Returns void
onSharedFileUploaded
* public void onSharedFileUploaded(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 收到共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件上传的群组
* sharedFile: SharedFile
新上传的群共享文件
Returns void
onSharedFileDeleted
* public void onSharedFileDeleted(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 删除了共享文件
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件删除的群组
* sharedFile: SharedFile
被删除的群共享文件
Returns void
onSharedFileUpdated
* public void onSharedFileUpdated(BMXGroup group, BMXGroup.SharedFile sharedFile);
* 共享文件更新文件名
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
发生群共享文件更新的群组
* sharedFile: SharedFile
更新的群共享文件
Returns void
onBlockListAdded
* public void onBlockListAdded(BMXGroup group, ListOfLongLong members);
* 添加黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
添加黑名单的群组
* members: ListOfLongLong
添加的黑名单成员列表
Returns void
onBlockListRemoved
* public void onBlockListRemoved(BMXGroup group, ListOfLongLong members);
* 删除黑名单
Parameters
* group: [BMXGroup](https://developer.qiniu.com/IM/api/8211/bmxgroup)
删除黑名单的群组
* members: ListOfLongLong
删除的黑名单成员列表
Returns void
onGroupListUpdate
* public void onGroupListUpdate();
* 客户端从服务器拉取到新群组时触发，用于用户群组列表更新，从SDK调用本地获取群组即可取得全部成员信息
Returns void
registerGroupService
* public void registerGroupService(BMXGroupService service);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,775 |
BMXImageAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXImageAttachment
# BMXImageAttachment
最近更新时间: 2021-07-19 15:23:01
## 类 BMXImageAttachment
* java.lang.Object
* * BMXBaseObject
* * im.floo.floolib.BMXMessageAttachment
* * im.floo.floolib.BMXFileAttachment
* * im.floo.floolib.BMXImageAttachment
* * * *
public class BMXImageAttachment
extends BMXFileAttachment
图片消息附件
* * ### 嵌套类概要
* ### 从类继承的嵌套类/接口 im.floo.floolib.BMXMessageAttachment
`BMXMessageAttachment.DownloadStatus, BMXMessageAttachment.Size,
BMXMessageAttachment.Type`
* ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BMXImageAttachment(long cPtr, boolean cMemoryOwn)`
` ` | `BMXImageAttachment(java.lang.String path, BMXMessageAttachment.Size size)`
` ` | `BMXImageAttachment(java.lang.String path, BMXMessageAttachment.Size size, java.lang.String displayName)` 构造函数，构建发送图片消息附件
` ` | `BMXImageAttachment(java.lang.String ratelUrl, BMXMessageAttachment.Size size, java.lang.String displayName, long fileLength)` 构造函数，构建接收图片消息附件
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`BMXMessageAttachment` | `clone()` 克隆函数
`void` | `delete()`
`static BMXImageAttachment` | `dynamic_cast(BMXMessageAttachment attachment)`
`protected void` | `finalize()`
`protected static long` | `getCPtr(BMXImageAttachment obj)`
`void` | `setThumbnail(java.lang.String path)` 设置发送图片消息缩略图
`BMXMessageAttachment.Size` | `size()` 图片大小
`BMXMessageAttachment.DownloadStatus` | `thumbnailDownloadStatus()` 缩略图下载状态
`java.lang.String` | `thumbnailPath()` 缩略图本地路径
`java.lang.String` | `thumbnailUrl()`
`BMXMessageAttachment.Type` | `type()` 返回图片附件类型
* ### 从类继承的方法 im.floo.floolib.BMXFileAttachment
`displayName, downloadStatus, fileLength, getCPtr, path, ratelUrl, url`
* ### 从类继承的方法 im.floo.floolib.BMXMessageAttachment
`getCPtr`
* ### 从类继承的方法 java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BMXImageAttachment
protected BMXImageAttachment(long cPtr,
boolean cMemoryOwn)
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String path,
BMXMessageAttachment.Size size,
java.lang.String displayName)
构造函数，构建发送图片消息附件
参数:
`path` \- 本地路径
`size` \- 图片的大小，宽度和高度
`displayName` \- 展示名
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String path,
BMXMessageAttachment.Size size)
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String ratelUrl,
BMXMessageAttachment.Size size,
java.lang.String displayName,
long fileLength)
构造函数，构建接收图片消息附件
参数:
`ratelUrl` \- ratel服务器地址
`size` \- 图片的大小，宽度和高度
`displayName` \- 展示名
`fileLength` \- 文件大小
* ### 方法详细资料
* #### getCPtr
protected static long getCPtr(BMXImageAttachment obj)
* #### finalize
protected void finalize()
覆盖:
`finalize` 在类中 `BMXFileAttachment`
* #### delete
public void delete()
覆盖:
`delete` 在类中 `BMXFileAttachment`
* #### type
public BMXMessageAttachment.Type type()
返回图片附件类型
覆盖:
`type` 在类中 `BMXFileAttachment`
返回:
Type
* #### clone
public BMXMessageAttachment clone()
克隆函数
覆盖:
`clone` 在类中 `BMXFileAttachment`
返回:
BMXMessageAttachmentPtr
* #### size
public BMXMessageAttachment.Size size()
图片大小
返回:
Size
* #### thumbnailUrl
public java.lang.String thumbnailUrl()
* #### setThumbnail
public void setThumbnail(java.lang.String path)
设置发送图片消息缩略图
参数:
`path` \- 本地路径
* #### thumbnailPath
public java.lang.String thumbnailPath()
缩略图本地路径
返回:
std::string
* #### thumbnailDownloadStatus
public BMXMessageAttachment.DownloadStatus thumbnailDownloadStatus()
缩略图下载状态
返回:
DownloadStatus
* #### dynamic_cast
public static BMXImageAttachment dynamic_cast(BMXMessageAttachment attachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXImageAttachment
# BMXImageAttachment
最近更新时间: 2021-07-19 15:23:01
## 类 BMXImageAttachment
* java.lang.Object
* * BMXBaseObject
* * im.floo.floolib.BMXMessageAttachment
* * im.floo.floolib.BMXFileAttachment
* * im.floo.floolib.BMXImageAttachment
* * * *
public class BMXImageAttachment
extends BMXFileAttachment
图片消息附件
* * ### 嵌套类概要
* ### 从类继承的嵌套类/接口 im.floo.floolib.BMXMessageAttachment
`BMXMessageAttachment.DownloadStatus, BMXMessageAttachment.Size,
BMXMessageAttachment.Type`
* ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BMXImageAttachment(long cPtr, boolean cMemoryOwn)`
` ` | `BMXImageAttachment(java.lang.String path, BMXMessageAttachment.Size size)`
` ` | `BMXImageAttachment(java.lang.String path, BMXMessageAttachment.Size size, java.lang.String displayName)` 构造函数，构建发送图片消息附件
` ` | `BMXImageAttachment(java.lang.String ratelUrl, BMXMessageAttachment.Size size, java.lang.String displayName, long fileLength)` 构造函数，构建接收图片消息附件
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`BMXMessageAttachment` | `clone()` 克隆函数
`void` | `delete()`
`static BMXImageAttachment` | `dynamic_cast(BMXMessageAttachment attachment)`
`protected void` | `finalize()`
`protected static long` | `getCPtr(BMXImageAttachment obj)`
`void` | `setThumbnail(java.lang.String path)` 设置发送图片消息缩略图
`BMXMessageAttachment.Size` | `size()` 图片大小
`BMXMessageAttachment.DownloadStatus` | `thumbnailDownloadStatus()` 缩略图下载状态
`java.lang.String` | `thumbnailPath()` 缩略图本地路径
`java.lang.String` | `thumbnailUrl()`
`BMXMessageAttachment.Type` | `type()` 返回图片附件类型
* ### 从类继承的方法 im.floo.floolib.BMXFileAttachment
`displayName, downloadStatus, fileLength, getCPtr, path, ratelUrl, url`
* ### 从类继承的方法 im.floo.floolib.BMXMessageAttachment
`getCPtr`
* ### 从类继承的方法 java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BMXImageAttachment
protected BMXImageAttachment(long cPtr,
boolean cMemoryOwn)
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String path,
BMXMessageAttachment.Size size,
java.lang.String displayName)
构造函数，构建发送图片消息附件
参数:
`path` \- 本地路径
`size` \- 图片的大小，宽度和高度
`displayName` \- 展示名
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String path,
BMXMessageAttachment.Size size)
* #### BMXImageAttachment
public BMXImageAttachment(java.lang.String ratelUrl,
BMXMessageAttachment.Size size,
java.lang.String displayName,
long fileLength)
构造函数，构建接收图片消息附件
参数:
`ratelUrl` \- ratel服务器地址
`size` \- 图片的大小，宽度和高度
`displayName` \- 展示名
`fileLength` \- 文件大小
* ### 方法详细资料
* #### getCPtr
protected static long getCPtr(BMXImageAttachment obj)
* #### finalize
protected void finalize()
覆盖:
`finalize` 在类中 `BMXFileAttachment`
* #### delete
public void delete()
覆盖:
`delete` 在类中 `BMXFileAttachment`
* #### type
public BMXMessageAttachment.Type type()
返回图片附件类型
覆盖:
`type` 在类中 `BMXFileAttachment`
返回:
Type
* #### clone
public BMXMessageAttachment clone()
克隆函数
覆盖:
`clone` 在类中 `BMXFileAttachment`
返回:
BMXMessageAttachmentPtr
* #### size
public BMXMessageAttachment.Size size()
图片大小
返回:
Size
* #### thumbnailUrl
public java.lang.String thumbnailUrl()
* #### setThumbnail
public void setThumbnail(java.lang.String path)
设置发送图片消息缩略图
参数:
`path` \- 本地路径
* #### thumbnailPath
public java.lang.String thumbnailPath()
缩略图本地路径
返回:
std::string
* #### thumbnailDownloadStatus
public BMXMessageAttachment.DownloadStatus thumbnailDownloadStatus()
缩略图下载状态
返回:
DownloadStatus
* #### dynamic_cast
public static BMXImageAttachment dynamic_cast(BMXMessageAttachment attachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,786 |
BMXLocationAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXLocationAttachment
# BMXLocationAttachment
最近更新时间: 2022-07-22 22:43:55
class im.floo.floolib.BMXLocationAttachment
位置消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* latitude
* longitude
* address
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXLocationAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回位置附件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
latitude
* public double latitude();
* 纬度
Returns double
longitude
* public double longitude();
* 经度
Returns double
address
* public String address();
* 地址
Returns String
dynamic_cast
* public static BMXLocationAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXLocationAttachment](https://developer.qiniu.com/IM/api/8237/bmxlocationattachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXLocationAttachment
# BMXLocationAttachment
最近更新时间: 2022-07-22 22:43:55
class im.floo.floolib.BMXLocationAttachment
位置消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* latitude
* longitude
* address
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXLocationAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回位置附件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
latitude
* public double latitude();
* 纬度
Returns double
longitude
* public double longitude();
* 经度
Returns double
address
* public String address();
* 地址
Returns String
dynamic_cast
* public static BMXLocationAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXLocationAttachment](https://developer.qiniu.com/IM/api/8237/bmxlocationattachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,794 |
BMXLogLevel | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXLogLevel
# BMXLogLevel
最近更新时间: 2022-07-22 22:49:51
class im.floo.floolib.BMXLogLevel
日志级别
Index
字段
* Error
* Warning
* Debug
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Error
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Error
*
Warning
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Warning
*
Debug
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Debug
*
方法
values
* public static im.floo.floolib.BMXLogLevel[] values();
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
valueOf
* public static im.floo.floolib.BMXLogLevel valueOf(java.lang.String name);
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXLogLevel swigToEnum(int swigValue);
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXLogLevel
# BMXLogLevel
最近更新时间: 2022-07-22 22:49:51
class im.floo.floolib.BMXLogLevel
日志级别
Index
字段
* Error
* Warning
* Debug
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Error
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Error
*
Warning
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Warning
*
Debug
* public static final [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel) Debug
*
方法
values
* public static im.floo.floolib.BMXLogLevel[] values();
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
valueOf
* public static im.floo.floolib.BMXLogLevel valueOf(java.lang.String name);
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXLogLevel swigToEnum(int swigValue);
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,796 |
BMXMessage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessage
# BMXMessage
最近更新时间: 2022-07-22 22:46:04
class im.floo.floolib.BMXMessage
消息
Index
方法
* getCPtr
* finalize
* delete
* msgId
* clientMsgId
* fromId
* toId
* type
* conversationId
* deliveryStatus
* setDeliveryStatus
* serverTimestamp
* setServerTimestamp
* clientTimestamp
* setClientTimestamp
* isPlayed
* setIsPlayed
* isPlayAcked
* setIsPlayAcked
* isReceiveMsg
* setIsReceiveMsg
* isRead
* setIsRead
* isReadAcked
* setIsReadAcked
* isDeliveryAcked
* setIsDeliveryAcked
* content
* setContent
* contentType
* attachment
* config
* setConfig
* extension
* setExtension
* deliveryQos
* setDeliveryQos
* senderName
* setSenderName
* groupAckCount
* groupAckUnreadCount
* groupAckReadAll
* groupPlayAckCount
* setGroupPlayAckCount
* groupPlayAckUnreadCount
* setGroupPlayAckUnreadCount
* groupPlayAckReadAll
* setPriority
* priority
* setPushMessageMode
* isPushMessage
* createMessage
* createMessage
* createCommandMessage
* createMessage
* createMessage
* createCommandMessage
* createForwardMessage
方法
getCPtr
* protected static long getCPtr(BMXMessage obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
msgId
* public long msgId();
* 消息唯一ID
Returns long
clientMsgId
* public long clientMsgId();
* 消息客户端ID,仅在消息发送端存在
Returns long
fromId
* public long fromId();
* 消息发送方ID
Returns long
toId
* public long toId();
* 消息接收方ID
Returns long
type
* public BMXMessage.MessageType type();
* 消息类型
Returns MessageType
conversationId
* public long conversationId();
* 消息所属会话ID
Returns long
deliveryStatus
* public BMXMessage.DeliveryStatus deliveryStatus();
* 消息投递状态
Returns DeliveryStatus
setDeliveryStatus
* public void setDeliveryStatus(BMXMessage.DeliveryStatus arg0);
* 设置消息投递状态
Returns void
serverTimestamp
* public long serverTimestamp();
* 消息时间戳（服务端收到时的时间）
Returns long
setServerTimestamp
* public void setServerTimestamp(long arg0);
* 设置时间戳（服务端收到时的时间）
Returns void
clientTimestamp
* public long clientTimestamp();
* 本地时间戳（消息创建或者收到时的本地时间）
Returns long
setClientTimestamp
* public void setClientTimestamp(long arg0);
* 设置消息本地时间戳
Returns void
isPlayed
* public boolean isPlayed();
* 语音或者视频消息是否播放过，仅对收到的音视频消息有效
Returns boolean
setIsPlayed
* public void setIsPlayed(boolean arg0);
* Returns void
isPlayAcked
* public boolean isPlayAcked();
* 语音或者视频消息是否收到播放回执，仅对收到的音视频消息有效
Returns boolean
setIsPlayAcked
* public void setIsPlayAcked(boolean arg0);
* Returns void
isReceiveMsg
* public boolean isReceiveMsg();
* 是否接收的消息
Returns boolean
setIsReceiveMsg
* public void setIsReceiveMsg(boolean arg0);
* Returns void
isRead
* public boolean isRead();
* 消息是否已读标志
Returns boolean
setIsRead
* public void setIsRead(boolean arg0);
* Returns void
isReadAcked
* public boolean isReadAcked();
* 对于发送方表示是否收到了已读回执，对于接收方表示是否发送了已读回执
Returns boolean
setIsReadAcked
* public void setIsReadAcked(boolean arg0);
* Returns void
isDeliveryAcked
* public boolean isDeliveryAcked();
* 对于发送方表示消息是否已投递到对方，对于接收方表示是否发送了消息已到达回执
Returns boolean
setIsDeliveryAcked
* public void setIsDeliveryAcked(boolean arg0);
* Returns void
content
* public String content();
* 消息文本内容
Returns String
setContent
* public void setContent(String content);
* 消息文本内容
Parameters
* content: String
消息文本内容
Returns void
contentType
* public BMXMessage.ContentType contentType();
* 消息内容类型，如果带附件就表示附件类型，不带附件就是文本类型
Returns ContentType
attachment
* public BMXMessageAttachment attachment();
* 消息附件，BMXMessage拥有附件的所有权，负责释放
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
config
* public BMXMessageConfig config();
* 消息的配置信息
Returns
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
setConfig
* public void setConfig(BMXMessageConfig arg0);
* 设置消息配置信息
Returns void
extension
* public String extension();
* 消息扩展信息
Returns String
setExtension
* public void setExtension(String arg0);
* 设置消息扩展信息
Returns void
deliveryQos
* public BMXMessage.DeliveryQos deliveryQos();
* 消息投递QOS
Returns DeliveryQos
setDeliveryQos
* public void setDeliveryQos(BMXMessage.DeliveryQos qos);
* 设置消息投递QOS
Parameters
* qos: DeliveryQos
消息投递QOS
Returns void
senderName
* public String senderName();
* 消息发送者的显示名称
Returns String
setSenderName
* public void setSenderName(String senderName);
* 设置消息的发送者显示名称
Parameters
* senderName: String
消息文本内容
Returns void
groupAckCount
* public int groupAckCount();
* 群消息已读AckCount数目
Returns int
groupAckUnreadCount
* public int groupAckUnreadCount();
* 群消息未读AckCount数目
Returns int
groupAckReadAll
* public boolean groupAckReadAll();
* 群消息是否全部已读
Returns boolean
groupPlayAckCount
* public int groupPlayAckCount();
* 获取群消息已播放计数
Returns int
setGroupPlayAckCount
* public void setGroupPlayAckCount(int count);
* Returns void
groupPlayAckUnreadCount
* public int groupPlayAckUnreadCount();
* 获取群消息已播放回执未读计数
Returns int
setGroupPlayAckUnreadCount
* public void setGroupPlayAckUnreadCount(int count);
* Returns void
groupPlayAckReadAll
* public boolean groupPlayAckReadAll();
* 设置所有群消息已播回执为已读
Returns boolean
setPriority
* public void setPriority(int priority);
* 设置消息的扩散优先级，默认为0。0表示扩散，数字越小扩散的越多。 取值范围0-10。普通人在聊天室发送的消息级别默认为5，可以丢弃。管理员默认为0不会丢弃。其它值可以根据业务自行设置。
Parameters
* priority: int
优先级
Returns void
priority
* public int priority();
* 消息的扩散优先级
Returns int
setPushMessageMode
* public void setPushMessageMode(boolean arg0);
* 设置是否推送消息
Returns void
isPushMessage
* public boolean isPushMessage();
* 是否是推送消息
Returns boolean
createMessage
* public static BMXMessage createMessage(long from, long to, BMXMessage.MessageType type, long conversationId, String content);
* 创建发送文本消息
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long from, long to, BMXMessage.MessageType type, long conversationId, BMXMessageAttachment attachment);
* 创建发送附件消息
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* attachment: [BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
附件
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createCommandMessage
* public static BMXMessage createCommandMessage(long from, long to, BMXMessage.MessageType type, long conversationId, String content);
* 创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, String content, long serverTimestamp);
* 创建收到的消息
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, BMXMessageAttachment attachment, long serverTimestamp);
* 创建收到的消息
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* attachment: [BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
附件
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createCommandMessage
* public static BMXMessage createCommandMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, String content, long serverTimestamp);
* 创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createForwardMessage
* public static BMXMessage createForwardMessage(BMXMessage msg, long from, long to, BMXMessage.MessageType type, long conversationId);
* 创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
要转发的消息
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessage
# BMXMessage
最近更新时间: 2022-07-22 22:46:04
class im.floo.floolib.BMXMessage
消息
Index
方法
* getCPtr
* finalize
* delete
* msgId
* clientMsgId
* fromId
* toId
* type
* conversationId
* deliveryStatus
* setDeliveryStatus
* serverTimestamp
* setServerTimestamp
* clientTimestamp
* setClientTimestamp
* isPlayed
* setIsPlayed
* isPlayAcked
* setIsPlayAcked
* isReceiveMsg
* setIsReceiveMsg
* isRead
* setIsRead
* isReadAcked
* setIsReadAcked
* isDeliveryAcked
* setIsDeliveryAcked
* content
* setContent
* contentType
* attachment
* config
* setConfig
* extension
* setExtension
* deliveryQos
* setDeliveryQos
* senderName
* setSenderName
* groupAckCount
* groupAckUnreadCount
* groupAckReadAll
* groupPlayAckCount
* setGroupPlayAckCount
* groupPlayAckUnreadCount
* setGroupPlayAckUnreadCount
* groupPlayAckReadAll
* setPriority
* priority
* setPushMessageMode
* isPushMessage
* createMessage
* createMessage
* createCommandMessage
* createMessage
* createMessage
* createCommandMessage
* createForwardMessage
方法
getCPtr
* protected static long getCPtr(BMXMessage obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
msgId
* public long msgId();
* 消息唯一ID
Returns long
clientMsgId
* public long clientMsgId();
* 消息客户端ID,仅在消息发送端存在
Returns long
fromId
* public long fromId();
* 消息发送方ID
Returns long
toId
* public long toId();
* 消息接收方ID
Returns long
type
* public BMXMessage.MessageType type();
* 消息类型
Returns MessageType
conversationId
* public long conversationId();
* 消息所属会话ID
Returns long
deliveryStatus
* public BMXMessage.DeliveryStatus deliveryStatus();
* 消息投递状态
Returns DeliveryStatus
setDeliveryStatus
* public void setDeliveryStatus(BMXMessage.DeliveryStatus arg0);
* 设置消息投递状态
Returns void
serverTimestamp
* public long serverTimestamp();
* 消息时间戳（服务端收到时的时间）
Returns long
setServerTimestamp
* public void setServerTimestamp(long arg0);
* 设置时间戳（服务端收到时的时间）
Returns void
clientTimestamp
* public long clientTimestamp();
* 本地时间戳（消息创建或者收到时的本地时间）
Returns long
setClientTimestamp
* public void setClientTimestamp(long arg0);
* 设置消息本地时间戳
Returns void
isPlayed
* public boolean isPlayed();
* 语音或者视频消息是否播放过，仅对收到的音视频消息有效
Returns boolean
setIsPlayed
* public void setIsPlayed(boolean arg0);
* Returns void
isPlayAcked
* public boolean isPlayAcked();
* 语音或者视频消息是否收到播放回执，仅对收到的音视频消息有效
Returns boolean
setIsPlayAcked
* public void setIsPlayAcked(boolean arg0);
* Returns void
isReceiveMsg
* public boolean isReceiveMsg();
* 是否接收的消息
Returns boolean
setIsReceiveMsg
* public void setIsReceiveMsg(boolean arg0);
* Returns void
isRead
* public boolean isRead();
* 消息是否已读标志
Returns boolean
setIsRead
* public void setIsRead(boolean arg0);
* Returns void
isReadAcked
* public boolean isReadAcked();
* 对于发送方表示是否收到了已读回执，对于接收方表示是否发送了已读回执
Returns boolean
setIsReadAcked
* public void setIsReadAcked(boolean arg0);
* Returns void
isDeliveryAcked
* public boolean isDeliveryAcked();
* 对于发送方表示消息是否已投递到对方，对于接收方表示是否发送了消息已到达回执
Returns boolean
setIsDeliveryAcked
* public void setIsDeliveryAcked(boolean arg0);
* Returns void
content
* public String content();
* 消息文本内容
Returns String
setContent
* public void setContent(String content);
* 消息文本内容
Parameters
* content: String
消息文本内容
Returns void
contentType
* public BMXMessage.ContentType contentType();
* 消息内容类型，如果带附件就表示附件类型，不带附件就是文本类型
Returns ContentType
attachment
* public BMXMessageAttachment attachment();
* 消息附件，BMXMessage拥有附件的所有权，负责释放
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
config
* public BMXMessageConfig config();
* 消息的配置信息
Returns
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
setConfig
* public void setConfig(BMXMessageConfig arg0);
* 设置消息配置信息
Returns void
extension
* public String extension();
* 消息扩展信息
Returns String
setExtension
* public void setExtension(String arg0);
* 设置消息扩展信息
Returns void
deliveryQos
* public BMXMessage.DeliveryQos deliveryQos();
* 消息投递QOS
Returns DeliveryQos
setDeliveryQos
* public void setDeliveryQos(BMXMessage.DeliveryQos qos);
* 设置消息投递QOS
Parameters
* qos: DeliveryQos
消息投递QOS
Returns void
senderName
* public String senderName();
* 消息发送者的显示名称
Returns String
setSenderName
* public void setSenderName(String senderName);
* 设置消息的发送者显示名称
Parameters
* senderName: String
消息文本内容
Returns void
groupAckCount
* public int groupAckCount();
* 群消息已读AckCount数目
Returns int
groupAckUnreadCount
* public int groupAckUnreadCount();
* 群消息未读AckCount数目
Returns int
groupAckReadAll
* public boolean groupAckReadAll();
* 群消息是否全部已读
Returns boolean
groupPlayAckCount
* public int groupPlayAckCount();
* 获取群消息已播放计数
Returns int
setGroupPlayAckCount
* public void setGroupPlayAckCount(int count);
* Returns void
groupPlayAckUnreadCount
* public int groupPlayAckUnreadCount();
* 获取群消息已播放回执未读计数
Returns int
setGroupPlayAckUnreadCount
* public void setGroupPlayAckUnreadCount(int count);
* Returns void
groupPlayAckReadAll
* public boolean groupPlayAckReadAll();
* 设置所有群消息已播回执为已读
Returns boolean
setPriority
* public void setPriority(int priority);
* 设置消息的扩散优先级，默认为0。0表示扩散，数字越小扩散的越多。 取值范围0-10。普通人在聊天室发送的消息级别默认为5，可以丢弃。管理员默认为0不会丢弃。其它值可以根据业务自行设置。
Parameters
* priority: int
优先级
Returns void
priority
* public int priority();
* 消息的扩散优先级
Returns int
setPushMessageMode
* public void setPushMessageMode(boolean arg0);
* 设置是否推送消息
Returns void
isPushMessage
* public boolean isPushMessage();
* 是否是推送消息
Returns boolean
createMessage
* public static BMXMessage createMessage(long from, long to, BMXMessage.MessageType type, long conversationId, String content);
* 创建发送文本消息
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long from, long to, BMXMessage.MessageType type, long conversationId, BMXMessageAttachment attachment);
* 创建发送附件消息
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* attachment: [BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
附件
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createCommandMessage
* public static BMXMessage createCommandMessage(long from, long to, BMXMessage.MessageType type, long conversationId, String content);
* 创建发送命令消息(命令消息通过content字段或者extension字段存放命令信息)
Parameters
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, String content, long serverTimestamp);
* 创建收到的消息
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createMessage
* public static BMXMessage createMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, BMXMessageAttachment attachment, long serverTimestamp);
* 创建收到的消息
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* attachment: [BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
附件
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createCommandMessage
* public static BMXMessage createCommandMessage(long msgId, long from, long to, BMXMessage.MessageType type, long conversationId, String content, long serverTimestamp);
* 创建收到的命令消息(命令消息通过content字段或者extension字段存放命令信息)
Parameters
* msgId: long
消息id
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
* content: String
消息内容
* serverTimestamp: long
服务器时间戳
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
createForwardMessage
* public static BMXMessage createForwardMessage(BMXMessage msg, long from, long to, BMXMessage.MessageType type, long conversationId);
* 创建转发消息
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
要转发的消息
* from: long
消息发送者
* to: long
消息接收者
* type: MessageType
消息类型
* conversationId: long
会话id
Returns [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,798 |
BMXMessage.ContentType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.ContentType
# BMXMessage.ContentType
最近更新时间: 2022-07-22 22:53:16
class im.floo.floolib.BMXMessage.ContentType
消息内容类型
Index
字段
* Text
* Image
* Voice
* Video
* File
* Location
* Command
* Forward
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Text
* public static final ContentType Text
*
Image
* public static final ContentType Image
*
Voice
* public static final ContentType Voice
*
Video
* public static final ContentType Video
*
File
* public static final ContentType File
*
Location
* public static final ContentType Location
*
Command
* public static final ContentType Command
*
Forward
* public static final ContentType Forward
*
方法
values
* public static im.floo.floolib.BMXMessage.ContentType[] values();
* Returns ContentType
valueOf
* public static im.floo.floolib.BMXMessage.ContentType valueOf(java.lang.String name);
* Returns ContentType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ContentType swigToEnum(int swigValue);
* Returns ContentType
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.ContentType
# BMXMessage.ContentType
最近更新时间: 2022-07-22 22:53:16
class im.floo.floolib.BMXMessage.ContentType
消息内容类型
Index
字段
* Text
* Image
* Voice
* Video
* File
* Location
* Command
* Forward
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Text
* public static final ContentType Text
*
Image
* public static final ContentType Image
*
Voice
* public static final ContentType Voice
*
Video
* public static final ContentType Video
*
File
* public static final ContentType File
*
Location
* public static final ContentType Location
*
Command
* public static final ContentType Command
*
Forward
* public static final ContentType Forward
*
方法
values
* public static im.floo.floolib.BMXMessage.ContentType[] values();
* Returns ContentType
valueOf
* public static im.floo.floolib.BMXMessage.ContentType valueOf(java.lang.String name);
* Returns ContentType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static ContentType swigToEnum(int swigValue);
* Returns ContentType
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,810 |
BMXMessage.DeliveryQos | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.DeliveryQos
# BMXMessage.DeliveryQos
最近更新时间: 2022-07-22 23:00:20
class im.floo.floolib.BMXMessage.DeliveryQos
消息投递质量
Index
字段
* AtLastOnce
* AtMostOnce
* ExactlyOnce
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AtLastOnce
* public static final DeliveryQos AtLastOnce
*
AtMostOnce
* public static final DeliveryQos AtMostOnce
*
ExactlyOnce
* public static final DeliveryQos ExactlyOnce
*
方法
values
* public static im.floo.floolib.BMXMessage.DeliveryQos[] values();
* Returns DeliveryQos
valueOf
* public static im.floo.floolib.BMXMessage.DeliveryQos valueOf(java.lang.String name);
* Returns DeliveryQos
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DeliveryQos swigToEnum(int swigValue);
* Returns DeliveryQos
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.DeliveryQos
# BMXMessage.DeliveryQos
最近更新时间: 2022-07-22 23:00:20
class im.floo.floolib.BMXMessage.DeliveryQos
消息投递质量
Index
字段
* AtLastOnce
* AtMostOnce
* ExactlyOnce
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
AtLastOnce
* public static final DeliveryQos AtLastOnce
*
AtMostOnce
* public static final DeliveryQos AtMostOnce
*
ExactlyOnce
* public static final DeliveryQos ExactlyOnce
*
方法
values
* public static im.floo.floolib.BMXMessage.DeliveryQos[] values();
* Returns DeliveryQos
valueOf
* public static im.floo.floolib.BMXMessage.DeliveryQos valueOf(java.lang.String name);
* Returns DeliveryQos
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DeliveryQos swigToEnum(int swigValue);
* Returns DeliveryQos
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,813 |
BMXMessage.DeliveryStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.DeliveryStatus
# BMXMessage.DeliveryStatus
最近更新时间: 2022-07-22 22:46:34
class im.floo.floolib.BMXMessage.DeliveryStatus
消息投递状态
Index
字段
* New
* Delivering
* Deliveried
* Failed
* Recalled
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
New
* public static final DeliveryStatus New
*
Delivering
* public static final DeliveryStatus Delivering
*
Deliveried
* public static final DeliveryStatus Deliveried
*
Failed
* public static final DeliveryStatus Failed
*
Recalled
* public static final DeliveryStatus Recalled
*
方法
values
* public static im.floo.floolib.BMXMessage.DeliveryStatus[] values();
* Returns DeliveryStatus
valueOf
* public static im.floo.floolib.BMXMessage.DeliveryStatus valueOf(java.lang.String name);
* Returns DeliveryStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DeliveryStatus swigToEnum(int swigValue);
* Returns DeliveryStatus
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.DeliveryStatus
# BMXMessage.DeliveryStatus
最近更新时间: 2022-07-22 22:46:34
class im.floo.floolib.BMXMessage.DeliveryStatus
消息投递状态
Index
字段
* New
* Delivering
* Deliveried
* Failed
* Recalled
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
New
* public static final DeliveryStatus New
*
Delivering
* public static final DeliveryStatus Delivering
*
Deliveried
* public static final DeliveryStatus Deliveried
*
Failed
* public static final DeliveryStatus Failed
*
Recalled
* public static final DeliveryStatus Recalled
*
方法
values
* public static im.floo.floolib.BMXMessage.DeliveryStatus[] values();
* Returns DeliveryStatus
valueOf
* public static im.floo.floolib.BMXMessage.DeliveryStatus valueOf(java.lang.String name);
* Returns DeliveryStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DeliveryStatus swigToEnum(int swigValue);
* Returns DeliveryStatus
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,815 |
BMXMessage.MessageType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.MessageType
# BMXMessage.MessageType
最近更新时间: 2022-07-22 22:53:10
class im.floo.floolib.BMXMessage.MessageType
消息类型
Index
字段
* Single
* Group
* System
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Single
* public static final MessageType Single
*
Group
* public static final MessageType Group
*
System
* public static final MessageType System
*
方法
values
* public static im.floo.floolib.BMXMessage.MessageType[] values();
* Returns MessageType
valueOf
* public static im.floo.floolib.BMXMessage.MessageType valueOf(java.lang.String name);
* Returns MessageType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MessageType swigToEnum(int swigValue);
* Returns MessageType
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage) >
BMXMessage.MessageType
# BMXMessage.MessageType
最近更新时间: 2022-07-22 22:53:10
class im.floo.floolib.BMXMessage.MessageType
消息类型
Index
字段
* Single
* Group
* System
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Single
* public static final MessageType Single
*
Group
* public static final MessageType Group
*
System
* public static final MessageType System
*
方法
values
* public static im.floo.floolib.BMXMessage.MessageType[] values();
* Returns MessageType
valueOf
* public static im.floo.floolib.BMXMessage.MessageType valueOf(java.lang.String name);
* Returns MessageType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static MessageType swigToEnum(int swigValue);
* Returns MessageType
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,818 |
BMXMessageAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessageAttachment
# BMXMessageAttachment
最近更新时间: 2022-07-22 22:43:35
class im.floo.floolib.BMXMessageAttachment
消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
方法
getCPtr
* protected static long getCPtr(BMXMessageAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 附件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 复制附件
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessageAttachment
# BMXMessageAttachment
最近更新时间: 2022-07-22 22:43:35
class im.floo.floolib.BMXMessageAttachment
消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
方法
getCPtr
* protected static long getCPtr(BMXMessageAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 附件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 复制附件
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,820 |
BMXMessageAttachment.DownloadStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.DownloadStatus
# BMXMessageAttachment.DownloadStatus
最近更新时间: 2022-07-22 22:59:28
class im.floo.floolib.BMXMessageAttachment.DownloadStatus
附件下载状态
Index
字段
* Downloaing
* Successed
* Failed
* NotStart
* Canceled
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Downloaing
* public static final DownloadStatus Downloaing
*
Successed
* public static final DownloadStatus Successed
*
Failed
* public static final DownloadStatus Failed
*
NotStart
* public static final DownloadStatus NotStart
*
Canceled
* public static final DownloadStatus Canceled
*
方法
values
* public static im.floo.floolib.BMXMessageAttachment.DownloadStatus[] values();
* Returns DownloadStatus
valueOf
* public static im.floo.floolib.BMXMessageAttachment.DownloadStatus valueOf(java.lang.String name);
* Returns DownloadStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DownloadStatus swigToEnum(int swigValue);
* Returns DownloadStatus
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.DownloadStatus
# BMXMessageAttachment.DownloadStatus
最近更新时间: 2022-07-22 22:59:28
class im.floo.floolib.BMXMessageAttachment.DownloadStatus
附件下载状态
Index
字段
* Downloaing
* Successed
* Failed
* NotStart
* Canceled
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Downloaing
* public static final DownloadStatus Downloaing
*
Successed
* public static final DownloadStatus Successed
*
Failed
* public static final DownloadStatus Failed
*
NotStart
* public static final DownloadStatus NotStart
*
Canceled
* public static final DownloadStatus Canceled
*
方法
values
* public static im.floo.floolib.BMXMessageAttachment.DownloadStatus[] values();
* Returns DownloadStatus
valueOf
* public static im.floo.floolib.BMXMessageAttachment.DownloadStatus valueOf(java.lang.String name);
* Returns DownloadStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static DownloadStatus swigToEnum(int swigValue);
* Returns DownloadStatus
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,822 |
BMXMessageAttachment.Size | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.Size
# BMXMessageAttachment.Size
最近更新时间: 2022-07-22 22:45:51
class im.floo.floolib.BMXMessageAttachment.Size
图片/视频大小
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMWidth
* getMWidth
* setMHeight
* getMHeight
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Size obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMWidth
* public void setMWidth(double value);
* Returns void
getMWidth
* public double getMWidth();
* Returns double
setMHeight
* public void setMHeight(double value);
* Returns void
getMHeight
* public double getMHeight();
* Returns double
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.Size
# BMXMessageAttachment.Size
最近更新时间: 2022-07-22 22:45:51
class im.floo.floolib.BMXMessageAttachment.Size
图片/视频大小
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMWidth
* getMWidth
* setMHeight
* getMHeight
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Size obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMWidth
* public void setMWidth(double value);
* Returns void
getMWidth
* public double getMWidth();
* Returns double
setMHeight
* public void setMHeight(double value);
* Returns void
getMHeight
* public double getMHeight();
* Returns double
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,825 |
BMXMessageAttachment.Type | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.Type
# BMXMessageAttachment.Type
最近更新时间: 2022-07-26 14:12:01
class im.floo.floolib.BMXMessageAttachment.Type
附件类型
Index
字段
* Image
* Voice
* Video
* File
* Location
* Command
* Forward
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Image
* public static final Type Image
*
Voice
* public static final Type Voice
*
Video
* public static final Type Video
*
File
* public static final Type File
*
Location
* public static final Type Location
*
Command
* public static final Type Command
*
Forward
* public static final Type Forward
*
方法
values
* public static im.floo.floolib.BMXMessageAttachment.Type[] values();
* Returns Type
valueOf
* public static im.floo.floolib.BMXMessageAttachment.Type valueOf(java.lang.String name);
* Returns Type
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Type swigToEnum(int swigValue);
* Returns Type
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
> BMXMessageAttachment.Type
# BMXMessageAttachment.Type
最近更新时间: 2022-07-26 14:12:01
class im.floo.floolib.BMXMessageAttachment.Type
附件类型
Index
字段
* Image
* Voice
* Video
* File
* Location
* Command
* Forward
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Image
* public static final Type Image
*
Voice
* public static final Type Voice
*
Video
* public static final Type Video
*
File
* public static final Type File
*
Location
* public static final Type Location
*
Command
* public static final Type Command
*
Forward
* public static final Type Forward
*
方法
values
* public static im.floo.floolib.BMXMessageAttachment.Type[] values();
* Returns Type
valueOf
* public static im.floo.floolib.BMXMessageAttachment.Type valueOf(java.lang.String name);
* Returns Type
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static Type swigToEnum(int swigValue);
* Returns Type
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,827 |
BMXMessageConfig | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessageConfig
# BMXMessageConfig
最近更新时间: 2022-07-22 22:40:27
class im.floo.floolib.BMXMessageConfig
消息配置
Index
方法
* getCPtr
* finalize
* delete
* setMentionAll
* getMentionAll
* setMentionList
* getMentionList
* setMentionedMessage
* getMentionedMessage
* setPushMessage
* getPushMessage
* setSenderNickname
* getSenderNickname
* setGroupMemberList
* getGroupMemberList
* addGroupMember
* removeGroupMember
* clearGroupMemberList
* setIOSConfig
* getIOSConfig
* setAndroidConfig
* getAndroidConfig
* setPushShowBeginTime
* getPushShowBeginTime
* setPushShowEndTime
* getPushShowEndTime
* setPushTitle
* getPushTitle
* isSilence
* getBadgeCountType
* getBadgeCount
* getUsername
* serialize
* createMessageConfig
方法
getCPtr
* protected static long getCPtr(BMXMessageConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMentionAll
* public void setMentionAll(boolean mentionAll);
* 设置是否@全员
Parameters
* mentionAll: boolean
Returns void
getMentionAll
* public boolean getMentionAll();
* 获取是否@全员
Returns boolean
setMentionList
* public void setMentionList(ListOfLongLong mentionList);
* 设置通知成员id列表
Parameters
* mentionList: ListOfLongLong
Returns void
getMentionList
* public ListOfLongLong getMentionList();
* 获取@成员列表
Returns ListOfLongLong
setMentionedMessage
* public void setMentionedMessage(String mentionedMessage);
* 设置@消息
Parameters
* mentionedMessage: String
Returns void
getMentionedMessage
* public String getMentionedMessage();
* 获取@消息
Returns String
setPushMessage
* public void setPushMessage(String pushMessage);
* 设置推送消息
Parameters
* pushMessage: String
Returns void
getPushMessage
* public String getPushMessage();
* 获取推送消息
Returns String
setSenderNickname
* public void setSenderNickname(String senderNickname);
* 设置发送者昵称
Parameters
* senderNickname: String
Returns void
getSenderNickname
* public String getSenderNickname();
* 获取发送者昵称
Returns String
setGroupMemberList
* public void setGroupMemberList(ListOfLongLong groupMemberList);
* 设置需要群已读消息的群成员id列表
Parameters
* groupMemberList: ListOfLongLong
Returns void
getGroupMemberList
* public ListOfLongLong getGroupMemberList();
* 获取需要群已读消息的群成员id列表
Returns ListOfLongLong
addGroupMember
* public void addGroupMember(long id);
* 添加群已读消息的群成员id列表成员
Returns void
removeGroupMember
* public void removeGroupMember(long id);
* 清除需要群已读消息的群成员id列表成员
Returns void
clearGroupMemberList
* public void clearGroupMemberList();
* 清空群已读消息的群成员id列表
Returns void
setIOSConfig
* public void setIOSConfig(String iosConfig);
* Returns void
getIOSConfig
* public String getIOSConfig();
* 获取iOS消息配置
Returns String
setAndroidConfig
* public void setAndroidConfig(String androidConfig);
* Returns void
getAndroidConfig
* public String getAndroidConfig();
* 获取Android消息配置
Returns String
setPushShowBeginTime
* public void setPushShowBeginTime(int beginTime);
* Returns void
getPushShowBeginTime
* public int getPushShowBeginTime();
* 获取推送消息开始展示时间
Returns int
setPushShowEndTime
* public void setPushShowEndTime(int endTime);
* Returns void
getPushShowEndTime
* public int getPushShowEndTime();
* 获取推送消息结束展示时间
Returns int
setPushTitle
* public void setPushTitle(String pushTitle);
* Returns void
getPushTitle
* public String getPushTitle();
* 获取推送消息标题
Returns String
isSilence
* public boolean isSilence();
* Returns boolean
getBadgeCountType
* public BMXMessageConfig.BadgeCountType getBadgeCountType();
* Returns BadgeCountType
getBadgeCount
* public int getBadgeCount(int count);
* Returns int
getUsername
* public String getUsername();
* 获取消息发送者用户名
Returns String
serialize
* public String serialize();
* 序列化操作
Returns String
createMessageConfig
* public static BMXMessageConfig createMessageConfig(boolean mentionAll);
* Returns [BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXMessageConfig
# BMXMessageConfig
最近更新时间: 2022-07-22 22:40:27
class im.floo.floolib.BMXMessageConfig
消息配置
Index
方法
* getCPtr
* finalize
* delete
* setMentionAll
* getMentionAll
* setMentionList
* getMentionList
* setMentionedMessage
* getMentionedMessage
* setPushMessage
* getPushMessage
* setSenderNickname
* getSenderNickname
* setGroupMemberList
* getGroupMemberList
* addGroupMember
* removeGroupMember
* clearGroupMemberList
* setIOSConfig
* getIOSConfig
* setAndroidConfig
* getAndroidConfig
* setPushShowBeginTime
* getPushShowBeginTime
* setPushShowEndTime
* getPushShowEndTime
* setPushTitle
* getPushTitle
* isSilence
* getBadgeCountType
* getBadgeCount
* getUsername
* serialize
* createMessageConfig
方法
getCPtr
* protected static long getCPtr(BMXMessageConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMentionAll
* public void setMentionAll(boolean mentionAll);
* 设置是否@全员
Parameters
* mentionAll: boolean
Returns void
getMentionAll
* public boolean getMentionAll();
* 获取是否@全员
Returns boolean
setMentionList
* public void setMentionList(ListOfLongLong mentionList);
* 设置通知成员id列表
Parameters
* mentionList: ListOfLongLong
Returns void
getMentionList
* public ListOfLongLong getMentionList();
* 获取@成员列表
Returns ListOfLongLong
setMentionedMessage
* public void setMentionedMessage(String mentionedMessage);
* 设置@消息
Parameters
* mentionedMessage: String
Returns void
getMentionedMessage
* public String getMentionedMessage();
* 获取@消息
Returns String
setPushMessage
* public void setPushMessage(String pushMessage);
* 设置推送消息
Parameters
* pushMessage: String
Returns void
getPushMessage
* public String getPushMessage();
* 获取推送消息
Returns String
setSenderNickname
* public void setSenderNickname(String senderNickname);
* 设置发送者昵称
Parameters
* senderNickname: String
Returns void
getSenderNickname
* public String getSenderNickname();
* 获取发送者昵称
Returns String
setGroupMemberList
* public void setGroupMemberList(ListOfLongLong groupMemberList);
* 设置需要群已读消息的群成员id列表
Parameters
* groupMemberList: ListOfLongLong
Returns void
getGroupMemberList
* public ListOfLongLong getGroupMemberList();
* 获取需要群已读消息的群成员id列表
Returns ListOfLongLong
addGroupMember
* public void addGroupMember(long id);
* 添加群已读消息的群成员id列表成员
Returns void
removeGroupMember
* public void removeGroupMember(long id);
* 清除需要群已读消息的群成员id列表成员
Returns void
clearGroupMemberList
* public void clearGroupMemberList();
* 清空群已读消息的群成员id列表
Returns void
setIOSConfig
* public void setIOSConfig(String iosConfig);
* Returns void
getIOSConfig
* public String getIOSConfig();
* 获取iOS消息配置
Returns String
setAndroidConfig
* public void setAndroidConfig(String androidConfig);
* Returns void
getAndroidConfig
* public String getAndroidConfig();
* 获取Android消息配置
Returns String
setPushShowBeginTime
* public void setPushShowBeginTime(int beginTime);
* Returns void
getPushShowBeginTime
* public int getPushShowBeginTime();
* 获取推送消息开始展示时间
Returns int
setPushShowEndTime
* public void setPushShowEndTime(int endTime);
* Returns void
getPushShowEndTime
* public int getPushShowEndTime();
* 获取推送消息结束展示时间
Returns int
setPushTitle
* public void setPushTitle(String pushTitle);
* Returns void
getPushTitle
* public String getPushTitle();
* 获取推送消息标题
Returns String
isSilence
* public boolean isSilence();
* Returns boolean
getBadgeCountType
* public BMXMessageConfig.BadgeCountType getBadgeCountType();
* Returns BadgeCountType
getBadgeCount
* public int getBadgeCount(int count);
* Returns int
getUsername
* public String getUsername();
* 获取消息发送者用户名
Returns String
serialize
* public String serialize();
* 序列化操作
Returns String
createMessageConfig
* public static BMXMessageConfig createMessageConfig(boolean mentionAll);
* Returns [BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,829 |
BMXMessageConfig.BadgeCountType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig) >
BMXMessageConfig.BadgeCountType
# BMXMessageConfig.BadgeCountType
最近更新时间: 2022-07-22 22:40:01
class im.floo.floolib.BMXMessageConfig.BadgeCountType
Index
字段
* Change
* Set
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Change
* public static final BadgeCountType Change
*
Set
* public static final BadgeCountType Set
*
方法
values
* public static im.floo.floolib.BMXMessageConfig.BadgeCountType[] values();
* Returns BadgeCountType
valueOf
* public static im.floo.floolib.BMXMessageConfig.BadgeCountType valueOf(java.lang.String name);
* Returns BadgeCountType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BadgeCountType swigToEnum(int swigValue);
* Returns BadgeCountType
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXMessageConfig](https://developer.qiniu.com/IM/api/8248/bmxmessageconfig) >
BMXMessageConfig.BadgeCountType
# BMXMessageConfig.BadgeCountType
最近更新时间: 2022-07-22 22:40:01
class im.floo.floolib.BMXMessageConfig.BadgeCountType
Index
字段
* Change
* Set
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Change
* public static final BadgeCountType Change
*
Set
* public static final BadgeCountType Set
*
方法
values
* public static im.floo.floolib.BMXMessageConfig.BadgeCountType[] values();
* Returns BadgeCountType
valueOf
* public static im.floo.floolib.BMXMessageConfig.BadgeCountType valueOf(java.lang.String name);
* Returns BadgeCountType
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BadgeCountType swigToEnum(int swigValue);
* Returns BadgeCountType
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,836 |
BMXNetworkListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXNetworkListener
# BMXNetworkListener
最近更新时间: 2022-07-22 22:41:14
class im.floo.floolib.BMXNetworkListener
网络监听者
Index
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onNetworkChanged
方法
getCPtr
* protected static long getCPtr(BMXNetworkListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onNetworkChanged
* public void onNetworkChanged(BMXNetworkType type, boolean reconnect);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXNetworkListener
# BMXNetworkListener
最近更新时间: 2022-07-22 22:41:14
class im.floo.floolib.BMXNetworkListener
网络监听者
Index
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onNetworkChanged
方法
getCPtr
* protected static long getCPtr(BMXNetworkListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onNetworkChanged
* public void onNetworkChanged(BMXNetworkType type, boolean reconnect);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,838 |
BMXNetworkType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXNetworkType
# BMXNetworkType
最近更新时间: 2022-07-22 22:41:01
class im.floo.floolib.BMXNetworkType
网络类型
Index
字段
* Mobile
* Wifi
* Cable
* None
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Mobile
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Mobile
*
Wifi
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Wifi
*
Cable
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Cable
*
None
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) None
*
方法
values
* public static im.floo.floolib.BMXNetworkType[] values();
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
valueOf
* public static im.floo.floolib.BMXNetworkType valueOf(java.lang.String name);
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXNetworkType swigToEnum(int swigValue);
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXNetworkType
# BMXNetworkType
最近更新时间: 2022-07-22 22:41:01
class im.floo.floolib.BMXNetworkType
网络类型
Index
字段
* Mobile
* Wifi
* Cable
* None
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Mobile
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Mobile
*
Wifi
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Wifi
*
Cable
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) Cable
*
None
* public static final [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype) None
*
方法
values
* public static im.floo.floolib.BMXNetworkType[] values();
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
valueOf
* public static im.floo.floolib.BMXNetworkType valueOf(java.lang.String name);
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXNetworkType swigToEnum(int swigValue);
* Returns [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,840 |
BMXPushEnvironmentType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushEnvironmentType
# BMXPushEnvironmentType
最近更新时间: 2022-07-22 22:42:47
class im.floo.floolib.BMXPushEnvironmentType
Index
字段
* Development
* Production
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Development
* public static final [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype) Development
*
Production
* public static final [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype) Production
*
方法
values
* public static im.floo.floolib.BMXPushEnvironmentType[] values();
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
valueOf
* public static im.floo.floolib.BMXPushEnvironmentType valueOf(java.lang.String name);
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXPushEnvironmentType swigToEnum(int swigValue);
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushEnvironmentType
# BMXPushEnvironmentType
最近更新时间: 2022-07-22 22:42:47
class im.floo.floolib.BMXPushEnvironmentType
Index
字段
* Development
* Production
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Development
* public static final [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype) Development
*
Production
* public static final [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype) Production
*
方法
values
* public static im.floo.floolib.BMXPushEnvironmentType[] values();
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
valueOf
* public static im.floo.floolib.BMXPushEnvironmentType valueOf(java.lang.String name);
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXPushEnvironmentType swigToEnum(int swigValue);
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,842 |
BMXPushManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushManager
# BMXPushManager
最近更新时间: 2022-07-22 22:44:33
class im.floo.floolib.BMXPushManager
推送管理器
Index
方法
* start
* start
* start
* stop
* resume
* unbindAlias
* getToken
* getCert
* status
* bindDeviceToken
* bindVoipToken
* getPushProfile
* setTags
* getTags
* deleteTags
* clearTags
* setBadge
* setPushMode
* setPushMode
* setPushTime
* setSilenceTime
* setRunBackgroundMode
* setRunBackgroundMode
* setGeoFenceMode
* setGeoFenceMode
* setGeoFenceMode
* clearNotification
* clearAllNotifications
* sendMessage
* loadLocalPushMessages
* loadLocalPushMessages
* addPushListener
* removePushListener
方法
start
* public void start(final String alias, final String bmxToken, final BMXCallBack callBack);
* 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。
Parameters
* alias: String
推送初始化使用的当前用户别名
* bmxToken: String
推送初始化的时候App传入的使用的用户的token，无用户的状态下不传入即可。
* callBack: BMXCallBack
BMXErrorCode
Returns void
start
* public void start(final String alias, final BMXCallBack callBack);
* Returns void
start
* public void start(final BMXCallBack callBack);
* Returns void
stop
* public void stop(final BMXCallBack callBack);
* 停止推送功能接口。
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
resume
* public void resume(final BMXCallBack callBack);
* 恢复推送功能接口。
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
unbindAlias
* public void unbindAlias(final String alias, final BMXCallBack callBack);
* 解除用户别名绑定。
Parameters
* alias: String
需要解除绑定的用户别名。
* callBack: BMXCallBack
BMXErrorCode
Returns void
getToken
* public String getToken();
* 获取登陆后使用的用户token。
Returns String
getCert
* public String getCert();
* 获取登陆后服务器返回的推送证书。
Returns String
status
* public BMXPushService.PushSdkStatus status();
* 推送sdk当前的状态。
Returns PushSdkStatus
bindDeviceToken
* public void bindDeviceToken(final String token, final BMXCallBack callBack);
* 推送绑定设备token。
Parameters
* token: String
设备的推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
bindVoipToken
* public void bindVoipToken(final String token, final BMXCallBack callBack);
* 绑定推送设备的voiptoken。
Parameters
* token: String
设备的voip推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
getPushProfile
* public void getPushProfile(final boolean forceRefresh, final BMXDataCallBack<BMXPushUserProfile> callBack);
* 获取推送用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
* callBack: <any>
推送用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息
Returns void
setTags
* public void setTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 设置推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
getTags
* public void getTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 获取推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
deleteTags
* public void deleteTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 删除推送用户的标签。
Parameters
* tags: TagList
要删除用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
clearTags
* public void clearTags(final String operationId, final BMXCallBack callBack);
* 清空推送用户的标签。
Parameters
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setBadge
* public void setBadge(final int count, final BMXCallBack callBack);
* 设置推送用户的未读角标。
Parameters
* count: int
用户未读角标数
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushMode
* public void setPushMode(final boolean enable, final BMXCallBack callBack);
* 设置推送启用状态。默认为使用推送。
Parameters
* enable: boolean
推送的启用状态
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushMode
* public void setPushMode(final BMXCallBack callBack);
* Returns void
setPushTime
* public void setPushTime(final int startHour, final int endHour, final BMXCallBack callBack);
* 设置允许推送时间。
Parameters
* startHour: int
静默允许推送的起始时间小时
* endHour: int
静默允许推送的结束时间小时
* callBack: BMXCallBack
BMXErrorCode
Returns void
setSilenceTime
* public void setSilenceTime(final int startHour, final int endHour, final BMXCallBack callBack);
* 设置推送静默的起始结束时间。
Parameters
* startHour: int
静默推送的起始时间小时
* endHour: int
静默推送的结束时间小时
* callBack: BMXCallBack
BMXErrorCode
Returns void
setRunBackgroundMode
* public void setRunBackgroundMode(final boolean enable, final BMXCallBack callBack);
* 设置推送是否可以后台运行。默认是false。
Parameters
* enable: boolean
推送后台运行状态。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setRunBackgroundMode
* public void setRunBackgroundMode(final BMXCallBack callBack);
* Returns void
setGeoFenceMode
* public void setGeoFenceMode(final boolean enable, final boolean isAllow, final BMXCallBack callBack);
* 设置推送的地理围栏功能是否运行。
Parameters
* enable: boolean
地理围栏功能是否运行。
* isAllow: boolean
用户是否主动弹出用户定位请求。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setGeoFenceMode
* public void setGeoFenceMode(final boolean enable, final BMXCallBack callBack);
* Returns void
setGeoFenceMode
* public void setGeoFenceMode(final BMXCallBack callBack);
* Returns void
clearNotification
* public void clearNotification(final long notificationId);
* 清除指定id的通知。
Parameters
* notificationId: long
通知id
Returns void
clearAllNotifications
* public void clearAllNotifications();
* Returns void
sendMessage
* public void sendMessage(final String content);
* 发送推送上行消息，消息状态变化会通过listener通知
Parameters
* content: String
发送的上行推送消息内容
Returns void
loadLocalPushMessages
* public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXPushService.PushDirection arg3, final BMXCallBack callBack);
* 加载数据库本地存储的推送消息。如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载推送消息的起始id
* size: long
最大加载消息条数
* result: BMXMessageList
数据库返回的加载本地推送消息列表
* arg3: PushDirection
加载推送消息的方向，默认是加载更早的消息
Returns void
loadLocalPushMessages
* public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXCallBack callBack);
* Returns void
addPushListener
* public void addPushListener(BMXPushServiceListener listener);
* 添加推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
removePushListener
* public void removePushListener(BMXPushServiceListener listener);
* 移除推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushManager
# BMXPushManager
最近更新时间: 2022-07-22 22:44:33
class im.floo.floolib.BMXPushManager
推送管理器
Index
方法
* start
* start
* start
* stop
* resume
* unbindAlias
* getToken
* getCert
* status
* bindDeviceToken
* bindVoipToken
* getPushProfile
* setTags
* getTags
* deleteTags
* clearTags
* setBadge
* setPushMode
* setPushMode
* setPushTime
* setSilenceTime
* setRunBackgroundMode
* setRunBackgroundMode
* setGeoFenceMode
* setGeoFenceMode
* setGeoFenceMode
* clearNotification
* clearAllNotifications
* sendMessage
* loadLocalPushMessages
* loadLocalPushMessages
* addPushListener
* removePushListener
方法
start
* public void start(final String alias, final String bmxToken, final BMXCallBack callBack);
* 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。
Parameters
* alias: String
推送初始化使用的当前用户别名
* bmxToken: String
推送初始化的时候App传入的使用的用户的token，无用户的状态下不传入即可。
* callBack: BMXCallBack
BMXErrorCode
Returns void
start
* public void start(final String alias, final BMXCallBack callBack);
* Returns void
start
* public void start(final BMXCallBack callBack);
* Returns void
stop
* public void stop(final BMXCallBack callBack);
* 停止推送功能接口。
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
resume
* public void resume(final BMXCallBack callBack);
* 恢复推送功能接口。
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
unbindAlias
* public void unbindAlias(final String alias, final BMXCallBack callBack);
* 解除用户别名绑定。
Parameters
* alias: String
需要解除绑定的用户别名。
* callBack: BMXCallBack
BMXErrorCode
Returns void
getToken
* public String getToken();
* 获取登陆后使用的用户token。
Returns String
getCert
* public String getCert();
* 获取登陆后服务器返回的推送证书。
Returns String
status
* public BMXPushService.PushSdkStatus status();
* 推送sdk当前的状态。
Returns PushSdkStatus
bindDeviceToken
* public void bindDeviceToken(final String token, final BMXCallBack callBack);
* 推送绑定设备token。
Parameters
* token: String
设备的推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
bindVoipToken
* public void bindVoipToken(final String token, final BMXCallBack callBack);
* 绑定推送设备的voiptoken。
Parameters
* token: String
设备的voip推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
getPushProfile
* public void getPushProfile(final boolean forceRefresh, final BMXDataCallBack<BMXPushUserProfile> callBack);
* 获取推送用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
* callBack: <any>
推送用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息
Returns void
setTags
* public void setTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 设置推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
getTags
* public void getTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 获取推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
deleteTags
* public void deleteTags(final TagList tags, final String operationId, final BMXCallBack callBack);
* 删除推送用户的标签。
Parameters
* tags: TagList
要删除用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
clearTags
* public void clearTags(final String operationId, final BMXCallBack callBack);
* 清空推送用户的标签。
Parameters
* operationId: String
操作id。在回调通知中对应通知提醒。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setBadge
* public void setBadge(final int count, final BMXCallBack callBack);
* 设置推送用户的未读角标。
Parameters
* count: int
用户未读角标数
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushMode
* public void setPushMode(final boolean enable, final BMXCallBack callBack);
* 设置推送启用状态。默认为使用推送。
Parameters
* enable: boolean
推送的启用状态
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushMode
* public void setPushMode(final BMXCallBack callBack);
* Returns void
setPushTime
* public void setPushTime(final int startHour, final int endHour, final BMXCallBack callBack);
* 设置允许推送时间。
Parameters
* startHour: int
静默允许推送的起始时间小时
* endHour: int
静默允许推送的结束时间小时
* callBack: BMXCallBack
BMXErrorCode
Returns void
setSilenceTime
* public void setSilenceTime(final int startHour, final int endHour, final BMXCallBack callBack);
* 设置推送静默的起始结束时间。
Parameters
* startHour: int
静默推送的起始时间小时
* endHour: int
静默推送的结束时间小时
* callBack: BMXCallBack
BMXErrorCode
Returns void
setRunBackgroundMode
* public void setRunBackgroundMode(final boolean enable, final BMXCallBack callBack);
* 设置推送是否可以后台运行。默认是false。
Parameters
* enable: boolean
推送后台运行状态。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setRunBackgroundMode
* public void setRunBackgroundMode(final BMXCallBack callBack);
* Returns void
setGeoFenceMode
* public void setGeoFenceMode(final boolean enable, final boolean isAllow, final BMXCallBack callBack);
* 设置推送的地理围栏功能是否运行。
Parameters
* enable: boolean
地理围栏功能是否运行。
* isAllow: boolean
用户是否主动弹出用户定位请求。
* callBack: BMXCallBack
BMXErrorCode
Returns void
setGeoFenceMode
* public void setGeoFenceMode(final boolean enable, final BMXCallBack callBack);
* Returns void
setGeoFenceMode
* public void setGeoFenceMode(final BMXCallBack callBack);
* Returns void
clearNotification
* public void clearNotification(final long notificationId);
* 清除指定id的通知。
Parameters
* notificationId: long
通知id
Returns void
clearAllNotifications
* public void clearAllNotifications();
* Returns void
sendMessage
* public void sendMessage(final String content);
* 发送推送上行消息，消息状态变化会通过listener通知
Parameters
* content: String
发送的上行推送消息内容
Returns void
loadLocalPushMessages
* public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXPushService.PushDirection arg3, final BMXCallBack callBack);
* 加载数据库本地存储的推送消息。如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载推送消息的起始id
* size: long
最大加载消息条数
* result: BMXMessageList
数据库返回的加载本地推送消息列表
* arg3: PushDirection
加载推送消息的方向，默认是加载更早的消息
Returns void
loadLocalPushMessages
* public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXCallBack callBack);
* Returns void
addPushListener
* public void addPushListener(BMXPushServiceListener listener);
* 添加推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
removePushListener
* public void removePushListener(BMXPushServiceListener listener);
* 移除推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,844 |
BMXPushProviderType | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushProviderType
# BMXPushProviderType
最近更新时间: 2022-07-22 22:35:31
class im.floo.floolib.BMXPushProviderType
Index
字段
* Unknown
* APNS
* HuaWei
* XiaoMi
* MeiZu
* VIVO
* OPPS
* FCM
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Unknown
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) Unknown
*
APNS
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) APNS
*
HuaWei
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) HuaWei
*
XiaoMi
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) XiaoMi
*
MeiZu
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) MeiZu
*
VIVO
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) VIVO
*
OPPS
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) OPPS
*
FCM
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) FCM
*
方法
values
* public static im.floo.floolib.BMXPushProviderType[] values();
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
valueOf
* public static im.floo.floolib.BMXPushProviderType valueOf(java.lang.String name);
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXPushProviderType swigToEnum(int swigValue);
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushProviderType
# BMXPushProviderType
最近更新时间: 2022-07-22 22:35:31
class im.floo.floolib.BMXPushProviderType
Index
字段
* Unknown
* APNS
* HuaWei
* XiaoMi
* MeiZu
* VIVO
* OPPS
* FCM
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Unknown
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) Unknown
*
APNS
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) APNS
*
HuaWei
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) HuaWei
*
XiaoMi
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) XiaoMi
*
MeiZu
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) MeiZu
*
VIVO
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) VIVO
*
OPPS
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) OPPS
*
FCM
* public static final [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype) FCM
*
方法
values
* public static im.floo.floolib.BMXPushProviderType[] values();
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
valueOf
* public static im.floo.floolib.BMXPushProviderType valueOf(java.lang.String name);
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static BMXPushProviderType swigToEnum(int swigValue);
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,853 |
BMXPushService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushService
# BMXPushService
最近更新时间: 2022-07-22 22:40:33
class im.floo.floolib.BMXPushService
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* start
* start
* start
* stop
* resume
* unbindAlias
* getToken
* getCert
* status
* bindDeviceToken
* bindVoipToken
* getPushProfile
* setTags
* getTags
* deleteTags
* clearTags
* setBadge
* setPushMode
* setPushMode
* setPushTime
* setSilenceTime
* setRunBackgroundMode
* setRunBackgroundMode
* setGeoFenceMode
* setGeoFenceMode
* setGeoFenceMode
* clearNotification
* clearAllNotifications
* sendMessage
* loadLocalPushMessages
* loadLocalPushMessages
* addPushListener
* removePushListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXPushService obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
start
* public BMXErrorCode start(String alias, String bmxToken);
* 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。
Parameters
* alias: String
推送初始化使用的当前用户别名
* bmxToken: String
推送初始化的时候App传入的使用的用户的token，无用户的状态下不传入即可。
Returns BMXErrorCode
start
* public BMXErrorCode start(String alias);
* Returns BMXErrorCode
start
* public BMXErrorCode start();
* Returns BMXErrorCode
stop
* public BMXErrorCode stop();
* 停止推送功能接口。
Returns BMXErrorCode
resume
* public BMXErrorCode resume();
* 恢复推送功能接口。
Returns BMXErrorCode
unbindAlias
* public BMXErrorCode unbindAlias(String alias);
* 解除用户别名绑定。
Parameters
* alias: String
需要解除绑定的用户别名。
Returns BMXErrorCode
getToken
* public String getToken();
* 获取登陆后使用的用户token。
Returns String
getCert
* public String getCert();
* 获取登陆后服务器返回的推送证书。
Returns String
status
* public BMXPushService.PushSdkStatus status();
* 推送sdk当前的状态。
Returns PushSdkStatus
bindDeviceToken
* public BMXErrorCode bindDeviceToken(String token);
* 推送绑定设备token。
Parameters
* token: String
设备的推送token
Returns BMXErrorCode
bindVoipToken
* public BMXErrorCode bindVoipToken(String token);
* 绑定推送设备的voiptoken。
Parameters
* token: String
设备的voip推送token
Returns BMXErrorCode
getPushProfile
* public BMXErrorCode getPushProfile(BMXPushUserProfile pushProfile, boolean forceRefresh);
* 获取推送用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* pushProfile: [BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
推送用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息。
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
Returns BMXErrorCode
setTags
* public BMXErrorCode setTags(TagList tags, String operationId);
* 设置推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
getTags
* public BMXErrorCode getTags(TagList tags, String operationId);
* 获取推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
deleteTags
* public BMXErrorCode deleteTags(TagList tags, String operationId);
* 删除推送用户的标签。
Parameters
* tags: TagList
要删除用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
clearTags
* public BMXErrorCode clearTags(String operationId);
* 清空推送用户的标签。
Parameters
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
setBadge
* public BMXErrorCode setBadge(int count);
* 设置推送用户的未读角标。
Parameters
* count: int
用户未读角标数
Returns BMXErrorCode
setPushMode
* public BMXErrorCode setPushMode(boolean enable);
* 设置推送启用状态。默认为使用推送。
Parameters
* enable: boolean
推送的启用状态
Returns BMXErrorCode
setPushMode
* public BMXErrorCode setPushMode();
* Returns BMXErrorCode
setPushTime
* public BMXErrorCode setPushTime(int startHour, int endHour);
* 设置允许推送时间。
Parameters
* startHour: int
静默允许推送的起始时间小时
* endHour: int
静默允许推送的结束时间小时
Returns BMXErrorCode
setSilenceTime
* public BMXErrorCode setSilenceTime(int startHour, int endHour);
* 设置推送静默的起始结束时间。
Parameters
* startHour: int
静默推送的起始时间小时
* endHour: int
静默推送的结束时间小时
Returns BMXErrorCode
setRunBackgroundMode
* public BMXErrorCode setRunBackgroundMode(boolean enable);
* 设置推送是否可以后台运行。默认是false。
Parameters
* enable: boolean
推送后台运行状态。
Returns BMXErrorCode
setRunBackgroundMode
* public BMXErrorCode setRunBackgroundMode();
* Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode(boolean enable, boolean isAllow);
* 设置推送的地理围栏功能是否运行。
Parameters
* enable: boolean
地理围栏功能是否运行。
* isAllow: boolean
用户是否主动弹出用户定位请求。
Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode(boolean enable);
* Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode();
* Returns BMXErrorCode
clearNotification
* public void clearNotification(long notificationId);
* 清除指定id的通知。
Parameters
* notificationId: long
通知id
Returns void
clearAllNotifications
* public void clearAllNotifications();
* Returns void
sendMessage
* public void sendMessage(String content);
* 发送推送上行消息，消息状态变化会通过listener通知
Parameters
* content: String
发送的上行推送消息内容
Returns void
loadLocalPushMessages
* public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result, BMXPushService.PushDirection arg3);
* 加载数据库本地存储的推送消息。如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载推送消息的起始id
* size: long
最大加载消息条数
* result: BMXMessageList
数据库返回的加载本地推送消息列表
* arg3: PushDirection
加载推送消息的方向，默认是加载更早的消息
Returns BMXErrorCode
loadLocalPushMessages
* public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result);
* Returns BMXErrorCode
addPushListener
* public void addPushListener(BMXPushServiceListener listener);
* 添加推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
removePushListener
* public void removePushListener(BMXPushServiceListener listener);
* 移除推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushService
# BMXPushService
最近更新时间: 2022-07-22 22:40:33
class im.floo.floolib.BMXPushService
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* start
* start
* start
* stop
* resume
* unbindAlias
* getToken
* getCert
* status
* bindDeviceToken
* bindVoipToken
* getPushProfile
* setTags
* getTags
* deleteTags
* clearTags
* setBadge
* setPushMode
* setPushMode
* setPushTime
* setSilenceTime
* setRunBackgroundMode
* setRunBackgroundMode
* setGeoFenceMode
* setGeoFenceMode
* setGeoFenceMode
* clearNotification
* clearAllNotifications
* sendMessage
* loadLocalPushMessages
* loadLocalPushMessages
* addPushListener
* removePushListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXPushService obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
start
* public BMXErrorCode start(String alias, String bmxToken);
* 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。
Parameters
* alias: String
推送初始化使用的当前用户别名
* bmxToken: String
推送初始化的时候App传入的使用的用户的token，无用户的状态下不传入即可。
Returns BMXErrorCode
start
* public BMXErrorCode start(String alias);
* Returns BMXErrorCode
start
* public BMXErrorCode start();
* Returns BMXErrorCode
stop
* public BMXErrorCode stop();
* 停止推送功能接口。
Returns BMXErrorCode
resume
* public BMXErrorCode resume();
* 恢复推送功能接口。
Returns BMXErrorCode
unbindAlias
* public BMXErrorCode unbindAlias(String alias);
* 解除用户别名绑定。
Parameters
* alias: String
需要解除绑定的用户别名。
Returns BMXErrorCode
getToken
* public String getToken();
* 获取登陆后使用的用户token。
Returns String
getCert
* public String getCert();
* 获取登陆后服务器返回的推送证书。
Returns String
status
* public BMXPushService.PushSdkStatus status();
* 推送sdk当前的状态。
Returns PushSdkStatus
bindDeviceToken
* public BMXErrorCode bindDeviceToken(String token);
* 推送绑定设备token。
Parameters
* token: String
设备的推送token
Returns BMXErrorCode
bindVoipToken
* public BMXErrorCode bindVoipToken(String token);
* 绑定推送设备的voiptoken。
Parameters
* token: String
设备的voip推送token
Returns BMXErrorCode
getPushProfile
* public BMXErrorCode getPushProfile(BMXPushUserProfile pushProfile, boolean forceRefresh);
* 获取推送用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* pushProfile: [BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
推送用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息。
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
Returns BMXErrorCode
setTags
* public BMXErrorCode setTags(TagList tags, String operationId);
* 设置推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
getTags
* public BMXErrorCode getTags(TagList tags, String operationId);
* 获取推送用户的标签。
Parameters
* tags: TagList
用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
deleteTags
* public BMXErrorCode deleteTags(TagList tags, String operationId);
* 删除推送用户的标签。
Parameters
* tags: TagList
要删除用户标签
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
clearTags
* public BMXErrorCode clearTags(String operationId);
* 清空推送用户的标签。
Parameters
* operationId: String
操作id。在回调通知中对应通知提醒。
Returns BMXErrorCode
setBadge
* public BMXErrorCode setBadge(int count);
* 设置推送用户的未读角标。
Parameters
* count: int
用户未读角标数
Returns BMXErrorCode
setPushMode
* public BMXErrorCode setPushMode(boolean enable);
* 设置推送启用状态。默认为使用推送。
Parameters
* enable: boolean
推送的启用状态
Returns BMXErrorCode
setPushMode
* public BMXErrorCode setPushMode();
* Returns BMXErrorCode
setPushTime
* public BMXErrorCode setPushTime(int startHour, int endHour);
* 设置允许推送时间。
Parameters
* startHour: int
静默允许推送的起始时间小时
* endHour: int
静默允许推送的结束时间小时
Returns BMXErrorCode
setSilenceTime
* public BMXErrorCode setSilenceTime(int startHour, int endHour);
* 设置推送静默的起始结束时间。
Parameters
* startHour: int
静默推送的起始时间小时
* endHour: int
静默推送的结束时间小时
Returns BMXErrorCode
setRunBackgroundMode
* public BMXErrorCode setRunBackgroundMode(boolean enable);
* 设置推送是否可以后台运行。默认是false。
Parameters
* enable: boolean
推送后台运行状态。
Returns BMXErrorCode
setRunBackgroundMode
* public BMXErrorCode setRunBackgroundMode();
* Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode(boolean enable, boolean isAllow);
* 设置推送的地理围栏功能是否运行。
Parameters
* enable: boolean
地理围栏功能是否运行。
* isAllow: boolean
用户是否主动弹出用户定位请求。
Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode(boolean enable);
* Returns BMXErrorCode
setGeoFenceMode
* public BMXErrorCode setGeoFenceMode();
* Returns BMXErrorCode
clearNotification
* public void clearNotification(long notificationId);
* 清除指定id的通知。
Parameters
* notificationId: long
通知id
Returns void
clearAllNotifications
* public void clearAllNotifications();
* Returns void
sendMessage
* public void sendMessage(String content);
* 发送推送上行消息，消息状态变化会通过listener通知
Parameters
* content: String
发送的上行推送消息内容
Returns void
loadLocalPushMessages
* public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result, BMXPushService.PushDirection arg3);
* 加载数据库本地存储的推送消息。如果不指定则从最新消息开始
Parameters
* refMsgId: long
加载推送消息的起始id
* size: long
最大加载消息条数
* result: BMXMessageList
数据库返回的加载本地推送消息列表
* arg3: PushDirection
加载推送消息的方向，默认是加载更早的消息
Returns BMXErrorCode
loadLocalPushMessages
* public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result);
* Returns BMXErrorCode
addPushListener
* public void addPushListener(BMXPushServiceListener listener);
* 添加推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
removePushListener
* public void removePushListener(BMXPushServiceListener listener);
* 移除推送监听者
Parameters
* listener: [BMXPushServiceListener](https://developer.qiniu.com/IM/api/8314/bmxpushservicelistener)
推送监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,856 |
BMXPushService.PushDirection | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice) >
BMXPushService.PushDirection
# BMXPushService.PushDirection
最近更新时间: 2022-07-22 22:53:00
class im.floo.floolib.BMXPushService.PushDirection
本地推送消息搜索方向
Index
字段
* Up
* Down
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Up
* public static final PushDirection Up
*
Down
* public static final PushDirection Down
*
方法
values
* public static im.floo.floolib.BMXPushService.PushDirection[] values();
* Returns PushDirection
valueOf
* public static im.floo.floolib.BMXPushService.PushDirection valueOf(java.lang.String name);
* Returns PushDirection
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static PushDirection swigToEnum(int swigValue);
* Returns PushDirection
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice) >
BMXPushService.PushDirection
# BMXPushService.PushDirection
最近更新时间: 2022-07-22 22:53:00
class im.floo.floolib.BMXPushService.PushDirection
本地推送消息搜索方向
Index
字段
* Up
* Down
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Up
* public static final PushDirection Up
*
Down
* public static final PushDirection Down
*
方法
values
* public static im.floo.floolib.BMXPushService.PushDirection[] values();
* Returns PushDirection
valueOf
* public static im.floo.floolib.BMXPushService.PushDirection valueOf(java.lang.String name);
* Returns PushDirection
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static PushDirection swigToEnum(int swigValue);
* Returns PushDirection
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,866 |
BMXPushService.PushSdkStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice) >
BMXPushService.PushSdkStatus
# BMXPushService.PushSdkStatus
最近更新时间: 2022-07-22 22:45:34
class im.floo.floolib.BMXPushService.PushSdkStatus
push sdk状态
Index
字段
* Starting
* Started
* Stoped
* Offline
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Starting
* public static final PushSdkStatus Starting
*
Started
* public static final PushSdkStatus Started
*
Stoped
* public static final PushSdkStatus Stoped
*
Offline
* public static final PushSdkStatus Offline
*
方法
values
* public static im.floo.floolib.BMXPushService.PushSdkStatus[] values();
* Returns PushSdkStatus
valueOf
* public static im.floo.floolib.BMXPushService.PushSdkStatus valueOf(java.lang.String name);
* Returns PushSdkStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static PushSdkStatus swigToEnum(int swigValue);
* Returns PushSdkStatus
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice) >
BMXPushService.PushSdkStatus
# BMXPushService.PushSdkStatus
最近更新时间: 2022-07-22 22:45:34
class im.floo.floolib.BMXPushService.PushSdkStatus
push sdk状态
Index
字段
* Starting
* Started
* Stoped
* Offline
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Starting
* public static final PushSdkStatus Starting
*
Started
* public static final PushSdkStatus Started
*
Stoped
* public static final PushSdkStatus Stoped
*
Offline
* public static final PushSdkStatus Offline
*
方法
values
* public static im.floo.floolib.BMXPushService.PushSdkStatus[] values();
* Returns PushSdkStatus
valueOf
* public static im.floo.floolib.BMXPushService.PushSdkStatus valueOf(java.lang.String name);
* Returns PushSdkStatus
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static PushSdkStatus swigToEnum(int swigValue);
* Returns PushSdkStatus
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,868 |
BMXPushUserProfile | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushUserProfile
# BMXPushUserProfile
最近更新时间: 2022-07-22 22:43:17
class im.floo.floolib.BMXPushUserProfile
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* userId
* pushAlias
* pushToken
* messagePushSetting
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXPushUserProfile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
userId
* public long userId();
* Returns long
pushAlias
* public String pushAlias();
* Returns String
pushToken
* public String pushToken();
* Returns String
messagePushSetting
* public BMXPushUserProfile.MessagePushSetting messagePushSetting();
* Returns MessagePushSetting
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushUserProfile
# BMXPushUserProfile
最近更新时间: 2022-07-22 22:43:17
class im.floo.floolib.BMXPushUserProfile
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* userId
* pushAlias
* pushToken
* messagePushSetting
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXPushUserProfile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
userId
* public long userId();
* Returns long
pushAlias
* public String pushAlias();
* Returns String
pushToken
* public String pushToken();
* Returns String
messagePushSetting
* public BMXPushUserProfile.MessagePushSetting messagePushSetting();
* Returns MessagePushSetting
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,870 |
BMXPushUserProfile.MessagePushSetting | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
> BMXPushUserProfile.MessagePushSetting
# BMXPushUserProfile.MessagePushSetting
最近更新时间: 2022-07-22 23:01:05
class im.floo.floolib.BMXPushUserProfile.MessagePushSetting
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMPushEnabled
* getMPushEnabled
* setMSilenceStartTime
* getMSilenceStartTime
* setMSilenceEndTime
* getMSilenceEndTime
* setMPushStartTime
* getMPushStartTime
* setMPushEndTime
* getMPushEndTime
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(MessagePushSetting obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMPushEnabled
* public void setMPushEnabled(boolean value);
* Returns void
getMPushEnabled
* public boolean getMPushEnabled();
* Returns boolean
setMSilenceStartTime
* public void setMSilenceStartTime(int value);
* Returns void
getMSilenceStartTime
* public int getMSilenceStartTime();
* Returns int
setMSilenceEndTime
* public void setMSilenceEndTime(int value);
* Returns void
getMSilenceEndTime
* public int getMSilenceEndTime();
* Returns int
setMPushStartTime
* public void setMPushStartTime(int value);
* Returns void
getMPushStartTime
* public int getMPushStartTime();
* Returns int
setMPushEndTime
* public void setMPushEndTime(int value);
* Returns void
getMPushEndTime
* public int getMPushEndTime();
* Returns int
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXPushUserProfile](https://developer.qiniu.com/IM/api/8271/bmxpushuserprofile)
> BMXPushUserProfile.MessagePushSetting
# BMXPushUserProfile.MessagePushSetting
最近更新时间: 2022-07-22 23:01:05
class im.floo.floolib.BMXPushUserProfile.MessagePushSetting
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMPushEnabled
* getMPushEnabled
* setMSilenceStartTime
* getMSilenceStartTime
* setMSilenceEndTime
* getMSilenceEndTime
* setMPushStartTime
* getMPushStartTime
* setMPushEndTime
* getMPushEndTime
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(MessagePushSetting obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMPushEnabled
* public void setMPushEnabled(boolean value);
* Returns void
getMPushEnabled
* public boolean getMPushEnabled();
* Returns boolean
setMSilenceStartTime
* public void setMSilenceStartTime(int value);
* Returns void
getMSilenceStartTime
* public int getMSilenceStartTime();
* Returns int
setMSilenceEndTime
* public void setMSilenceEndTime(int value);
* Returns void
getMSilenceEndTime
* public int getMSilenceEndTime();
* Returns int
setMPushStartTime
* public void setMPushStartTime(int value);
* Returns void
getMPushStartTime
* public int getMPushStartTime();
* Returns int
setMPushEndTime
* public void setMPushEndTime(int value);
* Returns void
getMPushEndTime
* public int getMPushEndTime();
* Returns int
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,872 |
BMXRosterItem | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterItem
# BMXRosterItem
最近更新时间: 2022-07-22 22:35:38
class im.floo.floolib.BMXRosterItem
联系人
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* rosterId
* username
* nickname
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailUrl
* avatarThumbnailPath
* publicInfo
* alias
* ext
* localExt
* relation
* isMuteNotification
* addFriendAuthMode
* authQuestion
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXRosterItem obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
rosterId
* public long rosterId();
* 好友Id
Returns long
username
* public String username();
* 好友名
Returns String
nickname
* public String nickname();
* 好友昵称
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 好友头像ratel服务器地址
Returns String
avatarUrl
* public String avatarUrl();
* 好友头像服务器地址
Returns String
avatarPath
* public String avatarPath();
* 好友头像本地存储路径
Returns String
avatarThumbnailUrl
* public String avatarThumbnailUrl();
* 好友头像缩略图地址
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 好友头像缩略图本地存储路径
Returns String
publicInfo
* public String publicInfo();
* 扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
Returns String
alias
* public String alias();
* 用户对好友添加的备注等信息
Returns String
ext
* public String ext();
* 用户的服务器扩展信息
Returns String
localExt
* public String localExt();
* 用户的本地扩展信息
Returns String
relation
* public BMXRosterItem.RosterRelation relation();
* 联系人关系
Returns RosterRelation
isMuteNotification
* public boolean isMuteNotification();
* 是否提醒用户消息
Returns boolean
addFriendAuthMode
* public BMXRosterItem.AddFriendAuthMode addFriendAuthMode();
* roster的好友添加验证方式。
Returns AddFriendAuthMode
authQuestion
* public String authQuestion();
* roster的好友验证问题。
Returns String
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterItem
# BMXRosterItem
最近更新时间: 2022-07-22 22:35:38
class im.floo.floolib.BMXRosterItem
联系人
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* rosterId
* username
* nickname
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailUrl
* avatarThumbnailPath
* publicInfo
* alias
* ext
* localExt
* relation
* isMuteNotification
* addFriendAuthMode
* authQuestion
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXRosterItem obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
rosterId
* public long rosterId();
* 好友Id
Returns long
username
* public String username();
* 好友名
Returns String
nickname
* public String nickname();
* 好友昵称
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 好友头像ratel服务器地址
Returns String
avatarUrl
* public String avatarUrl();
* 好友头像服务器地址
Returns String
avatarPath
* public String avatarPath();
* 好友头像本地存储路径
Returns String
avatarThumbnailUrl
* public String avatarThumbnailUrl();
* 好友头像缩略图地址
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 好友头像缩略图本地存储路径
Returns String
publicInfo
* public String publicInfo();
* 扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
Returns String
alias
* public String alias();
* 用户对好友添加的备注等信息
Returns String
ext
* public String ext();
* 用户的服务器扩展信息
Returns String
localExt
* public String localExt();
* 用户的本地扩展信息
Returns String
relation
* public BMXRosterItem.RosterRelation relation();
* 联系人关系
Returns RosterRelation
isMuteNotification
* public boolean isMuteNotification();
* 是否提醒用户消息
Returns boolean
addFriendAuthMode
* public BMXRosterItem.AddFriendAuthMode addFriendAuthMode();
* roster的好友添加验证方式。
Returns AddFriendAuthMode
authQuestion
* public String authQuestion();
* roster的好友验证问题。
Returns String
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,875 |
BMXRosterItem.AddFriendAuthMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem) >
BMXRosterItem.AddFriendAuthMode
# BMXRosterItem.AddFriendAuthMode
最近更新时间: 2022-07-22 22:39:50
class im.floo.floolib.BMXRosterItem.AddFriendAuthMode
roster 被申请加好友时的验证方式
Index
字段
* Open
* NeedApproval
* AnswerQuestion
* RejectAll
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Open
* public static final AddFriendAuthMode Open
*
NeedApproval
* public static final AddFriendAuthMode NeedApproval
*
AnswerQuestion
* public static final AddFriendAuthMode AnswerQuestion
*
RejectAll
* public static final AddFriendAuthMode RejectAll
*
方法
values
* public static im.floo.floolib.BMXRosterItem.AddFriendAuthMode[] values();
* Returns AddFriendAuthMode
valueOf
* public static im.floo.floolib.BMXRosterItem.AddFriendAuthMode valueOf(java.lang.String name);
* Returns AddFriendAuthMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static AddFriendAuthMode swigToEnum(int swigValue);
* Returns AddFriendAuthMode
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem) >
BMXRosterItem.AddFriendAuthMode
# BMXRosterItem.AddFriendAuthMode
最近更新时间: 2022-07-22 22:39:50
class im.floo.floolib.BMXRosterItem.AddFriendAuthMode
roster 被申请加好友时的验证方式
Index
字段
* Open
* NeedApproval
* AnswerQuestion
* RejectAll
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Open
* public static final AddFriendAuthMode Open
*
NeedApproval
* public static final AddFriendAuthMode NeedApproval
*
AnswerQuestion
* public static final AddFriendAuthMode AnswerQuestion
*
RejectAll
* public static final AddFriendAuthMode RejectAll
*
方法
values
* public static im.floo.floolib.BMXRosterItem.AddFriendAuthMode[] values();
* Returns AddFriendAuthMode
valueOf
* public static im.floo.floolib.BMXRosterItem.AddFriendAuthMode valueOf(java.lang.String name);
* Returns AddFriendAuthMode
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static AddFriendAuthMode swigToEnum(int swigValue);
* Returns AddFriendAuthMode
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,879 |
BMXRosterItem.RosterRelation | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem) >
BMXRosterItem.RosterRelation
# BMXRosterItem.RosterRelation
最近更新时间: 2022-07-22 22:51:57
class im.floo.floolib.BMXRosterItem.RosterRelation
好友关系
Index
字段
* Friend
* Deleted
* Stranger
* Blocked
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Friend
* public static final RosterRelation Friend
*
Deleted
* public static final RosterRelation Deleted
*
Stranger
* public static final RosterRelation Stranger
*
Blocked
* public static final RosterRelation Blocked
*
方法
values
* public static im.floo.floolib.BMXRosterItem.RosterRelation[] values();
* Returns RosterRelation
valueOf
* public static im.floo.floolib.BMXRosterItem.RosterRelation valueOf(java.lang.String name);
* Returns RosterRelation
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static RosterRelation swigToEnum(int swigValue);
* Returns RosterRelation
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem) >
BMXRosterItem.RosterRelation
# BMXRosterItem.RosterRelation
最近更新时间: 2022-07-22 22:51:57
class im.floo.floolib.BMXRosterItem.RosterRelation
好友关系
Index
字段
* Friend
* Deleted
* Stranger
* Blocked
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Friend
* public static final RosterRelation Friend
*
Deleted
* public static final RosterRelation Deleted
*
Stranger
* public static final RosterRelation Stranger
*
Blocked
* public static final RosterRelation Blocked
*
方法
values
* public static im.floo.floolib.BMXRosterItem.RosterRelation[] values();
* Returns RosterRelation
valueOf
* public static im.floo.floolib.BMXRosterItem.RosterRelation valueOf(java.lang.String name);
* Returns RosterRelation
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static RosterRelation swigToEnum(int swigValue);
* Returns RosterRelation
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,881 |
BMXRosterManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterManager
# BMXRosterManager
最近更新时间: 2022-07-22 22:42:39
class im.floo.floolib.BMXRosterManager
好友管理器
Index
方法
* get
* search
* search
* search
* setItemExtension
* setItemAlias
* setItemMuteNotification
* apply
* remove
* getApplicationList
* accept
* decline
* block
* unblock
* getBlockList
* downloadAvatar
* addRosterListener
* removeRosterListener
方法
get
* public void get(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取好友列表，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
* callBack: <any>
BMXErrorCode 好友id列表
Returns void
search
* public void search(final long rosterId, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* callBack: <any>
BMXErrorCode 查询返回的用户的信息
Returns void
search
* public void search(final String name, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* callBack: <any>
BMXErrorCode 查询返回的用户的信息
Returns void
search
* public void search(final ListOfLongLong rosterIdList, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItemList> callBack);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
* callBack: <any>
BMXErrorCode 返回的好友信息列表
Returns void
setItemExtension
* public void setItemExtension(final BMXRosterItem item, final String extension, final BMXCallBack callBack);
* 更新好友本地扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
本地扩展信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
setItemAlias
* public void setItemAlias(final BMXRosterItem item, final String alias, final BMXCallBack callBack);
* 更新好友别名
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* alias: String
好友别名
* callBack: BMXCallBack
BMXErrorCode
Returns void
setItemMuteNotification
* public void setItemMuteNotification(final BMXRosterItem item, final boolean status, final BMXCallBack callBack);
* 设置是否拒收用户消息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* status: boolean
是否拒收用户消息，true拒收，false不拒收
* callBack: BMXCallBack
BMXErrorCode
Returns void
apply
* public void apply(final long rosterId, final String message, final BMXCallBack callBack);
* 申请添加好友
Parameters
* rosterId: long
申请添加的用户id
* message: String
好友申请信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
remove
* public void remove(final long rosterId, final BMXCallBack callBack);
* 删除好友
Parameters
* rosterId: long
删除的好友id
* callBack: BMXCallBack
BMXErrorCode
Returns void
getApplicationList
* public void getApplicationList(final String cursor, final int pageSize, final BMXDataCallBack<ApplicationPage> callBack);
* 获取申请添加好友列表
Parameters
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
* callBack: <any>
BMXErrorCode 返回的申请好友列表信息
Returns void
accept
* public void accept(final long rosterId, final BMXCallBack callBack);
* 接受加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
decline
* public void decline(final long rosterId, final String reason, final BMXCallBack callBack);
* 拒绝加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* reason: String
拒绝的原因
* callBack: BMXCallBack
BMXErrorCode
Returns void
block
* public void block(final long rosterId, final BMXCallBack callBack);
* 加入黑名单
Parameters
* rosterId: long
加入黑名单的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
unblock
* public void unblock(final long rosterId, final BMXCallBack callBack);
* 从黑名单移除
Parameters
* rosterId: long
从黑名单移除的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
getBlockList
* public void getBlockList(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取黑名单，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
* callBack: <any>
BMXErrorCode 好友id列表
Returns void
downloadAvatar
* public void downloadAvatar(final BMXRosterItem item, final FileProgressListener listener, final BMXCallBack callBack);
* 下载头像
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* listener: FileProgressListener
下载回调函数
* callBack: BMXCallBack
BMXErrorCode
Returns void
addRosterListener
* public void addRosterListener(BMXRosterServiceListener listener);
* 添加好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
removeRosterListener
* public void removeRosterListener(BMXRosterServiceListener listener);
* 移除好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterManager
# BMXRosterManager
最近更新时间: 2022-07-22 22:42:39
class im.floo.floolib.BMXRosterManager
好友管理器
Index
方法
* get
* search
* search
* search
* setItemExtension
* setItemAlias
* setItemMuteNotification
* apply
* remove
* getApplicationList
* accept
* decline
* block
* unblock
* getBlockList
* downloadAvatar
* addRosterListener
* removeRosterListener
方法
get
* public void get(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取好友列表，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
* callBack: <any>
BMXErrorCode 好友id列表
Returns void
search
* public void search(final long rosterId, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* callBack: <any>
BMXErrorCode 查询返回的用户的信息
Returns void
search
* public void search(final String name, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* callBack: <any>
BMXErrorCode 查询返回的用户的信息
Returns void
search
* public void search(final ListOfLongLong rosterIdList, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItemList> callBack);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
* callBack: <any>
BMXErrorCode 返回的好友信息列表
Returns void
setItemExtension
* public void setItemExtension(final BMXRosterItem item, final String extension, final BMXCallBack callBack);
* 更新好友本地扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
本地扩展信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
setItemAlias
* public void setItemAlias(final BMXRosterItem item, final String alias, final BMXCallBack callBack);
* 更新好友别名
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* alias: String
好友别名
* callBack: BMXCallBack
BMXErrorCode
Returns void
setItemMuteNotification
* public void setItemMuteNotification(final BMXRosterItem item, final boolean status, final BMXCallBack callBack);
* 设置是否拒收用户消息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* status: boolean
是否拒收用户消息，true拒收，false不拒收
* callBack: BMXCallBack
BMXErrorCode
Returns void
apply
* public void apply(final long rosterId, final String message, final BMXCallBack callBack);
* 申请添加好友
Parameters
* rosterId: long
申请添加的用户id
* message: String
好友申请信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
remove
* public void remove(final long rosterId, final BMXCallBack callBack);
* 删除好友
Parameters
* rosterId: long
删除的好友id
* callBack: BMXCallBack
BMXErrorCode
Returns void
getApplicationList
* public void getApplicationList(final String cursor, final int pageSize, final BMXDataCallBack<ApplicationPage> callBack);
* 获取申请添加好友列表
Parameters
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
* callBack: <any>
BMXErrorCode 返回的申请好友列表信息
Returns void
accept
* public void accept(final long rosterId, final BMXCallBack callBack);
* 接受加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
decline
* public void decline(final long rosterId, final String reason, final BMXCallBack callBack);
* 拒绝加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* reason: String
拒绝的原因
* callBack: BMXCallBack
BMXErrorCode
Returns void
block
* public void block(final long rosterId, final BMXCallBack callBack);
* 加入黑名单
Parameters
* rosterId: long
加入黑名单的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
unblock
* public void unblock(final long rosterId, final BMXCallBack callBack);
* 从黑名单移除
Parameters
* rosterId: long
从黑名单移除的用户id
* callBack: BMXCallBack
BMXErrorCode
Returns void
getBlockList
* public void getBlockList(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
* 获取黑名单，如果forceRefresh == true，则强制从服务端拉取
Parameters
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
* callBack: <any>
BMXErrorCode 好友id列表
Returns void
downloadAvatar
* public void downloadAvatar(final BMXRosterItem item, final FileProgressListener listener, final BMXCallBack callBack);
* 下载头像
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* listener: FileProgressListener
下载回调函数
* callBack: BMXCallBack
BMXErrorCode
Returns void
addRosterListener
* public void addRosterListener(BMXRosterServiceListener listener);
* 添加好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
removeRosterListener
* public void removeRosterListener(BMXRosterServiceListener listener);
* 移除好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,883 |
Subsets and Splits