sipXcallLib home page


Public Types | Public Member Functions | List of all members
LinePresenceBase Class Referenceabstract

The LinePresenceBase class provides a set of pure virtual interfaces which allow for the setting and retrieval line presence and state information. More...

#include <LinePresenceBase.h>

Public Types

enum  ePresenceStateType { PRESENT = 1, ON_HOOK = 2, SIGNED_IN = 4 }
 Line Presence state type enumerations. More...
 

Public Member Functions

 LinePresenceBase (void)
 Default constructor. More...
 
virtual ~LinePresenceBase ()
 Destructor. More...
 
virtual void updateState (ePresenceStateType type, bool state)=0
 Update the presence / line state for this line. More...
 
virtual Url * getUri (void)=0
 Return the AOR for this line. More...
 
virtual bool getState (ePresenceStateType type)=0
 Return the presence / line state information for this line. More...
 

Detailed Description

The LinePresenceBase class provides a set of pure virtual interfaces which allow for the setting and retrieval line presence and state information.

Member Enumeration Documentation

Line Presence state type enumerations.

These are used collectively to represent the possible states of PRESENT, (NOT)PRESENT, ON_HOOK and (NOT)ON_HOOK.

Enumerator
PRESENT 

present state

ON_HOOK 

on/off hook state

SIGNED_IN 

ACD SIGNED-IN state.

Constructor & Destructor Documentation

LinePresenceBase ( void  )
inline

Default constructor.

virtual ~LinePresenceBase ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual bool getState ( ePresenceStateType  type)
pure virtual

Return the presence / line state information for this line.

virtual Url* getUri ( void  )
pure virtual

Return the AOR for this line.

virtual void updateState ( ePresenceStateType  type,
bool  state 
)
pure virtual

Update the presence / line state for this line.

Parameters
typeThe type of presence state to be updated.
stateThe state value to be updated.