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 notification

Kind: event emitted by types

Example

{category: 'loginMessage',desc: 'socket connecting...'} // Start connecting
{category: 'loginMessage',desc: 'socket connect success...'} // Connected
{category: 'loginMessage',desc: 'logining socket service...'} // Start logging in
{category: 'loginMessage',desc: 'login socket failure ......'} // Login failed
{category: 'loginMessage',desc: 'login socket success.....'} // Login succeeded
{category: 'loginMessage', desc: 'getting token...' } //Get token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // Getting token succeeded, start to fetch friend list
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // Friend list fetching failed
{category: 'action', desc: 'relogin' } // Need to automatically login
{category: 'action', desc: 'relogin_manually' }  // Need to manually login
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // Conversation deleted. id: conversation ID; source: origin
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // User password changed
{category: 'userNotice', desc:'FROZEN'} // User account frozen
{category: 'userNotice', desc:'REMOVED'} // User removed
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // Signed out by another session on the same device
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // Signed out by a session on another device
{category: 'userNotice', desc:'INFO_UPDATED'} // User information changed:profile or setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // User's other device logged-in
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // User's other device logged-out
{category: 'userNotice', desc:'DEVICE_ADDED'} // New device notified
{category: 'userNotice', desc:'DEVICE_REMOVED'} // Device removal notified
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // The user's cluster changed; sign in again

"flooError" (res)#

FlooError

Kind: event emitted by types

Example

{category: 'USER_BANNED', desc:'User is banned'}
{category: 'USER_FROZEN', desc:'User is frozen, please contact App Admin.'}
{category: 'APP_FROZEN', desc:'APP is frozen, please login Lanying IM Console for more details.'}
{category: 'LICENSE', desc:'Invalid LICENSE. Check that the service subscription is current.'}
{category: 'LICENSE', desc:'LICENSE user limit exceeded. Upgrade the service plan.'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS error: server unreachable

"loginFail" (desc)#

Login failed

Kind: event emitted by types

"loginSuccess" (res)#

Login successful

Kind: event emitted by types

"onGroupListUpdate" (meta)#

Group list updated

Kind: event emitted by types

"onGroupMemberChanged" (groupId)#

Group member list updated

Kind: event emitted by types

"onGroupMessage" (meta)#

Group message received

Kind: event emitted by types

"onInputStatusMessage" (res)#

The other party is typing

Kind: event emitted by types

"onMentionMessage" (meta)#

Group @message received

Kind: event emitted by types

"onMessageCanceled" (res)#

Message is re-unread

Kind: event emitted by types

"onMessageDeleted" (res)#

MessageDeleted

Kind: event emitted by types

"onMessageRecalled" (res)#

Message is withdrawn

Kind: event emitted by types

"onMessageStatusChanged" (res)#

Message status changed: withdrawn/deleted/read

Kind: event emitted by types

"onReceiveHistoryMsg" (res)#

Message history received

Kind: event emitted by types

"onRosterInfoUpdate" (res)#

Friend info changed

Kind: event emitted by types

"onRosterListUpdate" (meta)#

Friend list changed

Kind: event emitted by types

"onRosterApplied" (meta)#

Friend application received

Kind: event emitted by types

"onRosterMessage" (meta)#

Single chat message received

Kind: event emitted by types

"onRosterRTCMessage" (meta)#

Received a one-to-one voice & video message

Kind: event emitted by types

"onSendingMessageStatusChanged" (res)#

Message sending status changed

Kind: event emitted by types

"onUnreadChange" (cid)#

Unread count changed

Kind: event emitted by types

"recentlistUpdate"#

Latest conversation updated

Kind: event emitted by types

"onGroupCreated" (meta)#

Group creation notification

Kind: event emitted by types

"onGroupDestoryed" (meta)#

Group dismissal notification

Kind: event emitted by types

"onGroupJoined" (meta)#

Member joining application notification

Kind: event emitted by types

"onGroupLeaved" (meta)#

Group member left notification

Kind: event emitted by types

"onGroupKicked" (meta)#

Group member removed notification

Kind: event emitted by types

"onGroupApplyAccepted" (meta)#

Group joining application approved

Kind: event emitted by types

"onGroupApplyDeclined" (meta)#

Group joining application rejected

Kind: event emitted by types

"onGroupBaned" (meta)#

Banned in group

Kind: event emitted by types

"onGroupUnbaned" (meta)#

Unbanned in group

Kind: event emitted by types

"onRosterMessageContentAppend" (meta)#

Received appended content for a one-to-one message

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#

Friend info

Kind: inner typedef of types
Properties

types~UserSettings : object#

User settings information

Kind: inner typedef of types
Properties

types~UserProfile : object#

User information

Kind: inner typedef of types
Properties

types~Meta : object#

Message body

Kind: inner typedef of types
Properties

types~RosterApplication : object#

List entries of adding friend request

Kind: inner typedef of types
Properties

types~GroupInfoAndSettings : object#

Group info

Kind: inner typedef of types
Properties

types~BriefGroupInfoAndSettings : object#

Group profile and user settings

Kind: inner typedef of types
Properties

types~GroupMember : object#

Group member format

Kind: inner typedef of types
Properties

types~GroupMemberBanned : object#

Banned members

Kind: inner typedef of types
Properties

types~GroupUserRelationResponse : object#

Group user's request result

Kind: inner typedef of types
Properties

types~GroupAnnouncement : object#

GroupAnnouncement content

Kind: inner typedef of types
Properties

types~GroupInfoRequest : object#

Create group

Kind: inner typedef of types
Properties

types~GroupBannedMemberRequest : object#

Ban request

Kind: inner typedef of types
Properties

types~GroupBlockedListItem : object#

Group blacklist

Kind: inner typedef of types
Properties

types~GroupInvitation : object#

Group invitation info

Kind: inner typedef of types
Properties

types~GroupApplication : object#

GroupMembership application information

Kind: inner typedef of types
Properties

types~GroupSharedFile : object#

Returned format of group shared files

Kind: inner typedef of types
Properties

types~GroupSharedFileResponse : object#

Result of group shared files deletion

Kind: inner typedef of types
Properties

types~GroupBanAllResponse : object#

Result of banning all members

Kind: inner typedef of types
Properties

types~FileUpload : object#

File uploading info

Kind: inner typedef of types
Properties

types~FileUploadResult : object#

File uploading result

Kind: inner typedef of types
Properties

types~fileUploadProgress : function#

FileUpload progressCallback

Kind: inner typedef of types

types~ConversationItem : object#

Conversation info

Kind: inner typedef of types
Properties

types~UserProfile : object#

User information

Kind: inner typedef of types
Properties

types~UserSettings : object#

User settings information

Kind: inner typedef of types
Properties

types~Event : string#

Listening event name

Kind: inner typedef of types

types~EventCallback : function#

Listening event callback

Kind: inner typedef of types