Package sfs3.client.requests.invitation

Class InvitationReplyRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.invitation.InvitationReplyRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class InvitationReplyRequest
extends BaseRequest

Replies to an invitation received by the current user.

Users who receive an invitation sent by means of the InviteUsersRequest request can either accept or refuse it using this request. The reply causes an invitationReply event to be dispatched to the inviter; if a reply is not sent, or it is sent after the invitation expiration, the system will react as if the invitation was refused.

If an error occurs while the reply is delivered to the inviter user (for example the invitation is already expired), an invitationReplyError event is returned to the current user.

See Also:

• SFSEvent.INVITATION_REPLY
• SFSEvent.INVITATION_REPLY_ERROR
• InviteUsersRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_INVITATION_ID
static final String	KEY_INVITATION_PARAMS
static final String	KEY_INVITATION_REPLY

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
InvitationReplyRequest(Invitation invitation, InvitationReply invitationReply)
InvitationReplyRequest(Invitation invitation, InvitationReply invitationReply, ISFSObject params)	Creates a new InvitationReplyRequest 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_INVITATION_ID

public static final String KEY_INVITATION_ID

See Also:

• Constant Field Values

Internal

KEY_INVITATION_REPLY

public static final String KEY_INVITATION_REPLY

See Also:

• Constant Field Values

Internal

KEY_INVITATION_PARAMS

public static final String KEY_INVITATION_PARAMS

See Also:

• Constant Field Values

Internal

Constructor Details

InvitationReplyRequest

public InvitationReplyRequest(Invitation invitation,
 InvitationReply invitationReply,
 ISFSObject params)

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

Parameters:

invitation - An instance of the Invitation class containing the invitation details (inviter, custom parameters, etc).

invitationReply - The answer to be sent to the inviter, among those available as constants in the InvitationReply class.

params - An instance of SFSObject containing custom parameters to be returned to the inviter together with the reply (for example a message describing the reason of refusal).

See Also:

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

InvitationReplyRequest

public InvitationReplyRequest(Invitation invitation,
 InvitationReply invitationReply)

See Also:

• InvitationReplyRequest(Invitation, InvitationReply, ISFSObject)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal