An invitation to join a channel. More...

Public Member Functions
void	addOnStateChanging (fm.liveswitch.IAction1< fm.liveswitch.Invitation > value)
	Adds a handler that is raised when the state changes. More...

fm.liveswitch.Future< Object >	cancel ()
	Attempts to cancel the invitation. More...

String	getChannelId ()
	Gets the channel id that this invitation is for. More...

String	getInviteKey ()
	Gets the key for this invitation. More...

String	getProtocol ()
	Gets the protocol that this user was invited on. More...

String	getReason ()
	Gets the reason for a state if available. More...

fm.liveswitch.InvitationState	getState ()
	Gets the current state of the invitation. More...

String	getUserId ()
	Gets the user id of the user being invited. More...

void	removeOnStateChanging (fm.liveswitch.IAction1< fm.liveswitch.Invitation > value)
	Removes a handler that is raised when the state changes. More...

Detailed Description

An invitation to join a channel.

Member Function Documentation

void fm.liveswitch.Invitation.addOnStateChanging ( fm.liveswitch.IAction1< fm.liveswitch.Invitation > value )

Adds a handler that is raised when the state changes.

fm.liveswitch.Future<Object> fm.liveswitch.Invitation.cancel ( )

Attempts to cancel the invitation.

May fail if the invitation is acted upon before being canceled.

String fm.liveswitch.Invitation.getChannelId ( )

Gets the channel id that this invitation is for.

String fm.liveswitch.Invitation.getInviteKey ( )

Gets the key for this invitation.

String fm.liveswitch.Invitation.getProtocol ( )

Gets the protocol that this user was invited on.

String fm.liveswitch.Invitation.getReason ( )

Gets the reason for a state if available.

fm.liveswitch.InvitationState fm.liveswitch.Invitation.getState ( )

Gets the current state of the invitation.

See InviteFeedbackState for possible values.

String fm.liveswitch.Invitation.getUserId ( )

Gets the user id of the user being invited.

void fm.liveswitch.Invitation.removeOnStateChanging ( fm.liveswitch.IAction1< fm.liveswitch.Invitation > value )

Removes a handler that is raised when the state changes.