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)
• "onRosterApplied" (meta)
• "onRosterMessage" (meta)
• "onRosterRTCMessage" (meta)
• "onSendingMessageStatusChanged" (res)
• "onUnreadChange" (cid)
• "recentlistUpdate"
• "onGroupCreated" (meta)
• "onGroupDestoryed" (meta)
• "onGroupJoined" (meta)
• "onGroupLeaved" (meta)
• "onGroupKicked" (meta)
• "onGroupApplyAccepted" (meta)
• "onGroupApplyDeclined" (meta)
• "onGroupBaned" (meta)
• "onGroupUnbaned" (meta)
• "onRosterMessageContentAppend" (meta)
• "onGroupMessageContentAppend" (meta)
• "onRosterMessageReplace" (meta)
• "onGroupMessageReplace" (meta)
• ~RosterItem : object
• ~UserSettings : object
• ~UserProfile : object
• ~Meta : object
• ~RosterApplication : object
• ~GroupInfoAndSettings : object
• ~BriefGroupInfoAndSettings : object
• ~GroupMember : object
• ~GroupMemberBanned : object
• ~GroupUserRelationResponse : object
• ~GroupAnnouncement : object
• ~GroupInfoRequest : object
• ~GroupBannedMemberRequest : object
• ~GroupBlockedListItem : object
• ~GroupInvitation : object
• ~GroupApplication : object
• ~GroupSharedFile : object
• ~GroupSharedFileResponse : object
• ~GroupBanAllResponse : object
• ~FileUpload : object
• ~FileUploadResult : object
• ~fileUploadProgress : function
• ~ConversationItem : object
• ~UserProfile : object
• ~UserSettings : object
• ~Event : string
• ~EventCallback : function

"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

"onRosterApplied" (meta)#

收到好友申請

Kind: event emitted by types

"onRosterMessage" (meta)#

收到單聊訊息

Kind: event emitted by types

"onRosterRTCMessage" (meta)#

收到單聊RTC訊息

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

"onGroupLeaved" (meta)#

成員退群通知

Kind: event emitted by types

"onGroupKicked" (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

"onRosterMessageContentAppend" (meta)#

收到單聊訊息內容追加

Kind: event emitted by types

"onGroupMessageContentAppend" (meta)#

Kind: event emitted by types

"onRosterMessageReplace" (meta)#

Kind: event emitted by types

"onGroupMessageReplace" (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