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

Contents

Overview

A Presence describe the reachability, and activities of a presentity. A Presence provides a list of contact methods that describe to the viewer how to reach the presentity. The viewer can choose any one of the contact methods based on circumstances. In addition, the Presence includes a list of activities which describe what the presentity is currently doing.

Members

Name Type Required Description

collabId

beeId

CollabId of the snapshot

contactMethods

contactMethod[]

Returns the set of contact methods which may describe how to communicate with the presentity. The returned list is sorted by priority. The ContactMethod with the highest priority will be the first element in the returned list.

currentActivities

activity[]

Gets the current set of activities. Activities may exist for calendar appointments or other user activities.

modificationTimestamp

long

Returns the time of the last modification of this presence object, or -1 if the time is unknown. The addition or removal of a ContactMethod or Activity as well as the change the status of a ContactMethod is considered a modification.

Hierarchy

Inherits From

Applied Markers

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:presence xsi:type="obh:presence" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:contactMethods>your_contactMethod_0</obh:contactMethods>
        <obh:contactMethods>your_contactMethod_1</obh:contactMethods>
        <obh:contactMethods>your_contactMethod_2</obh:contactMethods>
        <obh:currentActivities>your_activity_0</obh:currentActivities>
        <obh:currentActivities>your_activity_1</obh:currentActivities>
        <obh:currentActivities>your_activity_2</obh:currentActivities>
        <obh:modificationTimestamp>your_long_0</obh:modificationTimestamp>
</obh:presence>

JSON Example

(show inherited members)

{
    "beeType":"presence",
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "contactMethods":[
            { your_{http://www.oracle.com/beehive}contactMethods_as_contactMethod0 },
            { your_{http://www.oracle.com/beehive}contactMethods_as_contactMethod1 },
            { your_{http://www.oracle.com/beehive}contactMethods_as_contactMethod2 }
        ],
        "currentActivities":[
            { your_{http://www.oracle.com/beehive}currentActivities_as_activity0 },
            { your_{http://www.oracle.com/beehive}currentActivities_as_activity1 },
            { your_{http://www.oracle.com/beehive}currentActivities_as_activity2 }
        ],
        "modificationTimestamp":your_{http://www.oracle.com/beehive}modificationTimestamp_as_long0
}

XML Schema


<xs:complexType name="presence">
    <xs:complexContent>
        <xs:extension base="tns:identifiableSnapshot">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="contactMethods" type="tns:contactMethod"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="currentActivities" type="tns:activity"/>
                <xs:element name="modificationTimestamp" type="xs:long"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to presence

Referenced By Resources

Usage Resource Method
Response Current User Utilities Read Presence
Request Presence Batch Start Watching
Request Presence Batch Stop Watching
Response Presence Read
Response Presence Read Batch
Request Presence Read Batch

Referenced By Representaions