fm.liveswitch.InvitationState Enum Reference

The invite feedback states. More...

Public Member Functions

 InvitationState (int value)
 
int getAssignedValue ()
 

Static Public Member Functions

 [static initializer]
 
static InvitationState getByAssignedValue (int value)
 

Public Attributes

 Unknown =(1)
 Gets the unknown state. More...
 
 Pending =(2)
 Gets the state for "pending". More...
 
 Proceeding =(3)
 Gets the state for "proceeding". More...
 
 Sent =(4)
 Gets the state for "sent". More...
 
 Cancelled =(5)
 Gets the state for "canceled". More...
 
 Cancelling =(6)
 Gets the state for "cancelling". More...
 
 Rejected =(7)
 Gets the state for "rejected". More...
 
 Accepted =(8)
 Gets the state for "accepted". More...
 
 NotFound =(9)
 Gets the state for "notFound". More...
 
 Busy =(10)
 Gets the state for "busy". More...
 
 NoResponse =(11)
 Gets the state for "noResponse". More...
 
 Invalid =(12)
 Gets the state for "invalid". More...
 
 AlreadyInvited =(13)
 Gets the state for "alreadyInvited". More...
 

Detailed Description

The invite feedback states.

Constructor & Destructor Documentation

◆ InvitationState()

fm.liveswitch.InvitationState.InvitationState ( int  value)

Member Function Documentation

◆ [static initializer]()

fm.liveswitch.InvitationState.[static initializer]
static

◆ getAssignedValue()

int fm.liveswitch.InvitationState.getAssignedValue ( )

◆ getByAssignedValue()

static InvitationState fm.liveswitch.InvitationState.getByAssignedValue ( int  value)
static

Member Data Documentation

◆ Accepted

fm.liveswitch.InvitationState.Accepted =(8)

Gets the state for "accepted".

This state is for when the invitation was accepted.

◆ AlreadyInvited

fm.liveswitch.InvitationState.AlreadyInvited =(13)

Gets the state for "alreadyInvited".

This state is when another invite for the same user id, protocol, and channel already exists.

◆ Busy

fm.liveswitch.InvitationState.Busy =(10)

Gets the state for "busy".

This state is for when the invited user signals they are busy.

◆ Cancelled

fm.liveswitch.InvitationState.Cancelled =(5)

Gets the state for "canceled".

This state is for when the invite has been canceled.

◆ Cancelling

fm.liveswitch.InvitationState.Cancelling =(6)

Gets the state for "cancelling".

This state is for when the invite is in the process of being cancelled. May fail due to timing.

◆ Invalid

fm.liveswitch.InvitationState.Invalid =(12)

Gets the state for "invalid".

This state is when the invitation cannot be processed.

◆ NoResponse

fm.liveswitch.InvitationState.NoResponse =(11)

Gets the state for "noResponse".

This state is for when the invitation did not receive a response.

◆ NotFound

fm.liveswitch.InvitationState.NotFound =(9)

Gets the state for "notFound".

This state is for when the invited user id cannot be found.

◆ Pending

fm.liveswitch.InvitationState.Pending =(2)

Gets the state for "pending".

This state is for when no feedback has been received yet.

◆ Proceeding

fm.liveswitch.InvitationState.Proceeding =(3)

Gets the state for "proceeding".

This state is for when we are waiting for the invited party to respond.

◆ Rejected

fm.liveswitch.InvitationState.Rejected =(7)

Gets the state for "rejected".

This state is for when the invitation was explicitly rejected.

◆ Sent

fm.liveswitch.InvitationState.Sent =(4)

Gets the state for "sent".

This state is for when the invite is sent in a way that does not allow feedback to be returned.

◆ Unknown

fm.liveswitch.InvitationState.Unknown =(1)

Gets the unknown state.