Package sfs3.client.requests.invitation

Class InviteUsersRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.invitation.InviteUsersRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class InviteUsersRequest
extends BaseRequest

Sends a generic invitation to a list of users.

Invitations can be used for different purposes, such as requesting users to join a game or visit a specific Room, asking the permission to add them as buddies, etc. Invited users receive the invitation as an invitation event dispatched to their clients: they can accept or refuse it by means of the InvitationReplyRequest request, which must be sent within the specified amount of time.

See Also:

• SFSEvent.INVITATION
• InvitationReplyRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_INVITATION_ID
static final String	KEY_INVITED_USERS
static final String	KEY_INVITEE_ID
static final String	KEY_PARAMS
static final String	KEY_REPLY_ID
static final String	KEY_TIME
static final String	KEY_USER
static final String	KEY_USER_ID
static final int	MAX_EXPIRY_TIME
static final int	MAX_INVITATIONS_FROM_CLIENT_SIDE
static final int	MIN_EXPIRY_TIME

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
InviteUsersRequest(List<Object> invitedUsers, int secondsForAnswer, ISFSObject params)	Creates a new InviteUsersRequest 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_USER

public static final String KEY_USER

See Also:

• Constant Field Values

Internal

KEY_USER_ID

public static final String KEY_USER_ID

See Also:

• Constant Field Values

Internal

KEY_INVITATION_ID

public static final String KEY_INVITATION_ID

See Also:

• Constant Field Values

Internal

KEY_TIME

public static final String KEY_TIME

See Also:

• Constant Field Values

Internal

KEY_PARAMS

public static final String KEY_PARAMS

See Also:

• Constant Field Values

Internal

KEY_INVITEE_ID

public static final String KEY_INVITEE_ID

See Also:

• Constant Field Values

Internal

KEY_INVITED_USERS

public static final String KEY_INVITED_USERS

See Also:

• Constant Field Values

Internal

KEY_REPLY_ID

public static final String KEY_REPLY_ID

See Also:

• Constant Field Values

Internal

MAX_INVITATIONS_FROM_CLIENT_SIDE

public static final int MAX_INVITATIONS_FROM_CLIENT_SIDE

See Also:

• Constant Field Values

Internal

MIN_EXPIRY_TIME

public static final int MIN_EXPIRY_TIME

See Also:

• Constant Field Values

Internal

MAX_EXPIRY_TIME

public static final int MAX_EXPIRY_TIME

See Also:

• Constant Field Values

Internal

Constructor Details

InviteUsersRequest

public InviteUsersRequest(List<Object> invitedUsers,
 int secondsForAnswer,
 ISFSObject params)

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

Parameters:

invitedUsers - A list of User or Buddy objects representing user to send the invitation to.

secondsForAnswer - The number of seconds available to each invited user to reply to the invitation (recommended range: 15 to 40 seconds).

params - An instance of SFSObject containing custom parameters which specify the invitation details.

See Also:

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

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal