BeeWorks IM SDK Docs
v1
文档/Browser JS SDK/消息

@beeworks/imsdk

@beeworks/imsdk / message / MembershipMessage

MembershipMessage ​

群成员变更消息事件

Description ​

群成员变更消息事件

Extends ​

  • PushMessage

Properties ​

Message_Type_HandshakeMessage ​

static Message_Type_HandshakeMessage: number = 0b00001101

握手消息

Inherited from ​

PushMessage.Message_Type_HandshakeMessage

Message_Type_PingMessage ​

static Message_Type_PingMessage: number = 0b00100101

Ping消息

Inherited from ​

PushMessage.Message_Type_PingMessage

Message_Type_PongMessage ​

static Message_Type_PongMessage: number = 0b00101001

Pong消息

Inherited from ​

PushMessage.Message_Type_PongMessage

Message_Type_HelloMessage ​

static Message_Type_HelloMessage: number = 0b00010001

Hello消息

Inherited from ​

PushMessage.Message_Type_HelloMessage

Message_Type_PushMessage ​

static Message_Type_PushMessage: number = 0b00110001

Push消息

Inherited from ​

PushMessage.Message_Type_PushMessage

Message_Type_UndoMessage ​

static Message_Type_UndoMessage: number = 0b01001001

UnDo消息

Inherited from ​

PushMessage.Message_Type_UndoMessage

Message_Type_RemoveMessage ​

static Message_Type_RemoveMessage: number = 0b01000101

Remove消息

Inherited from ​

PushMessage.Message_Type_RemoveMessage

Message_Type_RejectMessage ​

static Message_Type_RejectMessage: number = 0b00000101

Reject 消息

Inherited from ​

PushMessage.Message_Type_RejectMessage

Message_Type_READ ​

static Message_Type_READ: number = 0b01000001

已读消息

Inherited from ​

PushMessage.Message_Type_READ

Message_Type_Confirm ​

static Message_Type_Confirm: number = 0b00001001

消息

Inherited from ​

PushMessage.Message_Type_Confirm

Message_Type_GoodBy ​

static Message_Type_GoodBy: number = 0b00000001

Goodbye 连接关闭（服务端到客户端）

Inherited from ​

PushMessage.Message_Type_GoodBy

Message_Type_Hello ​

static Message_Type_Hello: number = 0b00011001

Hello 设备握手响应

Inherited from ​

PushMessage.Message_Type_Hello

Message_Type_Up ​

static Message_Type_Up: number = 0b00011101

Up 设备上线

Inherited from ​

PushMessage.Message_Type_Up

Message_Type_Down ​

static Message_Type_Down: number = 0b00100001

Down 设备下线

Inherited from ​

PushMessage.Message_Type_Down

Message_Type_Write ​

static Message_Type_Write: number = 0b00110101

Write 消息输入中

Inherited from ​

PushMessage.Message_Type_Write

Message_Type_Check ​

static Message_Type_Check: number = 0b00111001

Check

Inherited from ​

PushMessage.Message_Type_Check

deliveryId ​

deliveryId: string = ''

消息ID

Inherited from ​

PushMessage.deliveryId

deliveryTime ​

deliveryTime: number

消息时间

Inherited from ​

PushMessage.deliveryTime

deliverySeq ​

deliverySeq: number | Long = -1

消息逻辑排序号

Inherited from ​

PushMessage.deliverySeq

fromId? ​

optional fromId: string

消息发送者ID

Inherited from ​

PushMessage.fromId

fromDomain? ​

optional fromDomain: string

消息发送者domainId

Inherited from ​

PushMessage.fromDomain

fromType? ​

optional fromType: ParticipantTypeFormat | CONV_C2C | CONV_C2G

消息发送者类型

Inherited from ​

PushMessage.fromType

toId? ​

optional toId: string

消息接收者ID

Inherited from ​

PushMessage.toId

toDomain? ​

optional toDomain: string

消息接收者domain

Inherited from ​

PushMessage.toDomain

bodyType? ​

optional bodyType: MessageType

消息类型

Inherited from ​

PushMessage.bodyType

atAll ​

atAll: boolean = false

是否@所有人

Inherited from ​

PushMessage.atAll

at ​

at: IContactFormat[] = []

联系人列表

Inherited from ​

PushMessage.at

toType? ​

optional toType: ParticipantTypeFormat | ConversationType

消息接收者类型

Inherited from ​

PushMessage.toType

status ​

status: SenderStatus = SenderStatus.Sended

消息发送状态

Inherited from ​

PushMessage.status

undoType ​

undoType: MessageUndoType = MessageUndoType.NONE

消息撤销类型

Inherited from ​

PushMessage.undoType

metadata ​

metadata: MessageMetadata

消息元数据

Inherited from ​

PushMessage.metadata

rawMetadata ​

rawMetadata: Record<string, string> = {}

服务端消息中的原始 metadata，用于保留 SDK 未建模的协议字段。

Inherited from ​

PushMessage.rawMetadata

readStatus? ​

optional readStatus: string

已读状态

Inherited from ​

PushMessage.readStatus

retries? ​

optional retries: number | null = 0

重发次数

Inherited from ​

PushMessage.retries

conversationId? ​

optional conversationId: string

消息会话ID

Inherited from ​

PushMessage.conversationId

conversationType? ​

optional conversationType: string

消息会话类型

Inherited from ​

PushMessage.conversationType

actionId? ​

optional actionId: string

响应的消息ID

Inherited from ​

PushMessage.actionId

actionTime? ​

optional actionTime: number

消息时间

Inherited from ​

PushMessage.actionTime

refreshTime? ​

optional refreshTime: number

消息更新时间

Inherited from ​

PushMessage.refreshTime

quote? ​

optional quote: any

引用消息（回复消息）

Inherited from ​

PushMessage.quote

read? ​

optional read: number

已读人数

Inherited from ​

PushMessage.read

readTime? ​

optional readTime: number

已读时间

Inherited from ​

PushMessage.readTime

platforms? ​

optional platforms: any = null

支持平台

Inherited from ​

PushMessage.platforms

MY_NAME ​

static MY_NAME: string = 'my_name'

消息体中包含的元数据的key

Inherited from ​

PushMessage.MY_NAME

Methods ​

updateBaseFromIMessage() ​

updateBaseFromIMessage(imessage): void

从IMessage中构建出一个消息

Parameters ​

imessage ​

IMessage

Returns ​

void

Inherited from ​

PushMessage.updateBaseFromIMessage

setMetadata() ​

setMetadata(context, content): void

设置消息体中包含的元数据

Parameters ​

context ​

any

content ​

any

Returns ​

void

Inherited from ​

PushMessage.setMetadata

updateBaseFromIMessageFormat() ​

updateBaseFromIMessageFormat(message): void

从IMessageFormat中构建出一个消息

Parameters ​

message ​

MessageFormat

Returns ​

void

Inherited from ​

PushMessage.updateBaseFromIMessageFormat

updateBaseInfo() ​

updateBaseInfo(pushFormat): void

解析消息的最基本的值

Parameters ​

pushFormat ​

PushFormat

Returns ​

void

Inherited from ​

PushMessage.updateBaseInfo

getConversationIdentifier() ​

getConversationIdentifier(): string

获取当前会话的identifier

Returns ​

string

Inherited from ​

PushMessage.getConversationIdentifier

isUserMessage() ​

isUserMessage(): boolean

是否是单聊消息

Returns ​

boolean

Inherited from ​

PushMessage.isUserMessage

isDiscussionMessage() ​

isDiscussionMessage(): boolean

是否是讨论组消息

Returns ​

boolean

Inherited from ​

PushMessage.isDiscussionMessage

isSenderMessage() ​

isSenderMessage(): boolean

是否是我发送的消息

Returns ​

boolean

Inherited from ​

PushMessage.isSenderMessage

isUndo() ​

isUndo(): boolean

消息是否已被撤回

Returns ​

boolean

Inherited from ​

PushMessage.isUndo

isMyNotice() ​

isMyNotice(): boolean

判断是否为我的通知

Returns ​

boolean

getOwnerId() ​

getOwnerId(): string

获取通知的 OwnerID

Returns ​

string

isSendByMyOtherDevice() ​

isSendByMyOtherDevice(): boolean

判断是否为我的其他设备发送

Returns ​

boolean

isDisucssionHelperMessage() ​

isDisucssionHelperMessage(): boolean

判断是否为群人员操作

Returns ​

boolean

isMeetingMessage() ​

isMeetingMessage(): boolean

判断是否为会议 Membership 消息。

Returns ​

boolean

getMeetingAttributes() ​

getMeetingAttributes(): Map<string, string>

返回会议消息属性。

Returns ​

Map<string, string>

getMeetingNo() ​

getMeetingNo(): string | undefined

返回会议号；即时呼优先使用协议约定的 instance_id。

Returns ​

string | undefined

getMeetingId() ​

getMeetingId(): string | undefined

返回即时呼业务标识；协议未提供时保留为空。

Returns ​

string | undefined

isImmediateCallMessage() ​

isImmediateCallMessage(): boolean

判断是否为即时呼 Membership 消息。

Returns ​

boolean

isMeetingStateMessage() ​

isMeetingStateMessage(): boolean

判断是否为普通会议状态 Membership 消息。

Returns ​

boolean

isCurrentUserParticipant() ​

isCurrentUserParticipant(): boolean

判断当前用户是否出现在参与者集合中。

Returns ​

boolean

isCurrentUserOperator() ​

isCurrentUserOperator(): boolean

判断当前用户是否为操作人。

Returns ​

boolean

emptyInstance() ​

static emptyInstance(): MembershipMessage

创建空的群成员变更消息实例

Returns ​

MembershipMessage

isProfileChangedMessage() ​

isProfileChangedMessage(): boolean

判断是否为个人信息变更消息

Returns ​

boolean

isNoticeChangedMessage() ​

isNoticeChangedMessage(): boolean

判断是否为公告变更消息

Returns ​

boolean

isApplyingFriendMessage() ​

isApplyingFriendMessage(): boolean

申请加好友的消息

Returns ​

boolean

getNotice() ​

getNotice(): string | undefined

获取公告内容

Returns ​

string | undefined

getMyName() ​

getMyName(): string

获取操作人姓名

Returns ​

string

isAdminOps() ​

isAdminOps(): boolean

判断是否来自后台管理员的操作

Returns ​

boolean

isOperatorOfMe() ​

isOperatorOfMe(): boolean

判断是否为操作人

Returns ​

boolean

isParticipantsIn() ​

isParticipantsIn(): boolean

判断是否为参与者

Returns ​

boolean

IM SDK代码示例 ↗