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…)

See InviteUsersRequest

Properties

id

The id of the invitation

@property (nonatomic, assign) NSInteger id

Discussion

The id of the invitation

Declared In

SFSInvitation.h

invitee

The invited User

@property (weak, nonatomic, readonly) id<User> invitee

Discussion

The invited User

Declared In

SFSInvitation.h

inviter

The inviter User

@property (weak, nonatomic, readonly) id<User> inviter

Discussion

The inviter User

Declared In

SFSInvitation.h

params

A custom set of parameters. Can be used to provide a message for the invitation and any other relevant data

@property (weak, nonatomic, readonly) id<ISFSObject> params

Discussion

A custom set of parameters. Can be used to provide a message for the invitation and any other relevant data

Declared In

SFSInvitation.h

secondsForAnswer

The amount of time (seconds) allowed to reply to the invitation

@property (nonatomic, readonly) NSInteger secondsForAnswer

Discussion

The amount of time (seconds) allowed to reply to the invitation

Declared In

SFSInvitation.h

Class Methods

invitationWithInviter:invitee:

the User that sends the Invitation

+ (id)invitationWithInviter:(id<User>)inviter invitee:(id<User>)invitee

Parameters

inviter

the User that sends the Invitation

invitee

the User that receives the Invitation

Declared In

SFSInvitation.h

invitationWithInviter:invitee:secondsForAnswer:params:

the User that sends the Invitation

+ (id)invitationWithInviter:(id<User>)inviter invitee:(id<User>)invitee secondsForAnswer:(NSInteger)secondsForAnswer params:(id<ISFSObject>)params

Parameters

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

Instance 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>)params

Parameters

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