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
Interface representing a transcript of instant messages.
ConversationTranscript extends Document which also allows it to be attached to other
artifacts if required.
A transcript captures the conversation between two actors irrespective of their specific end-points.
Members
Show inherited members
Projections
BASIC
EMPTY
FULL
META
Name
Type
Required
Description
actors
actor []
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.
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.
transcriptId
string
type
instantMessageTranscriptType
Gets the type of this transcript. Valid types are
CHAT_TRANSCRIPT - corresponding to messages in a GUI chat window
DAILY_TRANSCRIPT - corresponding to messages exchanged in one calendar day
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:instantMessageTranscript xsi:type="obh:instantMessageTranscript" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:actors>your_actor_0 </obh:actors>
<obh:actors>your_actor_1 </obh:actors>
<obh:actors>your_actor_2 </obh:actors>
<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:parent>your_entity_0 </obh:parent>
<obh:snapshotId>your_string_0 </obh:snapshotId>
<obh:transcriptId>your_string_0 </obh:transcriptId>
<obh:type>your_instantMessageTranscriptType_0 </obh:type>
</obh:instantMessageTranscript>
JSON Example
(show inherited members)
{
"beeType":"instantMessageTranscript",
"actors":[
{ your_{http://www.oracle.com/beehive}actors_as_actor0 },
{ your_{http://www.oracle.com/beehive}actors_as_actor1 },
{ your_{http://www.oracle.com/beehive}actors_as_actor2 }
],
"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",
"parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
"transcriptId":"your_{http://www.oracle.com/beehive}transcriptId_as_string0",
"type":{ your_{http://www.oracle.com/beehive}type_as_instantMessageTranscriptType0 }
}
XML Schema
<xs:complexType name="instantMessageTranscript">
<xs:complexContent>
<xs:extension base="tns:entity">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="actors" type="tns:actor"/>
<xs:element minOccurs="0" name="transcriptId" type="xs:string"/>
<xs:element minOccurs="0" name="type" type="tns:instantMessageTranscriptType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to instantMessageTranscript
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices