RPID/Rich Presence Extensions to PIDF (RFC 4480)
[Event and Presence Framework]

RPID/Rich Presence Extensions to PIDF (RFC 4480). More...

Data Structures
struct	pjrpid_element
Enumerations
enum	pjrpid_activity { PJRPID_ACTIVITY_UNKNOWN, PJRPID_ACTIVITY_AWAY, PJRPID_ACTIVITY_BUSY }
enum	pjrpid_element_type { PJRPID_ELEMENT_TYPE_PERSON }
Functions
void	pjrpid_element_dup (pj_pool_t *pool, pjrpid_element *dst, const pjrpid_element *src)
pj_status_t	pjrpid_add_element (pjpidf_pres *pres, pj_pool_t *pool, unsigned options, const pjrpid_element *elem)
pj_status_t	pjrpid_get_element (const pjpidf_pres *pres, pj_pool_t *pool, pjrpid_element *elem)

---

Detailed Description

This file provides tools for managing subset of RPID elements into PIDF document.

---

Enumeration Type Documentation

enum pjrpid_activity

This enumeration describes subset of standard activities as described by RFC 4880, RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF).

Enumerator:

PJRPID_ACTIVITY_UNKNOWN	Activity is unknown. The activity would then be conceived in the "note" field.
PJRPID_ACTIVITY_AWAY	The person is away
PJRPID_ACTIVITY_BUSY	The person is busy

enum pjrpid_element_type

This enumeration describes types of RPID element.

Enumerator:

PJRPID_ELEMENT_TYPE_PERSON

RPID <person> element

---

Function Documentation

void pjrpid_element_dup	(	pj_pool_t *	pool,
		pjrpid_element *	dst,
		const pjrpid_element *	src
	)

Duplicate RPID element.

Parameters:

	pool	Pool.
	dst	Destination structure.
	src	Source structure.

pj_status_t pjrpid_add_element	(	pjpidf_pres *	pres,
		pj_pool_t *	pool,
		unsigned	options,
		const pjrpid_element *	elem
	)

Add RPID element information into existing PIDF document. This will also add the appropriate XML namespace attributes into the presence's XML node, if the attributes are not already present, and also a <note> element to the first <tuple> element of the PIDF document.

Parameters:

	pres	The PIDF presence document.
	pool	Pool.
	options	Currently unused, and must be zero.
	elem	RPID element information to be added into the PIDF document.

Returns:

PJ_SUCCESS on success.

pj_status_t pjrpid_get_element	(	const pjpidf_pres *	pres,
		pj_pool_t *	pool,
		pjrpid_element *	elem
	)

Get RPID element information from PIDF document, if any.

Parameters:

	pres	The PIDF document containing RPID elements.
	pool	Pool to duplicate the information.
	elem	Structure to receive the element information.

Returns:

PJ_SUCCESS if the document does contain RPID element and the information has been parsed successfully.