A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference
Release 2 (2.0.1.7)
E16658-04
Overview
Any entity which is an InstantMessageRecipient must have an
InstantMessageReceptacle associated with it. An InstantMessageReceptacle
allows the entity to be able to recieve instant messages sent to it. A
receptacle contains one or more OnlineInstantMessageSets which contain the
instant messages received by the entity when online.
Members
Show inherited members
Projections
BASIC
EMPTY
FULL
META
Name
Type
Required
Description
allOims
entity []
Gets all the OnlineInstantMessageSet (OIMS) objects associated with this receptacle object.
allResources
string []
Gets the names of all the OnlineInstantMessageSets associated with this receptacle object.
attachedMarkers
marker []
Set of marker elements associated with the entity.
attachedReminders
reminder []
List of reminders attached to the entity
attachedSubscriptions
subscription []
List of subscriptions attached to the entity
collabId
beeId
CollabId of the snapshot
createdOn
dateTime
Entity's creation date
creator
actor
The actor that created this entity
deleted
boolean
Deletion flag. If this property is set to true the entity is
deleted.
modifiedBy
actor
The actor that last modified the entity
modifiedOn
dateTime
The date when entity was last modified
name
string
Name of the entity.
numOnline
int
Returns the number of OnlineInstantMessageSets contained in this receptacle object.
parent
entity
The parent for this entity.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
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:instantMessageReceptacle xsi:type="obh:instantMessageReceptacle" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:allOims>your_entity_0 </obh:allOims>
<obh:allOims>your_entity_1 </obh:allOims>
<obh:allOims>your_entity_2 </obh:allOims>
<obh:allResources>your_string_0 </obh:allResources>
<obh:allResources>your_string_1 </obh:allResources>
<obh:allResources>your_string_2 </obh:allResources>
<obh:attachedMarkers>your_marker_0 </obh:attachedMarkers>
<obh:attachedMarkers>your_marker_1 </obh:attachedMarkers>
<obh:attachedMarkers>your_marker_2 </obh:attachedMarkers>
<obh:attachedReminders>your_reminder_0 </obh:attachedReminders>
<obh:attachedReminders>your_reminder_1 </obh:attachedReminders>
<obh:attachedReminders>your_reminder_2 </obh:attachedReminders>
<obh:attachedSubscriptions>your_subscription_0 </obh:attachedSubscriptions>
<obh:attachedSubscriptions>your_subscription_1 </obh:attachedSubscriptions>
<obh:attachedSubscriptions>your_subscription_2 </obh:attachedSubscriptions>
<obh:collabId>your_beeId_0 </obh:collabId>
<obh:createdOn>your_dateTime_0 </obh:createdOn>
<obh:creator>your_actor_0 </obh:creator>
<obh:deleted>your_boolean_0 </obh:deleted>
<obh:modifiedBy>your_actor_0 </obh:modifiedBy>
<obh:modifiedOn>your_dateTime_0 </obh:modifiedOn>
<obh:name>your_string_0 </obh:name>
<obh:numOnline>your_int_0 </obh:numOnline>
<obh:parent>your_entity_0 </obh:parent>
<obh:snapshotId>your_string_0 </obh:snapshotId>
</obh:instantMessageReceptacle>
JSON Example
(show inherited members)
{
"beeType":"instantMessageReceptacle",
"allOims":[
{ your_{http://www.oracle.com/beehive}allOims_as_entity0 },
{ your_{http://www.oracle.com/beehive}allOims_as_entity1 },
{ your_{http://www.oracle.com/beehive}allOims_as_entity2 }
],
"allResources":[
"your_{http://www.oracle.com/beehive}allResources_as_string0",
"your_{http://www.oracle.com/beehive}allResources_as_string1",
"your_{http://www.oracle.com/beehive}allResources_as_string2"
],
"attachedMarkers":[
{ your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
{ your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
{ your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
],
"attachedReminders":[
{ your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
{ your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
{ your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
],
"attachedSubscriptions":[
{ your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
{ your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
{ your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
],
"collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
"createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
"creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
"deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
"modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
"modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
"name":"your_{http://www.oracle.com/beehive}name_as_string0",
"numOnline":your_{http://www.oracle.com/beehive}numOnline_as_int0,
"parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}
XML Schema
<xs:complexType name="instantMessageReceptacle">
<xs:complexContent>
<xs:extension base="tns:entity">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="allOims" type="tns:entity"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="allResources" type="xs:string"/>
<xs:element name="numOnline" type="xs:int"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to instantMessageReceptacle
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices