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

Contents

Overview

Conference object represents a snapshot of a Conference artifact. It includes state, conference settings and optional conference template reference. Conference can have one or more conferencing sessions, but only one of the sessions can be running at a time. The list of conference sessions and a reference to the running session are stored in the conference object. If a conference is created from a template, it has a reference to the corresponding Conference Template for information purposes.

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

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

collabId

beeId

CollabId of the snapshot

conferenceType

conferenceType

Returns the type of the conference artifact, which reflects its common use (like instant conference, scheduled conference via calendar, chat room and etc.).

createdOn

dateTime

Entity's creation date

creator

actor

The actor that created this entity

creatorName

string

Get creator name.

deleted

boolean

Deletion flag. If this property is set to true the entity is deleted.

description

string

Get conference description.

endTime

dateTime

Get conference end time.

guestRoleCount

int

Get conference guest role count.

hostNames

string[]

Returns conference host names. Returned array contains one entry for each conference host in a form of string.

isHost

boolean

Returns true if current user is a host of this conference or false otherwise.

isInvited

boolean

Returns true if current user is explicitly or implicitly (via group) is invited into the conference.

isPublic

boolean

Returns boolean flag indicating whether this conference artifact is public or not.

keyProtectedRoleCount

int

Get key protected role count.

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

runningSession

conferenceSession

Get running conference session or null if there are no running session. Loaded by RUNNING_SESSION projection.

settings

conferenceSettings

Get read-only interface to conference settings. Loaded by SETTINGS projection.

snapshotId

string

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

startTime

dateTime

Get conference start time.

state

conferenceState

Get current conference state. Initially conference is created in a ConferenceNotStarted state. The conference becomes started when a conference participant, who has a right to start the conference, is requesting the conference address for the first time. Loaded by BASIC projection.

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

visibility

string

Get the visibility status of the artifact.

Hierarchy

Inherits From

Applied Markers

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:conference xsi:type="obh:conference" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:conferenceType>your_conferenceType_0</obh:conferenceType>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:creatorName>your_string_0</obh:creatorName>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:description>your_string_0</obh:description>
        <obh:endTime>your_dateTime_0</obh:endTime>
        <obh:guestRoleCount>your_int_0</obh:guestRoleCount>
        <obh:hostNames>your_string_0</obh:hostNames>
        <obh:hostNames>your_string_1</obh:hostNames>
        <obh:hostNames>your_string_2</obh:hostNames>
        <obh:isHost>your_boolean_0</obh:isHost>
        <obh:isInvited>your_boolean_0</obh:isInvited>
        <obh:isPublic>your_boolean_0</obh:isPublic>
        <obh:keyProtectedRoleCount>your_int_0</obh:keyProtectedRoleCount>
        <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:properties>your_collabProperties_0</obh:properties>
        <obh:runningSession>your_conferenceSession_0</obh:runningSession>
        <obh:settings>your_conferenceSettings_0</obh:settings>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:startTime>your_dateTime_0</obh:startTime>
        <obh:state>your_conferenceState_0</obh:state>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewer>your_actor_0</obh:viewer>
        <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
        <obh:visibility>your_string_0</obh:visibility>
</obh:conference>

JSON Example

(show inherited members)

{
    "beeType":"conference",
        "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 }
        ],
        "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "conferenceType":{ your_{http://www.oracle.com/beehive}conferenceType_as_conferenceType0 },
        "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
        "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
        "creatorName":"your_{http://www.oracle.com/beehive}creatorName_as_string0",
        "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "endTime":"your_{http://www.oracle.com/beehive}endTime_as_dateTime0",
        "guestRoleCount":your_{http://www.oracle.com/beehive}guestRoleCount_as_int0,
        "hostNames":[
            "your_{http://www.oracle.com/beehive}hostNames_as_string0",
            "your_{http://www.oracle.com/beehive}hostNames_as_string1",
            "your_{http://www.oracle.com/beehive}hostNames_as_string2"
        ],
        "isHost":your_{http://www.oracle.com/beehive}isHost_as_boolean0,
        "isInvited":your_{http://www.oracle.com/beehive}isInvited_as_boolean0,
        "isPublic":your_{http://www.oracle.com/beehive}isPublic_as_boolean0,
        "keyProtectedRoleCount":your_{http://www.oracle.com/beehive}keyProtectedRoleCount_as_int0,
        "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 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "runningSession":{ your_{http://www.oracle.com/beehive}runningSession_as_conferenceSession0 },
        "settings":{ your_{http://www.oracle.com/beehive}settings_as_conferenceSettings0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "startTime":"your_{http://www.oracle.com/beehive}startTime_as_dateTime0",
        "state":{ your_{http://www.oracle.com/beehive}state_as_conferenceState0 },
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "viewer":{ your_{http://www.oracle.com/beehive}viewer_as_actor0 },
        "viewerProperties":{ your_{http://www.oracle.com/beehive}viewerProperties_as_collabProperties0 },
        "visibility":"your_{http://www.oracle.com/beehive}visibility_as_string0"
}

XML Schema


<xs:complexType name="conference">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element minOccurs="0" name="conferenceType" type="tns:conferenceType"/>
                <xs:element minOccurs="0" name="creatorName" type="xs:string"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="endTime" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="guestRoleCount" type="xs:int"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="hostNames" nillable="true" type="xs:string"/>
                <xs:element minOccurs="0" name="isHost" type="xs:boolean"/>
                <xs:element minOccurs="0" name="isInvited" type="xs:boolean"/>
                <xs:element minOccurs="0" name="isPublic" type="xs:boolean"/>
                <xs:element minOccurs="0" name="keyProtectedRoleCount" type="xs:int"/>
                <xs:element minOccurs="0" name="runningSession" type="tns:conferenceSession"/>
                <xs:element minOccurs="0" name="settings" type="tns:conferenceSettings"/>
                <xs:element minOccurs="0" name="startTime" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="state" type="tns:conferenceState"/>
                <xs:element minOccurs="0" name="visibility" type="xs:string"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to conference

Referenced By Resources

Usage Resource Method
Response Conference Copy
Response Conference Create
Response Conference List
Response Conference Read
Response Conference Read Batch
Request Conference Read Batch
Response Conference Update

Referenced By Representaions