Overview

Notification message for a user.

A Notification is a type of message which is generated and sent to a specific user. Based on different Projections these are the attributes returned: The attributes that are retrievied in the EMPTY projection: -- Notification Collab Id (Handle) The attributes that are retrievied in the SECURITY projection: -- Notification Collab Id (Handle) -- Owner Collab Id -- Snapshot Id The attributes that are retrievied in the BASIC projection: -- Notification Collab Id (Handle) -- Owner -- Creator -- Modifier -- Name -- Properties -- Parent -- Content -- Schema -- Subscription -- Priority -- Snapshot Id -- References (Source) All attributes are retreived for FULL Projection.

Members

Show inherited members

Projections
Name Type Required Description

actionDoer

anyType

Gets the Sender of the Notification

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

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

collabId

beeId

CollabId of the snapshot

content

content

Gets the content of the Notification.

contentMetadata

collabProperties

Returns the content metadata of this Notification.

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.

eventDefinition

eventDefinition

Gets the Event Definition for this Notification.

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

origin

artifact

Gets the Origin which generated this Notification. Can be either the user subscription or the Reminder.

parent

entity

The parent for this entity.

priority

priority

Gets the priority of the Notification.

properties

collabProperties

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

recipient

anyType

Gets the Recipient of the Notification. This is the actual owner of the Notification.

schemaProperties

collabProperties

Returns the properties used to populate the NotificationSchema when generating this Notificatino.

snapshotId

string

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

source

entity

Gets the source of the Notification. Can be the invitation, or document that the notification is about.

subscription

artifact

Gets the subscription which created this Notification.

title

string

Gets the Title under which this Notification should be filed and shown to the user.

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

Inherits From

Examples

Below are examples in 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:notification xsi:type="obh:notification" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <actionDoer>your_anyType_0</actionDoer>
        <attachedMarkers>your_marker_0</attachedMarkers>
        <attachedMarkers>your_marker_1</attachedMarkers>
        <attachedMarkers>your_marker_2</attachedMarkers>
        <attachedReminders>your_reminder_0</attachedReminders>
        <attachedReminders>your_reminder_1</attachedReminders>
        <attachedReminders>your_reminder_2</attachedReminders>
        <attachedSubscriptions>your_subscription_0</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_1</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_2</attachedSubscriptions>
        <bonds>your_bond_0</bonds>
        <bonds>your_bond_1</bonds>
        <bonds>your_bond_2</bonds>
        <changeStatus>your_changeStatus_0</changeStatus>
        <collabId>your_beeId_0</collabId>
        <content>your_content_0</content>
        <contentMetadata>your_collabProperties_0</contentMetadata>
        <createdOn>your_dateTime_0</createdOn>
        <creator>your_actor_0</creator>
        <deleted>your_boolean_0</deleted>
        <eventDefinition>your_eventDefinition_0</eventDefinition>
        <modifiedBy>your_actor_0</modifiedBy>
        <modifiedOn>your_dateTime_0</modifiedOn>
        <name>your_string_0</name>
        <origin>your_artifact_0</origin>
        <parent>your_entity_0</parent>
        <priority>your_priority_0</priority>
        <properties>your_collabProperties_0</properties>
        <recipient>your_anyType_0</recipient>
        <schemaProperties>your_collabProperties_0</schemaProperties>
        <snapshotId>your_string_0</snapshotId>
        <source>your_entity_0</source>
        <subscription>your_artifact_0</subscription>
        <title>your_string_0</title>
        <userCreatedOn>your_dateTime_0</userCreatedOn>
        <userModifiedOn>your_dateTime_0</userModifiedOn>
        <viewer>your_actor_0</viewer>
        <viewerProperties>your_collabProperties_0</viewerProperties>
</obh:notification>

Referenced By Representaions

Not Referenced Directly by Representations