Presence_XCAPDiff Module

Denis Bilenko

Edited by

Denis Bilenko

Revision History
Revision $Revision$$Date: 2009-07-21 09:45:05 +0200 (Tue, 21 Jul 2009) $

Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications

Chapter 1. Admin Guide

1.1. Overview

The presence_xcapdiff is an OpenSIPS module that adds support for the "xcap-diff" event to presence and pua. At the moment, the module just registers the event but doesn't do any event-specific processing. The module will automatically determine if the presence and/or pua modules are present and if so it will register the xcap-diff event with them. This allows the module to automatically offer presence or pua related functionality simply based on the presence of the aforementioned modules in the OpenSIPS configuration, without any need for manual configuration.

Registering the event with pua, allows the XCAP server to publish the xcap-event when some modification of a document happens. Registering the event with presence allows clients to subscribe to the event.

The module is intended to be used with the OpenXCAP server (, although it doesn't contain any OpenXCAP-specific code and should be usable with any XCAP server.

1.2. Dependencies

1.2.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • presence module - to enable clients to subscribe to the xcap-diff event package.

  • pua module - to be able to publish the xcap-diff event when some modification of a document happens.

  • pua_mi module - to enable pua to publish the xcap-diff event using the MI interface. This is needed if this module is intended to be used in conjunction with OpenXCAP.

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • None.