Package sfs3.client.requests.buddylist

Class GoOnlineRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.buddylist.GoOnlineRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class GoOnlineRequest
extends BaseRequest

Toggles the current user's online/offline state as buddy in other users' buddies lists.

All clients who have the current user as buddy in their buddies list will receive the buddyOnlineStateChange event and see the Buddy.isOnline property change accordingly. The same event is also dispatched to the current user, who sent the request, so that the application interface can be updated accordingly. Going online/offline as buddy doesn't affect the user connection, the currently joined Zone and Rooms, etc.

The online state of a user in a buddy list is handled by means of a reserved and persistent Buddy Variable.

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

See Also:

• IBuddyManager.getMyOnlineState()
• Buddy.isOnline()
• SFSBuddyEvent.BUDDY_ONLINE_STATE_CHANGE
• InitBuddyListRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BUDDY_ID
static final String	KEY_BUDDY_NAME
static final String	KEY_ONLINE

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
GoOnlineRequest(boolean online)	Creates a new GoOnlineRequest 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_ONLINE

public static final String KEY_ONLINE

See Also:

• Constant Field Values

Internal

KEY_BUDDY_NAME

public static final String KEY_BUDDY_NAME

See Also:

• Constant Field Values

Internal

KEY_BUDDY_ID

public static final String KEY_BUDDY_ID

See Also:

• Constant Field Values

Internal

Constructor Details

GoOnlineRequest

public GoOnlineRequest(boolean online)

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

Parameters:

online - true to make the current user available (online) in the Buddy List system; false to make him not available (offline).

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)
             throws SFSException

Throws:

SFSException

Internal