Package sfs3.client.requests.buddylist

Class SetBuddyVariablesRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.buddylist.SetBuddyVariablesRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class SetBuddyVariablesRequest
extends BaseRequest

Sets one or more Buddy Variables for the current user.

This operation updates the Buddy object representing the user in all the buddies lists in which the user was added as a buddy. If the operation is successful, a buddyVariablesUpdate event is dispatched to all the owners of those buddies lists and to the user who updated his variables too.

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description) and the current user state in the system is "online".

See Also:

• BuddyVariable
• SFSBuddyEvent.BUDDY_VARIABLES_UPDATE
• InitBuddyListRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BUDDY_NAME
static final String	KEY_BUDDY_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
SetBuddyVariablesRequest(List<BuddyVariable> buddyVariables)	Creates a new SetBuddyVariablesRequest 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_BUDDY_NAME

public static final String KEY_BUDDY_NAME

See Also:

• Constant Field Values

Internal

KEY_BUDDY_VARS

public static final String KEY_BUDDY_VARS

See Also:

• Constant Field Values

Internal

Constructor Details

SetBuddyVariablesRequest

public SetBuddyVariablesRequest(List<BuddyVariable> buddyVariables)

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

Parameters:

buddyVariables - A list of BuddyVariable objects representing the Buddy Variables to be set.

See Also:

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

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal