  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Examples
Overview
References

Overview

A SubscriptionRoster contains all presence subscription state for a given presence watcher. It has an entry for each presentity to which the watcher has subscription to or from that is not in the state SubscriptionState.NONE.

A SubscriptionRoster has a CollabId so that an application can use the Object Event Framework to receive a notification whenever it is modified. A notification is sent whenever an entry is modified (either the stateTo or stateFrom) or whenever an entry is added or removed. To detect changes, the receiver of the change notification should reload the subscription roster using the PresenceControl.

Members

Name	Type	Description
collabId	beeId
entries	rosterEntry[]	The collection of presence entries in the current user's roster.

Hierarchy

Applied Markers

Identifiable

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:roster xsi:type="obh:roster" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:entries>your_rosterEntry_0</obh:entries>
        <obh:entries>your_rosterEntry_1</obh:entries>
        <obh:entries>your_rosterEntry_2</obh:entries>
</obh:roster>

JSON Example

(show inherited members)

{
    "beeType":"roster",
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "entries":[
            { your_{http://www.oracle.com/beehive}entries_as_rosterEntry0 },
            { your_{http://www.oracle.com/beehive}entries_as_rosterEntry1 },
            { your_{http://www.oracle.com/beehive}entries_as_rosterEntry2 }
        ]
}

XML Schema


<xs:complexType name="roster">
    <xs:sequence>
        <xs:element minOccurs="0" name="collabId" type="tns:beeId"/>
        <xs:element maxOccurs="unbounded" minOccurs="0" name="entries" type="tns:rosterEntry"/>
    </xs:sequence>
</xs:complexType>

References

The following data represents the references to roster

Referenced By Resources

Usage	Resource	Method
Response	Current User Utilities	Read Presence Roster