SFSInvitation Class Reference
| Inherits from | NSObject |
| Conforms to | Invitation |
| Declared in | SFSInvitation.h SFSInvitation.m |
Overview
An Invitation object provides the ability to send a generic invitation for a specific event going on in your application, be it a game, visiting a personal Room or another location of the virtual world etc…
The SFS2X Invitation Manager is very simple to use. All you need to provide is:
- inviter: the User starting the invitation (null == Server)
- invitee: the User to invite
- secondsForAnswer: the amount of time (in seconds) that the invitee has to accept/refuse the invitation. (default is 15 sec)
- params: any custom params to send with the invitation (e.g. a message, game name etc…)
Tasks
-
– initWithInviter:invitee:secondsForAnswer:params:the User that sends the Invitation
-
+ invitationWithInviter:invitee:secondsForAnswer:params:the User that sends the Invitation
-
+ invitationWithInviter:invitee:the User that sends the Invitation
-
idThe id of the invitation
property -
inviterThe inviter User
property -
inviteeThe invited User
property -
secondsForAnswerThe amount of time (seconds) allowed to reply to the invitation
property -
paramsA custom set of parameters. Can be used to provide a message for the invitation and any other relevant data
property
Properties
id
The id of the invitation
@property (nonatomic, assign) NSInteger idDiscussion
The id of the invitation
Declared In
SFSInvitation.hinvitee
The invited User
@property (nonatomic, readonly) id<> inviteeDiscussion
The invited User
Declared In
SFSInvitation.hinviter
The inviter User
@property (nonatomic, readonly) id<> inviterDiscussion
The inviter User
Declared In
SFSInvitation.hparams
A custom set of parameters. Can be used to provide a message for the invitation and any other relevant data
@property (nonatomic, readonly) id<> paramsDiscussion
A custom set of parameters. Can be used to provide a message for the invitation and any other relevant data
Declared In
SFSInvitation.hClass Methods
invitationWithInviter:invitee:
the User that sends the Invitation
+ (id)invitationWithInviter:(id<User>)inviter invitee:(id<User>)inviteeParameters
- inviter
the User that sends the Invitation
- invitee
the User that receives the Invitation
Declared In
SFSInvitation.hinvitationWithInviter:invitee:secondsForAnswer:params:
the User that sends the Invitation
+ (id)invitationWithInviter:(id<User>)inviter invitee:(id<User>)invitee secondsForAnswer:(NSInteger)secondsForAnswer params:(id<ISFSObject>)paramsParameters
- inviter
the User that sends the Invitation
- invitee
the User that receives the Invitation
- secondsForAnswer
the number of seconds allowed for the Invitee to reply (recommended range: 15-40 seconds)
- params
custom params to send with the invitation
Declared In
SFSInvitation.hInstance Methods
initWithInviter:invitee:secondsForAnswer:params:
the User that sends the Invitation
- (id)initWithInviter:(id<User>)inviter invitee:(id<User>)invitee secondsForAnswer:(NSInteger)secondsForAnswer params:(id<ISFSObject>)paramsParameters
- inviter
the User that sends the Invitation
- invitee
the User that receives the Invitation
- secondsForAnswer
the number of seconds allowed for the Invitee to reply (recommended range: 15-40 seconds)
- params
custom params to send with the invitation
Declared In
SFSInvitation.h