Package sfs3.client.requests.buddylist

Class BlockBuddyRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.buddylist.BlockBuddyRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class BlockBuddyRequest
extends BaseRequest

Blocks or unblocks a buddy in the current user's buddies list. Blocked buddies won't be able to see if the user who blocked them is online in their buddies list; they also won't be able to send messages or requests to that user.

In order to block a buddy, the current user must be online in the Buddy List system. If the operation is successful, a buddyBlock confirmation event is dispatched; 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_BLOCK
• SFSBuddyEvent.BUDDY_ERROR
• InitBuddyListRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BUDDY
static final String	KEY_BUDDY_BLOCK_STATE
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
BlockBuddyRequest(String buddyName, boolean blocked)	Creates a new BlockBuddyRequest 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

public static final String KEY_BUDDY

See Also:

• Constant Field Values

Internal

KEY_BUDDY_BLOCK_STATE

public static final String KEY_BUDDY_BLOCK_STATE

See Also:

• Constant Field Values

Internal

Constructor Details

BlockBuddyRequest

public BlockBuddyRequest(String buddyName,
 boolean blocked)

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

Parameters:

buddyName - The name of the buddy to be blocked or unblocked.

blocked - true if the buddy must be blocked; false if he must be unblocked.

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