FMLiveSwitchInviteFeedback Class Reference

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

Instance Methods

(instancetype) - initWithUserId:protocol:state:reason:
 Creates an instance of a InviteFeedback class. More...
 
(NSString *) - protocol
 Gets the protocol the user was invited on. More...
 
(NSString *) - reason
 Gets the detailed reason for the state if available. More...
 
(FMLiveSwitchInvitationState) - state
 Gets the current state of the invite. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
(NSString *) - userId
 Gets the user id for the user being invited. More...
 

Class Methods

(FMLiveSwitchInviteFeedback *) + fromJsonWithFeedbackJson:
 Deserializes an instance from JSON. More...
 
(FMLiveSwitchInviteFeedback *) + inviteFeedbackWithUserId:protocol:state:reason:
 Creates an instance of a InviteFeedback class. More...
 
(NSString *) + toJsonWithFeedback:
 Serializes an instance to JSON. More...
 

Detailed Description

A class containing the feedback from invite requests.

Method Documentation

◆ fromJsonWithFeedbackJson:

+ (FMLiveSwitchInviteFeedback*) fromJsonWithFeedbackJson: (NSString *)  feedbackJson

Deserializes an instance from JSON.

Parameters
feedbackJsonThe JSON to deserialize.
Returns
The deserialized invite feedback.

◆ initWithUserId:protocol:state:reason:

- (instancetype) initWithUserId: (NSString *)  userId
protocol: (NSString *)  protocol
state: (FMLiveSwitchInvitationState)  state
reason: (NSString *)  reason 

Creates an instance of a InviteFeedback class.

Parameters
userIdThe user id of the user being invited.
protocolThe protocol the original invite was using.
stateThe current state of the invite.
reasonThe detailed reason if available.

◆ inviteFeedbackWithUserId:protocol:state:reason:

+ (FMLiveSwitchInviteFeedback*) inviteFeedbackWithUserId: (NSString *)  userId
protocol: (NSString *)  protocol
state: (FMLiveSwitchInvitationState)  state
reason: (NSString *)  reason 

Creates an instance of a InviteFeedback class.

Parameters
userIdThe user id of the user being invited.
protocolThe protocol the original invite was using.
stateThe current state of the invite.
reasonThe detailed reason if available.

◆ protocol

- (NSString*) protocol

Gets the protocol the user was invited on.

◆ reason

- (NSString*) reason

Gets the detailed reason for the state if available.

◆ state

- (FMLiveSwitchInvitationState) state

Gets the current state of the invite.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonWithFeedback:

+ (NSString*) toJsonWithFeedback: (FMLiveSwitchInviteFeedback *)  feedback

Serializes an instance to JSON.

Parameters
feedbackThe invite feedback to serialize.
Returns
The serialized JSON.

◆ userId

- (NSString*) userId

Gets the user id for the user being invited.