OpalPresEntity Class Reference

#include <pres_ent.h>

Inheritance diagram for OpalPresEntity:

List of all members.

Public Types
enum	State {   Unknown = SIPPresenceInfo::Unknown, Available, NotAvailable, Unchanged,   ExtendedBase = 100, UnknownExtended = ExtendedBase + SIPPresenceInfo::UnknownExtended, Appointment, Away,   Breakfast, Busy, Dinner, Holiday,   InTransit, LookingForWork, Lunch, Meal,   Meeting, OnThePhone, Other, Performance,   PermanentAbsence, Playing, Presentation, Shopping,   Sleeping, Spectator, Steering, Travel,   TV, Vacation, Working, Worship }
Public Member Functions
virtual bool	Open (OpalManager &manager)
virtual bool	Open (OpalManager &manager, const OpalGloballyUniqueID &uid)=0
virtual bool	IsOpen () const=0
virtual bool	Close ()=0
virtual bool	SetPresence (State state, const PString &note=PString::Empty())=0
virtual bool	RemovePresence ()=0
virtual bool	HasAttribute (const PString &key) const
virtual PString	GetAttribute (const PString &key, const PString &deflt=PString::Empty()) const
virtual void	SetAttribute (const PString &key, const PString &value)
Static Public Member Functions
static OpalPresEntity *	Create (const PString &url)
Static Public Attributes
static const char *	AddressOfRecordKey
static const char *	AuthNameKey
static const char *	AuthPasswordKey
static const char *	FullNameKey
static const char *	TimeToLiveKey
Protected Attributes
OpalGloballyUniqueID	m_guid
PStringToString	m_attributes

---

Member Enumeration Documentation

enum OpalPresEntity::State

Enumerator:

Unknown
Available
NotAvailable
Unchanged
ExtendedBase
UnknownExtended
Appointment
Away
Breakfast
Busy
Dinner
Holiday
InTransit
LookingForWork
Lunch
Meal
Meeting
OnThePhone
Other
Performance
PermanentAbsence
Playing
Presentation
Shopping
Sleeping
Spectator
Steering
Travel
TV
Vacation
Working
Worship

---

Member Function Documentation

static OpalPresEntity* OpalPresEntity::Create

(

const PString &

url

)

[static]

virtual bool OpalPresEntity::Open

(

OpalManager &

manager

)

[virtual]

virtual bool OpalPresEntity::Open	(	OpalManager &	manager,
		const OpalGloballyUniqueID &	uid
	)			[pure virtual]

Implemented in SIP_PresEntity.

virtual bool OpalPresEntity::IsOpen

(

)

const [pure virtual]

Implemented in SIP_PresEntity.

virtual bool OpalPresEntity::Close

(

)

[pure virtual]

Implemented in SIP_PresEntity.

virtual bool OpalPresEntity::SetPresence	(	State	state,
		const PString &	note = PString::Empty()
	)			[pure virtual]

Implemented in SIP_PresEntity.

virtual bool OpalPresEntity::RemovePresence

(

)

[pure virtual]

Implemented in SIP_PresEntity.

virtual bool OpalPresEntity::HasAttribute

(

const PString &

key

)

const [inline, virtual]

virtual PString OpalPresEntity::GetAttribute	(	const PString &	key,
		const PString &	deflt = PString::Empty()
	)			const [inline, virtual]

virtual void OpalPresEntity::SetAttribute	(	const PString &	key,
		const PString &	value
	)			[inline, virtual]

---

Member Data Documentation

const char* OpalPresEntity::AddressOfRecordKey [static]

const char* OpalPresEntity::AuthNameKey [static]

const char* OpalPresEntity::AuthPasswordKey [static]

const char* OpalPresEntity::FullNameKey [static]

const char* OpalPresEntity::TimeToLiveKey [static]

OpalGloballyUniqueID OpalPresEntity::m_guid [protected]

PStringToString OpalPresEntity::m_attributes [protected]

---

The documentation for this class was generated from the following file:

• pres_ent.h

---