FMLiveSwitchInvitation Class Reference

An invitation to join a channel. More...

Instance Methods
(void)	- addOnStateChanging:
	Adds a handler that is raised when the state changes. More...
(FMLiveSwitchInvitation *)	- addOnStateChangingWithBlock
	Adds a handler that is raised when the state changes. More...
(void)	- addOnStateChangingWithBlock:
	Adds a handler that is raised when the state changes. More...
(FMLiveSwitchFuture< id > *)	- cancel
	Attempts to cancel the invitation. More...
(NSString *)	- channelId
	Gets the channel id that this invitation is for. More...
(NSString *)	- inviteKey
	Gets the key for this invitation. More...
(NSString *)	- protocol
	Gets the protocol that this user was invited on. More...
(NSString *)	- reason
	Gets the reason for a state if available. More...
(void)	- removeOnStateChanging:
	Removes a handler that is raised when the state changes. More...
(FMLiveSwitchInvitationState)	- state
	Gets the current state of the invitation. More...
(NSString *)	- userId
	Gets the user id of the user being invited. More...

Detailed Description

An invitation to join a channel.

Method Documentation

addOnStateChanging:

- (void) addOnStateChanging:

(FMLiveSwitchAction1< FMLiveSwitchInvitation * > *)

value

Adds a handler that is raised when the state changes.

addOnStateChangingWithBlock

- (FMLiveSwitchInvitation*) addOnStateChangingWithBlock

Adds a handler that is raised when the state changes.

addOnStateChangingWithBlock:

- (void) addOnStateChangingWithBlock:

(void(^)(FMLiveSwitchInvitation *))

valueBlock

Adds a handler that is raised when the state changes.

cancel

- (FMLiveSwitchFuture<id>*) cancel

Attempts to cancel the invitation.

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

Returns

A promise that resolves if the cancel succeeds.

channelId

- (NSString*) channelId

Gets the channel id that this invitation is for.

inviteKey

- (NSString*) inviteKey

Gets the key for this invitation.

protocol

- (NSString*) protocol

Gets the protocol that this user was invited on.

reason

- (NSString*) reason

Gets the reason for a state if available.

removeOnStateChanging:

- (void) removeOnStateChanging:

(FMLiveSwitchAction1< FMLiveSwitchInvitation * > *)

value

Removes a handler that is raised when the state changes.

state

- (FMLiveSwitchInvitationState) state

Gets the current state of the invitation.

See InviteFeedbackState for possible values.

userId

- (NSString*) userId

Gets the user id of the user being invited.