Support

BuddyListAPI

Summary
Constructor Attributes Constructor Name and Description
 
Manage buddy list data and events
Method Summary
Method Attributes Method Name and Description
 
addBuddy(userId, displayName, groupId, requestSubscription)
 
blockUser(userID)
 
 
isBlocked(userID)
 
isBuddy(userID)
 
removeBuddy(userId)
 
search(filterMap)
 
setBlockList(blockListArray)
Set the blocklist for the local user.
 
setBuddyList(buddyListArray, override)
Set the buddylist for the local user.
 
 
unblockUser(userID)
Detail
BuddyListAPI()
Manage buddy list data and events
Methods

addBuddy(userId, displayName, groupId, requestSubscription)

version:

Params
userId displayName groupId requestSubscription
Returns

blockUser(userID)

version:

Params
userID
Returns

getBlockList()

version:

Params
Returns

isBlocked(userID)

version:

Params
userID
Returns

isBuddy(userID)

version:

Params
userID
Returns

removeBuddy(userId)

version:

Params
userId
Returns

search(filterMap)

version:

Params
filterMap
Returns

setBlockList(blockListArray):Boolean

version: 1.0.3

Set the blocklist for the local user.

Params
blockListArray
Returns
{Boolean} Returns the result of the call as boolean true/false.

setBuddyList(buddyListArray, override):Boolean

version: 1.0.3

Set the buddylist for the local user. This call is honored once per hour and is ignored if called beyond that. If a user needs to get updated buddylist the session must be reset.

Params
buddyListArray override
Returns
{Boolean} Returns the result of the call as boolean true/false.

setDefaultPrivacyList(listName)

version:

Params
listName
Returns

unblockUser(userID)

version:

Params
userID
Returns