types

types

• types
  • “flooNotice” (res)
  • “flooError” (res)
  • “loginFail” (desc)
  • “loginSuccess” (res)
  • “onGroupListUpdate” (meta)
  • “onGroupMemberChanged” (groupId)
  • “onGroupMessage” (meta)
  • “onInputStatusMessage” (res)
  • “onMentionMessage” (meta)
  • “onMessageCanceled” (res)
  • “onMessageDeleted” (res)
  • “onMessageRecalled” (res)
  • “onMessageStatusChanged” (res)
  • “onReceiveHistoryMsg” (res)
  • “onRosterInfoUpdate” (res)
  • “onRosterListUpdate” (meta)
  • “onRosterMessage” (meta)
  • “onSendingMessageStatusChanged” (res)
  • “onUnreadChange” (cid)
  • “recentlistUpdate”
  • “onGroupCreated” (meta)
  • “onGroupDestoryed” (meta)
  • “onGroupJoined” (meta)
  • “onGroupApplyAccepted” (meta)
  • “onGroupApplyDeclined” (meta)
  • “onGroupBaned” (meta)
  • “onGroupUnbaned” (meta)
  • ~RosterItem
  • ~UserSettings
  • ~UserProfile
  • ~Meta
  • ~RosterApplication
  • ~GroupInfoAndSettings
  • ~BriefGroupInfoAndSettings
  • ~GroupMember
  • ~GroupMemberBanned
  • ~GroupUserRelationResponse
  • ~GroupAnnouncement
  • ~GroupInfoRequest
  • ~GroupBannedMemberRequest
  • ~GroupBlockedListItem
  • ~GroupInvitation
  • ~GroupApplication
  • ~GroupSharedFile
  • ~GroupSharedFileResponse
  • ~GroupBanAllResponse
  • ~FileUpload
  • ~FileUploadResult
  • ~fileUploadProgress
  • ~ConversationItem
  • ~UserProfile
  • ~UserSettings
  • ~Event
  • ~EventCallback

“flooNotice” (res)

Floo通知

Kind: event emitted by types

Example

{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' }  // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录

“flooError” (res)

Floo错误

Kind: event emitted by types

Example

{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问

“loginFail” (desc)

登录失败

Kind: event emitted by types

“loginSuccess” (res)

登录成功

Kind: event emitted by types

“onGroupListUpdate” (meta)

群列表更新

Kind: event emitted by types

“onGroupMemberChanged” (groupId)

群成员列表更新

Kind: event emitted by types

“onGroupMessage” (meta)

收到群消息

Kind: event emitted by types

“onInputStatusMessage” (res)

对方正在输入

Kind: event emitted by types

“onMentionMessage” (meta)

收到群组@消息

Kind: event emitted by types

“onMessageCanceled” (res)

消息被取消已读

Kind: event emitted by types

“onMessageDeleted” (res)

消息被删除

Kind: event emitted by types

“onMessageRecalled” (res)

消息被撤回

Kind: event emitted by types

“onMessageStatusChanged” (res)

消息状态变更：撤回/删除/已读

Kind: event emitted by types

“onReceiveHistoryMsg” (res)

收到历史消息

Kind: event emitted by types

“onRosterInfoUpdate” (res)

好友信息变更

Kind: event emitted by types

“onRosterListUpdate” (meta)

好友列表变更

Kind: event emitted by types

“onRosterMessage” (meta)

收到单聊消息

Kind: event emitted by types

“onSendingMessageStatusChanged” (res)

消息发送状态变更

Kind: event emitted by types

“onUnreadChange” (cid)

未读数改变

Kind: event emitted by types

“recentlistUpdate”

最近会话更新

Kind: event emitted by types

“onGroupCreated” (meta)

群组创建通知

Kind: event emitted by types

“onGroupDestoryed” (meta)

群组解散通知

Kind: event emitted by types

“onGroupJoined” (meta)

成员入群通知

Kind: event emitted by types

“onGroupApplyAccepted” (meta)

群申请被通过

Kind: event emitted by types

“onGroupApplyDeclined” (meta)

群申请被拒绝

Kind: event emitted by types

“onGroupBaned” (meta)

被群禁言

Kind: event emitted by types

“onGroupUnbaned” (meta)

被群取消禁言

Kind: event emitted by types

types~RosterItem : object

好友信息

Kind: inner typedef of types
Properties

types~UserSettings : object

用户设置信息

Kind: inner typedef of types
Properties

types~UserProfile : object

用户信息

Kind: inner typedef of types
Properties

types~Meta : object

消息体

Kind: inner typedef of types
Properties

types~RosterApplication : object

加好友申请列表项

Kind: inner typedef of types
Properties

types~GroupInfoAndSettings : object

群信息

Kind: inner typedef of types
Properties

types~BriefGroupInfoAndSettings : object

群简要信息及用户设置

Kind: inner typedef of types
Properties

types~GroupMember : object

群成员格式

Kind: inner typedef of types
Properties

types~GroupMemberBanned : object

禁言成员

Kind: inner typedef of types
Properties

types~GroupUserRelationResponse : object

群用户请求结果

Kind: inner typedef of types
Properties

types~GroupAnnouncement : object

群公告内容

Kind: inner typedef of types
Properties

types~GroupInfoRequest : object

创建群

Kind: inner typedef of types
Properties

types~GroupBannedMemberRequest : object

禁言请求

Kind: inner typedef of types
Properties

types~GroupBlockedListItem : object

群组黑名单

Kind: inner typedef of types
Properties

types~GroupInvitation : object

群组邀请信息

Kind: inner typedef of types
Properties

types~GroupApplication : object

群申请信息

Kind: inner typedef of types
Properties

types~GroupSharedFile : object

群共享文件返回格式

Kind: inner typedef of types
Properties

types~GroupSharedFileResponse : object

删除群共享文件结果

Kind: inner typedef of types
Properties

types~GroupBanAllResponse : object

全员禁言结果

Kind: inner typedef of types
Properties

types~FileUpload : object

文件上传信息

Kind: inner typedef of types
Properties

types~FileUploadResult : object

文件上传结果

Kind: inner typedef of types
Properties

types~fileUploadProgress : function

文件上传进度回调

Kind: inner typedef of types

types~ConversationItem : object

会话信息

Kind: inner typedef of types
Properties

types~UserProfile : object

用户信息

Kind: inner typedef of types
Properties

types~UserSettings : object

用户设置信息

Kind: inner typedef of types
Properties

types~Event : string

监听事件名称

Kind: inner typedef of types

types~EventCallback : function

监听事件回调

Kind: inner typedef of types