fm.liveswitch.InviteFeedback Class Reference

A class containing the feedback from invite requests. More...

Public Member Functions
String	getProtocol ()
	Gets the protocol the user was invited on. More...
String	getReason ()
	Gets the detailed reason for the state if available. More...
fm.liveswitch.InvitationState	getState ()
	Gets the current state of the invite. More...
String	getUserId ()
	Gets the user id for the user being invited. More...
	InviteFeedback (String userId, String protocol, fm.liveswitch.InvitationState state, String reason)
	Creates an instance of a InviteFeedback class. More...
String	toJson ()
	Serializes this instance to JSON. More...

Static Public Member Functions
static fm.liveswitch.InviteFeedback	fromJson (String feedbackJson)
	Deserializes an instance from JSON. More...
static String	toJson (fm.liveswitch.InviteFeedback feedback)
	Serializes an instance to JSON. More...

Detailed Description

A class containing the feedback from invite requests.

Constructor & Destructor Documentation

InviteFeedback()

fm.liveswitch.InviteFeedback.InviteFeedback	(	String	userId,
		String	protocol,
		fm.liveswitch.InvitationState	state,
		String	reason
	)

Creates an instance of a InviteFeedback class.

Parameters

userId	The user id of the user being invited.
protocol	The protocol the original invite was using.
state	The current state of the invite.
reason	The detailed reason if available.

Member Function Documentation

fromJson()

static fm.liveswitch.InviteFeedback fm.liveswitch.InviteFeedback.fromJson ( String  feedbackJson )

static

Deserializes an instance from JSON.

Parameters

feedbackJson

The JSON to deserialize.

Returns

The deserialized invite feedback.

getProtocol()

String fm.liveswitch.InviteFeedback.getProtocol

(

)

Gets the protocol the user was invited on.

getReason()

String fm.liveswitch.InviteFeedback.getReason

(

)

Gets the detailed reason for the state if available.

getState()

fm.liveswitch.InvitationState fm.liveswitch.InviteFeedback.getState

(

)

Gets the current state of the invite.

getUserId()

String fm.liveswitch.InviteFeedback.getUserId

(

)

Gets the user id for the user being invited.

toJson() [1/2]

String fm.liveswitch.InviteFeedback.toJson

(

)

Serializes this instance to JSON.

toJson() [2/2]

static String fm.liveswitch.InviteFeedback.toJson ( fm.liveswitch.InviteFeedback  feedback )

static

Serializes an instance to JSON.

Parameters

feedback

The invite feedback to serialize.

Returns

The serialized JSON.