Sfs2X::Entities::Invitation::Invitation Class Reference

Represents an Invitation object More...

#include <Invitation.h>

Inheritance diagram for Sfs2X::Entities::Invitation::Invitation:

Public Member Functions
virtual long int	Id ()=0
	The id of the invitation More...
virtual void	Id (long int value)=0
	The id of the invitation More...
virtual boost::shared_ptr< User >	Inviter ()=0
	The inviter User More...
virtual boost::shared_ptr< User >	Invitee ()=0
	The invited User More...
virtual long int	SecondsForAnswer ()=0
	The amount of time (seconds) allowed to reply to the invitation More...
virtual boost::shared_ptr< ISFSObject >	Params ()=0
	A custom set of parameters. More...

Detailed Description

Represents an Invitation object

For more details see the SFSInvitation implementation

See also

SFSInvitation

Member Function Documentation

Id() [1/2]

virtual long int Sfs2X::Entities::Invitation::Invitation::Id ( )

pure virtual

The id of the invitation

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.

Id() [2/2]

virtual void Sfs2X::Entities::Invitation::Invitation::Id ( long int  value )

pure virtual

The id of the invitation

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.

Invitee()

virtual boost::shared_ptr<User> Sfs2X::Entities::Invitation::Invitation::Invitee ( )

pure virtual

The invited User

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.

Inviter()

virtual boost::shared_ptr<User> Sfs2X::Entities::Invitation::Invitation::Inviter ( )

pure virtual

The inviter User

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.

Params()

virtual boost::shared_ptr<ISFSObject> Sfs2X::Entities::Invitation::Invitation::Params ( )

pure virtual

A custom set of parameters.

Can be used to provide a message for the invitation and any other relevant data

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.

SecondsForAnswer()

virtual long int Sfs2X::Entities::Invitation::Invitation::SecondsForAnswer ( )

pure virtual

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

Implemented in Sfs2X::Entities::Invitation::SFSInvitation.