/ fm / liveswitch / InviteFeedback

Class: InviteFeedback

fm.liveswitch.InviteFeedback

A class containing the feedback from invite requests.

Table of contents

Constructors

• constructor

Methods

• getProtocol
• getReason
• getState
• getTypeString
• getUserId
• toJson
• fromJson
• toJson

Constructors

constructor

+ new InviteFeedback(): InviteFeedback

Returns: InviteFeedback

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:19

+ new InviteFeedback(userId: string, protocol: string, state: InvitationState, reason: string): InviteFeedback

Creates an instance of a InviteFeedback class.

Parameters:

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

Returns: InviteFeedback

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:21

Methods

getProtocol

▸ getProtocol(): string

Gets the protocol the user was invited on.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:194

---

getReason

▸ getReason(): string

Gets the detailed reason for the state if available.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:206

---

getState

▸ getState(): InvitationState

Gets the current state of the invite.

Returns: InvitationState

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:218

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:9

---

getUserId

▸ getUserId(): string

Gets the user id for the user being invited.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:230

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:274

---

fromJson

▸ StaticfromJson(feedbackJson: string): InviteFeedback

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
feedbackJson	string	The JSON to deserialize.

Returns: InviteFeedback

The deserialized invite feedback.

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:98

---

toJson

▸ StatictoJson(feedback: InviteFeedback): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
feedback	InviteFeedback	The invite feedback to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/InviteFeedback.ts:171