rosterManage#

Friend management

rosterManage
.asyncGetRosterIdList(force) ⇒ Promise.<Array.<number>>
.asyncGetRosterInfo(roster_id, force) ⇒ Promise.<RosterItem>
.asyncDeleteRoster(param) ⇒ Promise.<boolean>
.asnycGetRosterListDetailByIds(roster_ids) ⇒ Promise.<Array.<module:types~RosterItem>>
.getAllRosterDetail() ⇒ Array.<RosterItem>
.asyncGetUserProfile(force) ⇒ Promise.<UserProfile>
.getRosterMessageByRid(uid) ⇒ Array.<Meta>
.readRosterMessage(roster_id, mid)
.recallMessage(uid, mid)
.unreadMessage(uid, mid)
.deleteMessage(uid, mid)
.appendMessageContent(uid, mid, content)
.replaceMessage(uid, mid, content, config, ext)
.getRosterInfo(rid) ⇒ RosterItem
.getUnreadCount(uid) ⇒ number
.asyncGetApplyList(params) ⇒ Promise.<Array.<module:types~RosterApplication>>
.asyncGetBlockedlist(params) ⇒ Promise.<Array.<number>>
.asyncBlockeAdd(params) ⇒ Promise.<boolean>
.asyncBlockeRemove(params) ⇒ Promise.<boolean>
.asyncApply(params) ⇒ Promise.<boolean>
.asyncAccept(params) ⇒ Promise.<boolean>
.asyncDecline(params) ⇒ Promise.<boolean>
.asyncUpdateRosterExt(params) ⇒ Promise.<boolean>
.asyncUpdateRosterAlias(params) ⇒ Promise.<boolean>
.asyncSearchRosterByName(params) ⇒ Promise.<RosterItem>
.asyncSearchRosterById(params) ⇒ Promise.<RosterItem>

rosterManage.asyncGetRosterIdList(force) ⇒ `Promise.<Array.<number>>`#

Get friend id list

Kind: static method of rosterManage
Returns: Promise.<Array.<number>> - List of user IDs

Param	Type	Description
force	`boolean`	Whether to force pull from server: true - pull from server, false - pull from local storage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetRosterIdList" %}{% endlanying_code_snippet %}

rosterManage.asyncGetRosterInfo(roster_id, force) ⇒ `Promise.<RosterItem>`#

Get friend information

Kind: static method of rosterManage
Returns: Promise.<RosterItem> - Friend info

Param	Type	Description
roster_id	`number`	Friend ID
force	`boolean`	Whether to force pull from server: true - pull from server, false - prefer to pull from local storage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetRosterInfo" %}{% endlanying_code_snippet %}

rosterManage.asyncDeleteRoster(param) ⇒ `Promise.<boolean>`#

Delete friend

Kind: static method of rosterManage
Returns: Promise.<boolean> - Request results

Param	Type	Description
param	`object`	Parameter
param.user_id	`number`	Friend's user ID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncDeleteRoster" %}{% endlanying_code_snippet %}

rosterManage.asnycGetRosterListDetailByIds(roster_ids) ⇒ `Promise.<Array.<module:types~RosterItem>>`#

Get user details by id list

Kind: static method of rosterManage
Returns: Promise.<Array.<module:types~RosterItem>> - List of user details

Param	Type	Description
roster_ids	`Array.<number>`	List of user IDs

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asnycGetRosterListDetailByIds" %}{% endlanying_code_snippet %}

rosterManage.getAllRosterDetail() ⇒ `Array.<RosterItem>`#

Get all cached user details

Kind: static method of rosterManage
Returns: Array.<RosterItem> - List of user details
Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getAllRosterDetail" %}{% endlanying_code_snippet %}

rosterManage.asyncGetUserProfile(force) ⇒ `Promise.<UserProfile>`#

Get your own user info

Kind: static method of rosterManage
Returns: Promise.<UserProfile> - User information

Param	Type	Description
force	`boolean`	Whether to force pull from server: true - pull from server, false - prefer to pull from local storage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetUserProfile" %}{% endlanying_code_snippet %}

rosterManage.getRosterMessageByRid(uid) ⇒ `Array.<Meta>`#

Get chat messages based-on session ID

Kind: static method of rosterManage
Returns: Array.<Meta> - List of chat messages

Param	Type	Description
uid	`number`	SessionID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getRosterMessageByRid" %}{% endlanying_code_snippet %}

rosterManage.readRosterMessage(roster_id, mid)#

Modify message status to read

Kind: static method of rosterManage

Param	Type	Description
roster_id	`number`	SessionID
mid	`number`	MessageID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="readRosterMessage" %}{% endlanying_code_snippet %}

rosterManage.recallMessage(uid, mid)#

Revoke a message, only valid for last 5 minutes

Kind: static method of rosterManage

Param	Type	Description
uid	`number`	SessionID
mid	`number`	MessageID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="recallMessage" %}{% endlanying_code_snippet %}

rosterManage.unreadMessage(uid, mid)#

Set message to unread

Kind: static method of rosterManage

Param	Type	Description
uid	`number`	SessionID
mid	`number`	MessageID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="unreadMessage" %}{% endlanying_code_snippet %}

rosterManage.deleteMessage(uid, mid)#

Delete message

Kind: static method of rosterManage

Param	Type	Description
uid	`number`	SessionID
mid	`number`	MessageID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="deleteMessage" %}{% endlanying_code_snippet %}

rosterManage.appendMessageContent(uid, mid, content)#

Append message content

Kind: static method of rosterManage

Param	Type	Description
uid	`number`	SessionID
mid	`number`	MessageID
content	`string`	Appended message content

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="appendMessageContent" %}{% endlanying_code_snippet %}

rosterManage.replaceMessage(uid, mid, content, config, ext)#

Update message content

Kind: static method of rosterManage

Param	Type	Default	Description
uid	`number`		SessionID
mid	`number`		MessageID
content	`string`		Updated message content
config	`string` \| `object`	`null`	Updated message configuration
ext	`string` \| `object`	`null`	Updated message extension data

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="replaceMessage" %}{% endlanying_code_snippet %}

rosterManage.getRosterInfo(rid) ⇒ `RosterItem`#

Get friend information

Kind: static method of rosterManage
Returns: RosterItem - Friend info

Param	Type	Description
rid	`number`	Friend ID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getRosterInfo" %}{% endlanying_code_snippet %}

rosterManage.getUnreadCount(uid) ⇒ `number`#

Get the number of unread messages for a given conversation

Kind: static method of rosterManage
Returns: number - Number of unreads

Param	Type	Description
uid	`number`	SessionID

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getUnreadCount" %}{% endlanying_code_snippet %}

rosterManage.asyncGetApplyList(params) ⇒ `Promise.<Array.<module:types~RosterApplication>>`#

Get friend request list

Kind: static method of rosterManage
Returns: Promise.<Array.<module:types~RosterApplication>> - List of friend requests

Param	Type	Description
params	`object`	Parameter
params.cursor	`number`	Get from where: you can pass an empty string to get from the beginning

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetApplyList" %}{% endlanying_code_snippet %}

rosterManage.asyncGetBlockedlist(params) ⇒ `Promise.<Array.<number>>`#

Get blacklist

Kind: static method of rosterManage
Returns: Promise.<Array.<number>> - List of user IDs

Param	Type	Description
params	`object`	Parameter:Empty object

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetBlockedlist" %}{% endlanying_code_snippet %}