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

Contents

Overview

Resource WikiRenderDataContext is used to instruct the Wiki service on how to generate the data portion of a WikiPage.
It is meant to be used in conjunction with the renderWikiPage(...) call when using the STATIC_ONLY WikiRenderMode. The Wiki Service provides three WikiRenderDataModes: RENDER_LINKS, RENDER_PLUGINS and RENDER_ALL, to extract and render different subsets of the page content. The data portion returned is a JSON Array that contains the rendered contents of any dynamic links and plugins in the Wiki page. The JSON array maps each Bond collabId to its rendered link information, including the link href, inner HTML, whether the link is wanted, etc. The StaticOnlyRenderer renders each link with a String of javascript code that - when executed in the page - will update links on the page to use the resolved link content returned from the renderData method.

Members

Name Type Description

HREFContexts

hrefContext[]

The set of HRefContexts used for rendering Markup link syntax into HRefs.

mode

wikiRenderDataMode

The WikiRenderDataMode, which determines what data will be rendered, either RENDER_PLUGINS, RENDER_LINKS or RENDER_ALL.

snapshotId

string

The SnapshotId of the associated WikiPage

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:wikiRenderDataContext xsi:type="obh:wikiRenderDataContext" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:HREFContexts>your_hrefContext_0</obh:HREFContexts>
        <obh:HREFContexts>your_hrefContext_1</obh:HREFContexts>
        <obh:HREFContexts>your_hrefContext_2</obh:HREFContexts>
        <obh:mode>your_wikiRenderDataMode_0</obh:mode>
        <obh:snapshotId>your_string_0</obh:snapshotId>
</obh:wikiRenderDataContext>

JSON Example

(show inherited members)

{
    "beeType":"wikiRenderDataContext",
        "HREFContexts":[
            { your_{http://www.oracle.com/beehive}HREFContexts_as_hrefContext0 },
            { your_{http://www.oracle.com/beehive}HREFContexts_as_hrefContext1 },
            { your_{http://www.oracle.com/beehive}HREFContexts_as_hrefContext2 }
        ],
        "mode":{ your_{http://www.oracle.com/beehive}mode_as_wikiRenderDataMode0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}

XML Schema


<xs:complexType name="wikiRenderDataContext">
    <xs:sequence>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="HREFContexts" nillable="true" type="tns:hrefContext"/>
        <xs:element minOccurs="0" name="mode" type="tns:wikiRenderDataMode"/>
        <xs:element minOccurs="0" name="snapshotId" type="xs:string"/>
    </xs:sequence>
</xs:complexType>

        

References

The following data represents the references to wikiRenderDataContext

Referenced By Resources

Usage Resource Method
Response Wiki Page Get Default Data Render Context
Request Wiki Page Render Data

Referenced By Representaions

Not Referenced Directly by Representations