Chapter 3. Features

Table of Contents

Archive of Jingle call events
Retrieving a list of collections
Retrieve a list of entries from collection
Archive of login/logout events
Retrieving a list of collections
Retrieve a list of entries from collection
Retrieval of all events and messages
Retrieve a list of entries
Retrieval of recent events
Retrieval of list of all recent events
Retrieval of list of all recent events in specified time period
Requesting filtered list of recent events
Retrieval of transferred files metadata
Retrieval of form fields
Retrieval of transferred files metadata

Tigase Unified Archive Component contains few additional features useful for working with archives containing not only messages but also other informations.

Archive of Jingle call events

For instructions on how to enable Jingle call archive see the section called “Enabling Jingle call archive” section.

Retrieving a list of collections

To retrieve collections with informations about Jingle call events item-type attribute needs to be added to <list/> element from section 7.1 Retrieving a List of Collections of XEP-0136 specification with value set to call.

A result it will be returned as specified in XEP-0136, but <list/> element will contain <events/> element for each collections instead of <chat/> element. Additionally <list/> element will have item-type attribute set to call.

Example

Request to retrieve collection of calls with juliet@capulet.com between 2014-01-01 00:00:00 and 2014-05-01 00:00:00

<iq type="get" id="query1">
    <list xmlns='urn:xmpp:archive'
      with='juliet@capulet.com'
      start='2014-01-01T00:00:00Z'
      end='2014-05-01T00:00:00Z'
      item-type='call'/>
</iq>

Response with single collection starting at 2014-02-01 13:01:34

<iq type="result" id="query2">
    <list xmlns='urn:xmpp:archive' item-type='call'>
        <events with='juliet@capulet.com' start='2014-02-01T13:01:34Z'/>
        <set xmlns="http://jabber.org/protocol/rsm">
            <first index='0'>0</first>
            <last>0</last>
            <count>1</count>
        </set>
    </events>
</iq>

Retrieve a list of entries from collection

To retrieve items with informations about Jingle call from collection item-type attribute needs to be added to <retrieve/> element from section 7.2 Retrieving a Collection of XEP-0136 specification with value set to call.

A result will be returned as specified in XEP-0136, but instead of <chat/> element <events/> element will be returned. Moreover instead of message subelements in <from/> and <to/> elements, there will be custom element containing information about call, ie. Jingle session ID - <sid/>.

Example

Request to retrieve calls events with juliet@capulet.com between 2014-02-01 13:00:00 and 2014-05-01 00:00:00

<iq type="get" id="query1">
    <retrieve xmlns='urn:xmpp:archive'
      with='juliet@capulet.com'
      start='2014-02-01T13:00:00Z'
      end='2014-05-01T00:00:00Z'
      item-type='call'/>
</iq>

Response with single entry of incoming call at 2014-02-01 13:01:34 with call SID.

<iq type="result" id="query2">
    <events xmlns='urn:xmpp:archive' with='juliet@capulet.com' start='2014-02-01T13:00:00Z' item-type='call'>
        <from secs='94' item-type='call'><sid>SID_OF_CALL</sid></from>
        <set xmlns="http://jabber.org/protocol/rsm">
            <first index='0'>0</first>
            <last>0</last>
            <count>1</count>
        </set>
    </events>
</iq>