Package sfs3.client.requests.buddylist

Class AddBuddyRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.buddylist.AddBuddyRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class AddBuddyRequest
extends BaseRequest

Adds a new buddy to the current user's buddies list.

In order to add a buddy, the current user must be online in the Buddy List system. If the buddy is added successfully, the operation is confirmed by a buddyAdd event; otherwise the buddyError event is fired.

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

See Also:

• SFSBuddyEvent.BUDDY_ADD
• SFSBuddyEvent.BUDDY_ERROR
• RemoveBuddyRequest
• InitBuddyListRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BUDDY_NAME

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
AddBuddyRequest(String buddyName)	Creates a new AddBuddyRequest 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

Constructor Details

AddBuddyRequest

public AddBuddyRequest(String buddyName)

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

Parameters:

buddyName - The name of the user to be added as a buddy.

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