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

Contents

Overview

Represents a unit of conversation. A message is an artifact created by a sender and owned by a specific recipient. If a sender sends the same message to multiple recipients, each recipient owns a distinct copy of a message artifact.

Members

Name Type Required Description

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

body

content

Body of the message. The body typically contains a free-form payload but may potentially include an hierarchy of parts.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

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.

deliveredTime

dateTime

Time when the message is delivered to the INBOX of this intended recipient

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.

properties

collabProperties

The properties of the artifact that are shared among all the actors

receivers

anyType[]

Intended collection of recipients of this message.

references

artifact[]

This member is deprecated and no longer in use.

sender

actor

Sender of the message.

snapshotId

string

Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

viewer

actor

The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties

The viewer properties of the artifact that are private to loading actor

Hierarchy

message is an abstract type. It cannot directly be used. Rather, one of its subtypes must be used

Inherits From

Inherited By

Applied Markers

XML Schema


<xs:complexType abstract="true" name="message">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element minOccurs="0" name="body" type="tns:content"/>
                <xs:element minOccurs="0" name="deliveredTime" type="tns:dateTime"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="receivers" type="xs:anyType"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="references" type="tns:artifact"/>
                <xs:element minOccurs="0" name="sender" type="tns:actor"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to message

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations