com.smartfoxserver.v2.entities.SFSBuddy

Package	com.smartfoxserver.v2.entities
Class	public class SFSBuddy
Inheritance	SFSBuddy Object
Implements	Buddy

The SFSBuddy object represents a buddy in the current user's buddies list.

A buddy is marked out by the following characteristics.

Nickname: a buddy can have an optional nickname, which differs from the username used during the login process.
Online/offline state: users can be online or offline as buddies in the Buddy List system. By default a buddy is online every time he joins a Zone, but the user can also switch the state to offline at runtime, and disappear from other user's buddies list. This state is persistent and it is based on a reserved Buddy Variable.
Custom state: each user can have a typical IM state such as "Available", "Away", "Occupied", etc. State can be selected among the custom ones defined in the Zone configuration, which can be changed or enriched at any time. This state is persistent and it is based on a reserved Buddy Variable.
Blocked buddy: buddies that are blocked in a user's buddies list won't be able to send messages to that user; also they won't be able to see if the user is online or offline in the Buddy List system.
Temporary buddy: a temporary buddy is added to the current user's buddies list whenever another user adds him to his own buddies list. In this way users can "see" each other and exchange messages. If the current user doesn't add that temporary buddy to his buddies list voluntarily, that buddy won't be persisted and will be lost upon disconnection.
Variables: Buddy Variables enable each user to show (and send updates on) specific custom informations to each user to whom he is a buddy. For example one could send realtime updates on his last activity, or post the title of the song he's listening right now, or scores, rankings and whatnot.

See also

SmartFox.buddyManager
BuddyVariable

	Property	Defined By
		id : int [read-only] Indicates the id of this buddy.	SFSBuddy
		isBlocked : Boolean [read-only] Indicates whether this buddy is blocked in the current user's buddies list or not.	SFSBuddy
		isOnline : Boolean [read-only] Indicates whether this buddy is online in the Buddy List system or not.	SFSBuddy
		isTemp : Boolean [read-only] Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not.	SFSBuddy
		name : String [read-only] Indicates the name of this buddy.	SFSBuddy
		nickName : String [read-only] Returns the nickname of this buddy.	SFSBuddy
		state : String [read-only] Returns the custom state of this buddy.	SFSBuddy
		variables : Array [read-only] Returns a list of BuddyVariable objects associated with the buddy.	SFSBuddy

	Method	Defined By
		SFSBuddy(id:int, name:String, isBlocked:Boolean = false, isTemp:Boolean = false) Creates a new SFSBuddy instance.	SFSBuddy
		containsVariable(varName:String):Boolean Indicates whether this buddy has the specified Buddy Variable set or not.	SFSBuddy
		getOfflineVariables():Array Retrieves the list of persistent Buddy Variables of this buddy.	SFSBuddy
		getOnlineVariables():Array Retrieves the list of non-persistent Buddy Variables of this buddy.	SFSBuddy
		getVariable(varName:String):BuddyVariable Retrieves a Buddy Variable from its name.	SFSBuddy
		toString():String Returns a string that contains the buddy name and id.	SFSBuddy

Property Detail

property

id:int [read-only]

Indicates the id of this buddy. This is equal to the id assigned by SmartFoxServer to the corresponding user.

Implementation
public function get id():int

isBlocked

property

isBlocked:Boolean [read-only]

Indicates whether this buddy is blocked in the current user's buddies list or not. A buddy can be blocked by means of a BlockBuddyRequest request.

Implementation
public function get isBlocked():Boolean

isOnline

property

isOnline:Boolean [read-only]

Indicates whether this buddy is online in the Buddy List system or not.

Implementation
public function get isOnline():Boolean

isTemp

property

isTemp:Boolean [read-only]

Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not.

Implementation
public function get isTemp():Boolean

name

property

name:String [read-only]

Indicates the name of this buddy. This is equal to the name of the corresponding user.

Implementation
public function get name():String

nickName

property

nickName:String [read-only]

Returns the nickname of this buddy. If the nickname is not set, null is returned.

Implementation
public function get nickName():String

state

property

state:String [read-only]

Returns the custom state of this buddy. Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state is not set, null is returned.

The list of available custom states is returned by the IBuddyManager.buddyStates property.

Implementation
public function get state():String

variables

property

variables:Array [read-only]

Returns a list of BuddyVariable objects associated with the buddy.

Implementation
public function get variables():Array

Constructor Detail

SFSBuddy

()

Constructor

public function SFSBuddy(id:int, name:String, isBlocked:Boolean = false, isTemp:Boolean = false)

Creates a new SFSBuddy instance.

NOTE: developers never istantiate a SFSBuddy manually: this is done by the SmartFoxServer 2X API internally.

Parameters

	`id:int` — The buddy id.

	`name:String` — The buddy name.

	`isBlocked:Boolean` (default = `false`) — If `true`, the buddy being created is blocked by the current user.

	`isTemp:Boolean` (default = `false`) — If `true`, the buddy being created is temporary in the current client.

Method Detail

containsVariable

()

method

public function containsVariable(varName:String):Boolean

Indicates whether this buddy has the specified Buddy Variable set or not.

Parameters

varName:String — The name of the Buddy Variable whose existance must be checked.

Returns

Boolean — true if a Buddy Variable with the passed name is set for this buddy.

getOfflineVariables

()

method

public function getOfflineVariables():Array

Retrieves the list of persistent Buddy Variables of this buddy.

Returns

Array — An array of BuddyVariable objects.

getOnlineVariables

()

method

public function getOnlineVariables():Array

Retrieves the list of non-persistent Buddy Variables of this buddy.

Returns

Array — An array of BuddyVariable objects.

getVariable

()

method

public function getVariable(varName:String):BuddyVariable

Retrieves a Buddy Variable from its name.

Parameters

varName:String — The name of the Buddy Variable to be retrieved.

Returns

BuddyVariable — The BuddyVariable object representing the Buddy Variable, or null if no Buddy Variable with the passed name is associated with this buddy.

toString

()

method

public function toString():String

Returns a string that contains the buddy name and id.

Returns

String — The string representation of the SFSBuddy object.

lunedì ottobre 29 2018, 09:52 AM +01:00

SmartFoxServer 2X ActionScript 3 API	All Packages \| All Classes \| Index \| Frames No Frames
SFSBuddy	Properties \| Methods