Package sfs3.client.requests.buddylist

Class InitBuddyListRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.buddylist.InitBuddyListRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class InitBuddyListRequest
extends BaseRequest

Initializes the Buddy List system on the current client.

Buddy List system initialization involves loading any previously stored buddy-specific data from the server, such as the current user's buddies list, his previous state and the persistent Buddy Variables. The initialization request is the first operation to be executed in order to be able to use the Buddy List system features. Once the initialization is completed, the buddyListInit event is fired and the user has access to all his previously set data and can start to interact with his buddies; if the initialization failed, a buddyError event is fired.

See Also:

• SFSBuddyEvent.BUDDY_LIST_INIT
• SFSBuddyEvent.BUDDY_ERROR

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BLIST
static final String	KEY_BUDDY_STATES
static final String	KEY_MY_VARS

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
InitBuddyListRequest()	Creates a new InitBuddyListRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_BLIST

public static final String KEY_BLIST

See Also:

• Constant Field Values

Internal

KEY_BUDDY_STATES

public static final String KEY_BUDDY_STATES

See Also:

• Constant Field Values

Internal

KEY_MY_VARS

public static final String KEY_MY_VARS

See Also:

• Constant Field Values

Internal

Constructor Details

InitBuddyListRequest

public InitBuddyListRequest()

Creates a new InitBuddyListRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal