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

Contents

Examples
Overview
References

Overview

This type represents the results of starting a REST-based IM session. The type is a convenience to return those items most likely needed by an application engaged in Instant Messaging and Presence.

Members

Name	Type	Description
presenceConnectionId	string	The id of the presence connection for the IM client. Use this id to update the presence of this contact method.
roster	roster	This is the effective roster for the current user. Note that this roster contains not only those users whose presence can be observed ("buddies"), but also inbound and outbound friend requests. The entries in the roster are of type presenceRosterEntry.

Hierarchy

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:instantMessagingSession xsi:type="obh:instantMessagingSession" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:presenceConnectionId>your_string_0</obh:presenceConnectionId>
<obh:roster>your_roster_0</obh:roster>
</obh:instantMessagingSession>

JSON Example

(show inherited members)

{
    "beeType":"instantMessagingSession",
        "presenceConnectionId":"your_{http://www.oracle.com/beehive}presenceConnectionId_as_string0",
        "roster":{ your_{http://www.oracle.com/beehive}roster_as_roster0 }
}

XML Schema


<xs:complexType name="instantMessagingSession">
    <xs:sequence>
        <xs:element minOccurs="0" name="presenceConnectionId" type="xs:string"/>
        <xs:element minOccurs="0" ref="tns:roster"/>
    </xs:sequence>
</xs:complexType>

References

The following data represents the references to instantMessagingSession

Referenced By Resources

Usage	Resource	Method
Response	Instant Messaging	Start IM

Referenced By Representaions

Not Referenced Directly by Representations