com.smartfoxserver.v2.entities.invitation

Interface InvitationManager

All Known Implementing Classes:

SFSInvitationManager

public interface InvitationManager

Method Summary

Modifier and Type	Method and Description
Invitation	findById(int id) Find an invitation from its id
IDGenerator	getIDGenerator()
int	getMaxInvitationsPerUser()
void	onInvitationResult(int invitationId, InvitationResponse result, ISFSObject params) Handle the response to an invitation
void	onInvitationResult(Invitation invitation, InvitationResponse result, ISFSObject params) Handle the response to an invitation
void	setMaxInvitationsPerUser(int value)
void	startInvitation(Invitation invitation, InvitationCallback callBack) Start a new invitation
void	suppressInvitation(Invitation invitation) Stop an invitation that is running

Method Detail

findById

Invitation findById(int id)

Find an invitation from its id

Returns:

the invitation object

startInvitation

void startInvitation(Invitation invitation,
                     InvitationCallback callBack)

Start a new invitation

Parameters:

invitation - the invitation object

callBack - the response handler

suppressInvitation

void suppressInvitation(Invitation invitation)

Stop an invitation that is running

Parameters:

invitation - the invitation

onInvitationResult

void onInvitationResult(Invitation invitation,
                        InvitationResponse result,
                        ISFSObject params)
                 throws SFSInvitationException

Handle the response to an invitation

Parameters:

invitation - the invitation

result - the result

params - optional params

Throws:

SFSInvitationException

onInvitationResult

void onInvitationResult(int invitationId,
                        InvitationResponse result,
                        ISFSObject params)
                 throws SFSInvitationException

Handle the response to an invitation

Parameters:

invitationId - the id of the invitation

result - the result

params - optional params

Throws:

SFSInvitationException

getMaxInvitationsPerUser

int getMaxInvitationsPerUser()

Returns:

the max amount of invitations a User can run simultaneously

setMaxInvitationsPerUser

void setMaxInvitationsPerUser(int value)

Parameters:

value - the max amount of invitations a User can run simultaneously

getIDGenerator

IDGenerator getIDGenerator()