SessionState Enumeration

Namespace: Ozeki.VoIP
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 10.4.98

Syntax

public enum SessionState

Public Enumeration SessionState

public enum class SessionState

type SessionState

Members

Member name	Value	Description
Created	0	The session has been created but not yet started.
Setup	1	The session has been started but no response received yet.
TransferSetup	2	The session has been started but no response received yet.
Ringing	3	The session is in ringing state and the callee has not been accepted the call yet.
InCall	4	The session has been established and there is media communication between the parties.
CalleeOnHold	5	The caller put the callee on hold.
CallerOnHold	6	The callee put the caller on hold.
OnHold	7	The callee and the caller are both put on hold.
OnHoldInactive	8	The callee and the caller are both put on hold but the media channels are inactive.
TransferRequested	9	The caller or callee sent a transfer request, but the request has not been accepted or rejected.
Transferring	10	The transfer request has been accepted and the transferring is in progress.
TransferCompleted	11	The transfer completed successfully.
TransferFailed	12	There was an error during the transfer (e.g. the transfer target rejected the call)
CallerHungUp	13	The caller closed the session.
CalleeHungUp	14	The callee closed the session.
Redirected	15	The callee forwarded the call to another party.
NotFound	16	The callee system was contacted successfully but the given number was not found.
Busy	17	The callee rejected the call.
Cancelled	18	The caller cancelled the call.
NotAnswered	19	The callee was not answered the call in time.
Error	20	There was an error during the call (e.g. the callee sent a 400 Bad Request SIP message).
Aborted	21	The session was aborted from an outside source (e.g. server stopped).

The SessionState type exposes the following members.

Extension Methods

	Name	Description
	IsCompleted	Checks whether the active call has ended by one of the parties (the caller or callee sent a BYE request). (Defined by SessionStateEx)
	IsHeld	Check whether the call is being held by one of the parties. (Defined by SessionStateEx)
	IsInCall	Check whether the call is in active state and there is media communication between the two parties. (Defined by SessionStateEx)
	IsRinging	Check whether the call is setup state. (Defined by SessionStateEx)
	IsSessionEnded	Checks whether the session has ended. (Defined by SessionStateEx)
	IsSessionEndedWithError	Checks whether the session has ended with error. (Defined by SessionStateEx)
	IsSetup	Check whether the call is setup state. (Defined by SessionStateEx)
	IsTransferEnded	Check whether the transfer has ended (including success and failure too). (Defined by SessionStateEx)

Top

Reference

Ozeki.VoIP Namespace