Class Invitation

An invitation to join a channel.

Inheritance

System.Object

Invitation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class Invitation

Properties

ChannelId

Gets the channel id that this invitation is for.

Declaration

public string ChannelId { get; }

Property Value

Type	Description
System.String

InviteKey

Gets the key for this invitation.

Declaration

public string InviteKey { get; }

Property Value

Type	Description
System.String

Protocol

Gets the protocol that this user was invited on.

Declaration

public string Protocol { get; }

Property Value

Type	Description
System.String

Reason

Gets the reason for a state if available.

Declaration

public string Reason { get; }

Property Value

Type	Description
System.String

State

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

Declaration

public InvitationState State { get; }

Property Value

Type	Description
InvitationState

UserId

Gets the user id of the user being invited.

Declaration

public string UserId { get; }

Property Value

Type	Description
System.String

Methods

Cancel()

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

Declaration

public Future<object> Cancel()

Returns

Type	Description
Future<System.Object>	A promise that resolves if the cancel succeeds.

Events

OnStateChanging

Raised when the state changes.

Declaration

public event Action1<Invitation> OnStateChanging

Event Type

Type	Description
Action1<Invitation>