Uses of Interface
com.smartfoxserver.v2.entities.data.ISFSObject

Packages that use ISFSObject

Package	Description
com.smartfoxserver.v2.api
com.smartfoxserver.v2.buddylist
com.smartfoxserver.v2.components.login
com.smartfoxserver.v2.components.signup
com.smartfoxserver.v2.controllers.filter
com.smartfoxserver.v2.controllers.system
com.smartfoxserver.v2.entities
com.smartfoxserver.v2.entities.data
com.smartfoxserver.v2.entities.invitation
com.smartfoxserver.v2.entities.variables
com.smartfoxserver.v2.extensions
com.smartfoxserver.v2.extensions.filter
com.smartfoxserver.v2.game

Uses of ISFSObject in com.smartfoxserver.v2.api

Methods in com.smartfoxserver.v2.api with parameters of type ISFSObject

Modifier and Type	Method	Description
User	ISFSApi.login(ISession session, java.lang.String name, java.lang.String pass, java.lang.String zoneName, ISFSObject params)	Logs a client into a Zone, allowing it to become a User
User	ISFSApi.login(ISession session, java.lang.String name, java.lang.String pass, java.lang.String zoneName, ISFSObject params, boolean forceLogout)	Uses additional flag to disconnect previous user with same username
User	SFSApi.login(ISession sender, java.lang.String name, java.lang.String pass, java.lang.String zoneName, ISFSObject paramsOut)	Logs a client into a Zone, allowing it to become a User
User	SFSApi.login(ISession sender, java.lang.String name, java.lang.String pass, java.lang.String zoneName, ISFSObject paramsOut, boolean forceLogout)	Uses additional flag to disconnect previous user with same username
void	ISFSGameApi.replyToInvitation(User invitedUser, int invitationId, InvitationResponse reply, ISFSObject params, boolean fireClientEvent)	Handle the Invitation reply of a User
void	SFSGameApi.replyToInvitation(User invitedUser, int invitationId, InvitationResponse reply, ISFSObject params, boolean fireClientEvent)	Handle the Invitation reply of a User
void	ISFSApi.sendAdminMessage(User sender, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)	Sends a administrator message to a number of Users.
void	SFSApi.sendAdminMessage(User sender, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)	Sends a administrator message to a number of Users.
void	ISFSApi.sendBuddyMessage(User sender, User recipient, java.lang.String message, ISFSObject params)
void	ISFSBuddyApi.sendBuddyMessage(User sender, User recipient, java.lang.String message, ISFSObject params)	Send a Buddy Message to any Buddy in your list.
void	SFSApi.sendBuddyMessage(User sender, User recipient, java.lang.String message, ISFSObject params)
void	SFSBuddyApi.sendBuddyMessage(User sender, User recipient, java.lang.String message, ISFSObject params)	Send a Buddy Message to any Buddy in your list.
void	ISFSApi.sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)
void	ISFSApi.sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)
void	SFSApi.sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)
void	SFSApi.sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)
void	ISFSApi.sendGenericMessage(com.smartfoxserver.v2.api.GenericMessageType type, User sender, int targetRoomId, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)
void	SFSApi.sendGenericMessage(com.smartfoxserver.v2.api.GenericMessageType type, User sender, int targetRoomId, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)
void	ISFSGameApi.sendInvitation(User inviter, java.util.List<User> invitees, int expirySeconds, InvitationCallback callBackHandler, ISFSObject params)	Send an Invitation to a User. An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
void	SFSGameApi.sendInvitation(User inviter, java.util.List<User> invitees, int expirySeconds, InvitationCallback callBackHandler, ISFSObject params)	Send an Invitation to a User. An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
void	ISFSGameApi.sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom, ISFSObject params)	Invites Users / Players in an existing Room.
void	SFSGameApi.sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom, ISFSObject params)	Invites Users / Players in an existing Room.
void	ISFSApi.sendModeratorMessage(User sender, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)	Sends a moderator message to a number of Users.
void	SFSApi.sendModeratorMessage(User sender, java.lang.String message, ISFSObject params, java.util.Collection<ISession> recipients)	Sends a moderator message to a number of Users.
void	ISFSApi.sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)	Send an Object message.
void	ISFSMMOApi.sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)	Send an Object message based on a custom SFSObject that can contain any data.
void	SFSApi.sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)	Send an Object message.
void	SFSMMOApi.sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)	Send an Object message based on a custom SFSObject that can contain any data.
void	ISFSApi.sendPrivateMessage(User sender, User recipient, java.lang.String message, ISFSObject params)	Sends a private chat message.
void	SFSApi.sendPrivateMessage(User sender, User recipient, java.lang.String message, ISFSObject params)	Sends a private chat message.
void	ISFSApi.sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)	Sends a public chat message.
void	ISFSMMOApi.sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)	Sends a public chat message.
void	SFSApi.sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)	Sends a public chat message.
void	SFSMMOApi.sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)	Sends a public chat message.

Uses of ISFSObject in com.smartfoxserver.v2.buddylist

Methods in com.smartfoxserver.v2.buddylist that return ISFSObject

Modifier and Type	Method	Description
static ISFSObject	BuddyUtils.encodeBuddy(Buddy buddy)
ISFSObject	SFSBuddyVariable.getSFSObjectValue()
static ISFSObject	BuddyUtils.toSFSObject(BuddyList buddyList, boolean excludeTemporaryBuddies)

Methods in com.smartfoxserver.v2.buddylist with parameters of type ISFSObject

Modifier and Type	Method	Description
static BuddyList	BuddyUtils.fromSFSObject(ISFSObject sfso)
protected void	SFSBuddyVariable.setValue(ISFSObject val)

Uses of ISFSObject in com.smartfoxserver.v2.components.login

Fields in com.smartfoxserver.v2.components.login declared as ISFSObject

Modifier and Type	Field	Description
ISFSObject	LoginData.clientIncomingData	The optional SFSObject sent by the client with his LoginRequest
ISFSObject	LoginData.clientOutGoingData	The optional outgoing SFSObject that will be sent to the client with the Login response
ISFSObject	LoginData.extraFields	The optional extra fields extracted from the database, if specified in the LoginAssistant configuration (might be null)

Uses of ISFSObject in com.smartfoxserver.v2.components.signup

Methods in com.smartfoxserver.v2.components.signup that return ISFSObject

Modifier and Type	Method	Description
ISFSObject	CustomFieldPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)
ISFSObject	IPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)
ISFSObject	LegacyPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)

Methods in com.smartfoxserver.v2.components.signup with parameters of type ISFSObject

Modifier and Type	Method	Description
void	ISignUpAssistantPlugin.execute(User user, ISFSObject params, SignUpConfiguration config)	Handles the execution of the plugin logic
void	SignUpAssistantComponent.handleClientRequest(User sender, ISFSObject params)
ISFSObject	CustomFieldPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)
ISFSObject	IPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)
ISFSObject	LegacyPasswordRecovery.recover(SignUpAssistantComponent suac, User user, ISFSObject params)
void	ISignUpValidator.validate(IDBManager dbManager, ISFSObject data)

Uses of ISFSObject in com.smartfoxserver.v2.controllers.filter

Methods in com.smartfoxserver.v2.controllers.filter with parameters of type ISFSObject

Modifier and Type	Method	Description
FilterAction	ISystemFilter.handleClientRequest(User sender, ISFSObject params)	Handles a client request
FilterAction	ReadOnlyUserVariablesFilter.handleClientRequest(User sender, ISFSObject params)
FilterAction	ISystemFilterChain.runRequest(User sender, ISFSObject params)
FilterAction	SysControllerFilterChain.runRequest(User sender, ISFSObject params)

Uses of ISFSObject in com.smartfoxserver.v2.controllers.system

Methods in com.smartfoxserver.v2.controllers.system with parameters of type ISFSObject

Modifier and Type	Method	Description
protected boolean	Login.customLogin(ISFSObject sfso, com.smartfoxserver.bitswarm.io.IRequest request, Zone zone)
protected void	Login.validateFormalParameters(ISFSObject sfso)

Uses of ISFSObject in com.smartfoxserver.v2.entities

Fields in com.smartfoxserver.v2.entities declared as ISFSObject

Modifier and Type	Field	Description
ISFSObject	LoginData.paramsOut

Constructors in com.smartfoxserver.v2.entities with parameters of type ISFSObject

Constructor	Description
LoginData(ISession session, java.lang.String userName, java.lang.String password, ISFSObject paramsOut, boolean forceLogout)

Uses of ISFSObject in com.smartfoxserver.v2.entities.data

Classes in com.smartfoxserver.v2.entities.data that implement ISFSObject

Modifier and Type	Class	Description
class	SFSObject	SFSObject and SFSArray represent a platform-neutral, high level objects that abstract the data transport between client and server.
class	SFSObjectLite

Methods in com.smartfoxserver.v2.entities.data that return ISFSObject

Modifier and Type	Method	Description
ISFSObject	ISFSArray.getSFSObject(int index)	Get the element at the specified index as ISFSObject.
ISFSObject	ISFSObject.getSFSObject(java.lang.String key)	Get the element for the specified key as ISFSObject.
ISFSObject	SFSArray.getSFSObject(int index)
ISFSObject	SFSObject.getSFSObject(java.lang.String key)
static ISFSObject	SFSObject.newFromJsonData(java.lang.String jsonStr)	Creates an SFSObject from a JSON literal.

Methods in com.smartfoxserver.v2.entities.data with parameters of type ISFSObject

Modifier and Type	Method	Description
void	ISFSArray.addSFSObject(ISFSObject value)	Add a nested ISFSObject
void	SFSArray.addSFSObject(ISFSObject value)
void	ISFSObject.putSFSObject(java.lang.String key, ISFSObject value)	Add a nested SFSObject
void	SFSObject.putSFSObject(java.lang.String key, ISFSObject value)

Uses of ISFSObject in com.smartfoxserver.v2.entities.invitation

Methods in com.smartfoxserver.v2.entities.invitation that return ISFSObject

Modifier and Type	Method	Description
ISFSObject	Invitation.getParams()	An SFSObject of custom parameters can be attached to the invitation.
ISFSObject	SFSInvitation.getParams()

Methods in com.smartfoxserver.v2.entities.invitation with parameters of type ISFSObject

Modifier and Type	Method	Description
protected void	SFSInvitationManager.handleAcceptedInvitation(Invitation invitation, ISFSObject params)
protected void	SFSInvitationManager.handleRefusedInvitation(Invitation invitation, ISFSObject params)
void	InvitationCallback.onAccepted(Invitation invObj, ISFSObject params)	Fired when the invited User has accepted the invitation
void	InvitationManager.onInvitationResult(int invitationId, InvitationResponse result, ISFSObject params)	Handle the response to an invitation
void	InvitationManager.onInvitationResult(Invitation invitation, InvitationResponse result, ISFSObject params)	Handle the response to an invitation
void	SFSInvitationManager.onInvitationResult(int invitationId, InvitationResponse result, ISFSObject params)
void	SFSInvitationManager.onInvitationResult(Invitation invitation, InvitationResponse result, ISFSObject params)
void	InvitationCallback.onRefused(Invitation invObj, ISFSObject params)	Fired when the invited User has refused the invitation
void	Invitation.setParams(ISFSObject params)	An SFSObject of custom parameters can be attached to the invitation.
void	SFSInvitation.setParams(ISFSObject params)

Constructors in com.smartfoxserver.v2.entities.invitation with parameters of type ISFSObject

Constructor	Description
SFSInvitation(User inviter, User invitee, int secondsForAnswer, ISFSObject params)

Uses of ISFSObject in com.smartfoxserver.v2.entities.variables

Methods in com.smartfoxserver.v2.entities.variables that return ISFSObject

Modifier and Type	Method	Description
ISFSObject	SFSUserVariable.getSFSObjectValue()	Get the value of the variable as SFSObject
ISFSObject	Variable.getSFSObjectValue()	Get the value of the variable as SFSObject

Methods in com.smartfoxserver.v2.entities.variables with parameters of type ISFSObject

Modifier and Type	Method	Description
protected void	SFSUserVariable.setValue(ISFSObject val)

Uses of ISFSObject in com.smartfoxserver.v2.extensions

Methods in com.smartfoxserver.v2.extensions with parameters of type ISFSObject

Modifier and Type	Method	Description
void	IClientRequestHandler.handleClientRequest(User sender, ISFSObject params)	Handle a client request
void	ISFSExtension.handleClientRequest(java.lang.String cmdName, User sender, ISFSObject params)	This method is called whenever a client sends a request to this Extension
void	SFSExtension.handleClientRequest(java.lang.String requestId, User sender, ISFSObject params)	This method is called whenever a client sends a request to this Extension
protected void	BaseClientRequestHandler.send(java.lang.String cmdName, ISFSObject params, User recipient)	Send a response back to a User
protected void	BaseClientRequestHandler.send(java.lang.String cmdName, ISFSObject params, User recipient, boolean useUDP)	Send a response back to a User
protected void	BaseClientRequestHandler.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients)	Broadcast a response back to multiple Users
protected void	BaseClientRequestHandler.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, boolean useUDP)	Broadcast a response back to multiple Users
protected void	BaseServerEventHandler.send(java.lang.String cmdName, ISFSObject params, User recipient)	Send a response back to a User
protected void	BaseServerEventHandler.send(java.lang.String cmdName, ISFSObject params, User recipient, boolean useUDP)	Send a response back to a User
protected void	BaseServerEventHandler.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients)	Broadcast a response back to multiple Users
protected void	BaseServerEventHandler.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, boolean useUDP)	Broadcast a response back to multiple Users
void	BaseSFSExtension.send(java.lang.String cmdName, ISFSObject params, User recipient)
void	BaseSFSExtension.send(java.lang.String cmdName, ISFSObject params, User recipient, boolean useUDP)
void	BaseSFSExtension.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients)
void	BaseSFSExtension.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, boolean useUDP)	Send an extension message/response to a list of recipients
void	ISFSExtension.send(java.lang.String cmdName, ISFSObject params, User recipient)
void	ISFSExtension.send(java.lang.String cmdName, ISFSObject params, User recipient, boolean useUDP)	Send an extension message/response to a single User
void	ISFSExtension.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients)
void	ISFSExtension.send(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, boolean useUDP)	Send an extension message/response to a list of recipients

Uses of ISFSObject in com.smartfoxserver.v2.extensions.filter

Methods in com.smartfoxserver.v2.extensions.filter with parameters of type ISFSObject

Modifier and Type	Method	Description
FilterAction	IFilter.handleClientRequest(java.lang.String requestId, User sender, ISFSObject params)	Handles a client request
FilterAction	IFilterChain.runRequestInChain(java.lang.String requestId, User sender, ISFSObject params)
FilterAction	SFSExtensionFilterChain.runRequestInChain(java.lang.String requestId, User sender, ISFSObject params)

Uses of ISFSObject in com.smartfoxserver.v2.game

Methods in com.smartfoxserver.v2.game that return ISFSObject

Modifier and Type	Method	Description
ISFSObject	CreateSFSGameSettings.getInvitationParams()	Get optional SFSObject containing custom invitation parameters.

Methods in com.smartfoxserver.v2.game with parameters of type ISFSObject

Modifier and Type	Method	Description
void	GenericInvitationCallback.onAccepted(Invitation invObj, ISFSObject params)
void	JoinRoomInvitationCallback.onAccepted(Invitation invObj, ISFSObject params)
void	SFSGameInvitationCallback.onAccepted(Invitation invObj, ISFSObject params)
void	GenericInvitationCallback.onRefused(Invitation invObj, ISFSObject params)
void	JoinRoomInvitationCallback.onRefused(Invitation invObj, ISFSObject params)
void	SFSGameInvitationCallback.onRefused(Invitation invObj, ISFSObject params)
void	CreateSFSGameSettings.setInvitationParams(ISFSObject invitationParams)	Set the custom invitation parameters.