documentContent

This class contains the document content.

We recommend that you represent instances of this type as a set of properties of its containing object. Users may access this object by opening a property sheet or launching an editor.

This class

Container Information

Contains instances of the following classes
Contained by instances of the following classes

Properties

This class has the following properties.

burstID

Identifies the values for the burst keys that produced the output.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 32767 characters

  • is searchable

New in Version 8.3 — Conditional Subscriptions

This property was added.

burstKey

Specifies the label for the burst key values that produced this document content.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 4095 characters

New in Version 8.3 — Conditional Subscriptions

The documentation for this property was updated.

context

Specifies the context data for the document.

This property may be encoded as an attachment in a method request message or response message if the encoding parameter is set toMIME. The encoding parameter varies from method to method; see the bibus » addOptions » dataEncoding propertyand the bibus » queryOptions » dataEncoding propertyfor additional details.

This property contains data to be used only by IBM® Cognos®software. The structure of this data is subject to change without notice. Client applications should not attempt to interpret or modify this data.

This property

New in Version 8.3 — Conditional Subscriptions

This property was added.

New in Version 8.3 — Improved Context Metadata for Selection

This property was added.

contextBlockCount

Specifies the number of context blocks stored in the context property.

This property

  • is of type int

    is encoded as type tns:intProp

New in Version 8.3 — Conditional Subscriptions

This property was added.

New in Version 8.3 — Improved Context Metadata for Selection

This property was added.

data

Contains the MIME data. The data format is specified in the dataType property.

This property may be encoded as an attachment in a method request message or response message if the encoding parameter is set toMIME. The encoding parameter varies from method to method; see the bibus » addOptions » dataEncoding propertyand the bibus » queryOptions » dataEncoding propertyfor additional details.

This property

  • is of type base64Binary

    is encoded as type tns:base64BinaryMIMEProp

dataPathInfo

Contains the URI for the binary data for this object.

This property

  • is of type anyURI

    is encoded as type tns:anyURIProp

  • is read-only

dataSize

Specifies the number of bytes of data.

This property

  • is of type nonNegativeInteger

    is encoded as type tns:nonNegativeIntegerProp

  • is read-only

dataType

Specifies the media type of the value of property data. The media type is expressed as a type/subtype pair. For example, image/jpeg identifies images in JPEG format using JFIF encoding, and text/plain identifies plaintext.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 255 characters

format

Specifies the rendering format.

When used in the bibus » account class or the bibus » contact class, this property specifies the preferred output format of reports for the account or contact.

When used in the bibus » documentContent class or bibus » output class this property specifies the format of the data contained in the object.

This property

  • is of type bibus » outputFormatEnum

    is encoded as type tns:nmtokenProp

  • must contain no more than 10 characters

  • is searchable

New in Version 8.3 — Conditional Subscriptions

This property was added.

images

Contains the images for the document content.

lastPage

Specifies the page number for the last page of the document.

This property

  • is of type NMTOKEN

    is encoded as type tns:nmtokenProp

  • can contain at least 255 characters

New in Version 8.3 — Conditional Subscriptions

This property was added.

locale

Specifies the locale for this object. The format of the locale follows the Internet Engineering Task Force (IETF) open standard RFC3066.

When used by bibus » contact, this property determines the language and data format of the returned content.

Use the appropriate language so that users understand object names and search paths. Use the appropriate region so that date, time, and currency values are presented in the proper localized format.

This property

  • is of type language

    is encoded as type tns:languageProp

  • must contain no more than 64 characters

  • is searchable

pages

Contains the pages of HTML output for the document.

The first page of the document is stored within this object to decrease the time needed to access the first page.

New in Version 8.3 — Conditional Subscriptions

This property was added.

recipients

Refers to the burst document content recipients.

This property

recipientsEMail

Contains the set of email recipients for the burst document content.

This property

  • is an array of type string

    is encoded as type tns:stringArrayProp