client/docs/passport/member.md

185 lines
4.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Member
relation-关系管理:群组
- [/group.Member/Fetch](#groupmemberfetch)
- [/group.Member/DoJoin](#groupmemberdojoin)
- [/group.Member/JoinFetch](#groupmemberjoinfetch)
- [/group.Member/JoinDoHandle](#groupmemberjoindohandle)
- [/group.Member/DoSetManager](#groupmemberdosetmanager)
- [/group.Member/DoKick](#groupmemberdokick)
- [/group.Member/DoQuit](#groupmemberdoquit)
## /group.Member/Fetch
获取群组成员列表
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
total: 0, // type<int32>, 总记录数
version: "0", // type<int64>, 版本号
members: [{
identity: "", // type<string>
nickname: "", // type<string>, 昵称
remark_name: "", // type<string>, 备注名称
avatar: "", // type<string>
sex: 0, // type<int32>, 性别1为男性2为女性
role: 0, // type<int32>, 角色,主要是群组内的角色使用
}], // list<PassportInfoSimpleCard>, 成员信息
}
```
## /group.Member/DoJoin
申请加群
### Request
```javascript
{
id: "0", // type<int64>, 群组ID
identity: "", // type<string>, 群组唯一码
message: "", // type<string>, 加群留言
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /group.Member/JoinFetch
申请加群列表
### Request
```javascript
{}
```
### Reply
```javascript
{
total: 0, // type<int32>, 总记录数
applys: [{
identity: "", // type<string>, 唯一标识
group_id: "0", // type<int64>, 主键
from: {
identity: "", // type<string>
nickname: "", // type<string>, 昵称
remark_name: "", // type<string>, 备注名称
popular: 0, // type<int32>, 是否置顶
avatar: "", // type<string>
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
tags: [""], // list<string>, 所属标签组
foreign_status: 0, // type<int32>, 外表的状态值,根据表不同,值的作用不同
}, // type<PassportInfoDetailCard>
message: "", // type<string>
created_at: "", // type<string>, 时间
status: 0, // type<int32>, 状态
}], // list<ApplyJoinGroupItem>, 群组信息
}
```
## /group.Member/JoinDoHandle
申请加群处理
### Request
```javascript
{
identity: "", // type<string>, 唯一标识
group_identity: "", // type<string>, 群组identity
direction: "", // type<string>, 操作方式Pass通过,Reject拒绝,Set设置,cancel取消
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /group.Member/DoSetManager
设置或取消管理员
### Request
```javascript
{
identity: "", // type<string>, 唯一标识
group_identity: "", // type<string>, 群组identity
direction: "", // type<string>, 操作方式Pass通过,Reject拒绝,Set设置,cancel取消
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /group.Member/DoKick
踢人
### Request
```javascript
{
identity: "", // type<string>, 唯一标识
group_identity: "", // type<string>, 群组identity
direction: "", // type<string>, 操作方式Pass通过,Reject拒绝,Set设置,cancel取消
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /group.Member/DoQuit
退群
### Request
```javascript
{
identity: "", // type<string>, 唯一标识
group_identity: "", // type<string>, 群组identity
direction: "", // type<string>, 操作方式Pass通过,Reject拒绝,Set设置,cancel取消
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```