public interface Buddy
Modifier and Type | Method and Description |
---|---|
ISFSArray |
getBuddyVariablesData() |
java.lang.String |
getName()
The Buddy name, which corresponds to the User name.
|
java.lang.String |
getNickName()
Get the nickname of the Buddy.
|
BuddyList |
getParentBuddyList()
Return the parent BuddyList containing this Buddy
|
java.lang.String |
getState()
Returns the current Buddy State
|
BuddyVariable |
getVariable(java.lang.String varName)
Get a Buddy Variable from its name
|
java.util.List<BuddyVariable> |
getVariables()
Get all BuddyVariables
|
boolean |
hasVariables()
Checks if the Buddy has at least one variable set
|
boolean |
isBlocked()
When a Buddy is blocked he won't be able to see the User status and send him messages
|
boolean |
isOnline()
Checks if the Buddy is active in the system
|
boolean |
isTemp()
A temporary Buddy will only exist at runtime but will be lost as soon as he goes away
or the user is disconnected.
|
void |
setBlocked(boolean value)
Block the Buddy
|
void |
setIsTemp(boolean value) |
void |
setParentBuddyList(BuddyList parentList)
Set the parent BuddyList
|
void |
setVariable(BuddyVariable buddyVariable)
Set / modify a BuddyVariable.
|
void |
setVariables(java.util.List<BuddyVariable> buddyVariables)
Sets a number of variables at once.
|
ISFSArray |
toSFSArray() |
java.lang.String getName()
java.lang.String getState()
java.lang.String getNickName()
boolean isBlocked()
void setBlocked(boolean value)
value
- true to block the buddy, false to unblock himboolean isTemp()
void setIsTemp(boolean value)
boolean isOnline()
BuddyList getParentBuddyList()
void setParentBuddyList(BuddyList parentList)
parentList
- the BuddyListboolean hasVariables()
BuddyVariable getVariable(java.lang.String varName)
varName
- the variable namejava.util.List<BuddyVariable> getVariables()
void setVariable(BuddyVariable buddyVariable)
buddyVariable
- the Buddy Variablevoid setVariables(java.util.List<BuddyVariable> buddyVariables)
buddyVariables
- a list of variablesISFSArray toSFSArray()
ISFSArray getBuddyVariablesData()