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

Contents

Examples
Overview
References

Overview

An event in the pending notifications queue when one or more instant messages have been received by an IM client in the current session.

Members

Show inherited members

Name	Type	Description
collabId	beeId	Gets the CollabId of the changed object.
messages	instantMessage[]	The instant message(s) received.
snapshotId	string	Gets the SnapshotId of the affected object after the change. If this is null, it indicates that the SnaphotId is unknown. It is expected that the application will reload an object's snapshot when it receives an event with an unknown SnapshotId.

Hierarchy

Inherits From

objectChangeEvent

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:instantMessageEvent xsi:type="obh:instantMessageEvent" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:messages>your_instantMessage_0</obh:messages>
        <obh:messages>your_instantMessage_1</obh:messages>
        <obh:messages>your_instantMessage_2</obh:messages>
        <obh:snapshotId>your_string_0</obh:snapshotId>
</obh:instantMessageEvent>

JSON Example

(show inherited members)

{
    "beeType":"instantMessageEvent",
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "messages":[
            { your_{http://www.oracle.com/beehive}messages_as_instantMessage0 },
            { your_{http://www.oracle.com/beehive}messages_as_instantMessage1 },
            { your_{http://www.oracle.com/beehive}messages_as_instantMessage2 }
        ],
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}

XML Schema


<xs:complexType name="instantMessageEvent">
    <xs:complexContent>
        <xs:extension base="tns:objectChangeEvent">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="messages" type="tns:instantMessage"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to instantMessageEvent

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations