/ fm / liveswitch / Invitation

Class: Invitation

fm.liveswitch.Invitation

An invitation to join a channel.

Table of contents

Methods

• addOnStateChanging
• cancel
• fmliveswitchInvitationInit
• getChannelId
• getInviteKey
• getProtocol
• getReason
• getState
• getTypeString
• getUserId
• removeOnStateChanging

Methods

addOnStateChanging

▸ addOnStateChanging(value: IAction1<Invitation>): void

Adds a handler that is raised when the state changes.

Parameters:

Name	Type
value	IAction1<Invitation>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:70

---

cancel

▸ cancel(): Future<Object>

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

Returns: Future<Object>

A promise that resolves if the cancel succeeds.

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:83

---

fmliveswitchInvitationInit

▸ PrivatefmliveswitchInvitationInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:31

---

getChannelId

▸ getChannelId(): string

Gets the channel id that this invitation is for.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:112

---

getInviteKey

▸ getInviteKey(): string

Gets the key for this invitation.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:124

---

getProtocol

▸ getProtocol(): string

Gets the protocol that this user was invited on.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:136

---

getReason

▸ getReason(): string

Gets the reason for a state if available.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:148

---

getState

▸ getState(): InvitationState

Gets the current state of the invitation. See InviteFeedbackState for possible values.

Returns: InvitationState

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:160

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

getUserId

▸ getUserId(): string

Gets the user id of the user being invited.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:172

---

removeOnStateChanging

▸ removeOnStateChanging(value: IAction1<Invitation>): void

Removes a handler that is raised when the state changes.

Parameters:

Name	Type
value	IAction1<Invitation>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Invitation.ts:220