class JIDIdentity

A JID identity. More...

Full nameTelEngine::JIDIdentity
Definition#include <libs/yjingle/xmpputils.h>
InheritsTelEngine::RefObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods


Detailed Description

This class holds an identity for a JID

enum Category { Account, Client, Component, Gateway, CategoryUnknown }

Category

JID category enumeration

enum Type { AccountRegistered, ClientPhone, ComponentGeneric, ComponentPresence, GatewayGeneric, TypeUnknown }

Type

JID type enumeration

inline  JIDIdentity (Category c, Type t, const char* name = 0)

JIDIdentity

Constructor. Build a JID identity

Parameters:
cThe JID's category
tThe JID's type
nameThe name of this identity

 ~JIDIdentity ()

~JIDIdentity

[virtual]

Destructor

XMLElement*  toXML ()

toXML

Build an XML element from this identity

Returns: A valid XML element

bool  fromXML (const XMLElement* element)

fromXML

Build this identity from an XML element

Returns: True on succes

const String&  toString ()

toString

[const virtual]

Get a string representation of this object

Returns: This object's name

Reimplemented from GenObject.

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer from this object

Parameters:
nameThe requested pointer's name

Returns: Requested pointer or 0

Reimplemented from GenObject.

inline void  setName (const char* name)

setName

Set the name of this identity

Parameters:
nameNew identity name

inline const char*  categoryText (Category c)

categoryText

[static]

Lookup for a text associated with a given category

Returns: The category's name

inline Category  categoryValue (const char* c)

categoryValue

[static]

Lookup for a value associated with a given category name

Returns: The category's value

inline const char*  typeText (Type t)

typeText

[static]

Lookup for a text associated with a given category type

Returns: The category's type name

inline Type  typeValue (const char* t)

typeValue

[static]

Lookup for a value associated with a given category type

Returns: The category's type value


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.