Package sfs3.client.requests

Class AdminMessageRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.GenericMessageRequest

sfs3.client.requests.AdminMessageRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class AdminMessageRequest
extends sfs3.client.requests.GenericMessageRequest

Sends an administrator message to a specific user or a group of users.

The current user must have administration privileges to be able to send the message (see the User.privilegeId property).

The recipientMode parameter in the class constructor is used to determine the message recipients: a single user or all the users in a Room, a Group or the entire Zone. Upon message delivery, the clients of the recipient users dispatch the adminMessage event.

See Also:

• SFSEvent.ADMIN_MESSAGE
• User.getPrivilegeId()
• ModeratorMessageRequest

Field Summary

Fields inherited from class sfs3.client.requests.GenericMessageRequest

KEY_MESSAGE, KEY_MESSAGE_TYPE, KEY_RECIPIENT, KEY_RECIPIENT_MODE, KEY_ROOM_ID, KEY_SENDER_DATA, KEY_USER_ID, KEY_XTRA_PARAMS, log, message, params, recipient, room, sendMode, type, user

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
AdminMessageRequest(String message, MessageRecipientMode recipientMode)
AdminMessageRequest(String message, MessageRecipientMode recipientMode, ISFSObject params)	Creates a new AdminMessageRequest instance.

Method Summary

Methods inherited from class sfs3.client.requests.GenericMessageRequest

execute, validate

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

Constructor Details

AdminMessageRequest

public AdminMessageRequest(String message,
 MessageRecipientMode recipientMode,
 ISFSObject params)

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

Parameters:

message - The message of the administrator to be sent to the target user/s defined by the recipientMode parameter.

recipientMode - An instance of MessageRecipientMode containing the target to which the message should be delivered.

params - An instance of SFSObject containing custom parameters to be sent to the recipient user/s.

See Also:

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

AdminMessageRequest

public AdminMessageRequest(String message,
 MessageRecipientMode recipientMode)

See Also:

• AdminMessageRequest(String, MessageRecipientMode, ISFSObject)