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

Contents

Examples
Overview
References

Overview

Interface representing the headers of an Also see oracle.csi.controls.InstantMessageFactory that is used to create an InstantMessageHeader object.

Members

Name	Type	Description
clientSideId	string
conversationId	int
formattingStyle	string
fromParticipant	imParticipant
receiverParticipants	imParticipant[]
receiversString	string	Gets the String representation of the addresses of the recipients of this instant message. The String representation starts with opening square brace and ends with a closing square brace. Mutliple addresses are separated by one space character.
type	instantMessageType	Gets the type of this instant message. Valid types are SYSTEM - a message that is not to be routed but represents some control info CHAT - regular instant message FILE_TRANSFER - message as a result of a file transfer operation BROADCAST - message was sent as a broadcast to multiple receivers

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:instantMessageHeader xsi:type="obh:instantMessageHeader" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:clientSideId>your_string_0</obh:clientSideId>
        <obh:conversationId>your_int_0</obh:conversationId>
        <obh:formattingStyle>your_string_0</obh:formattingStyle>
        <obh:fromParticipant>your_imParticipant_0</obh:fromParticipant>
        <obh:receiverParticipants>your_imParticipant_0</obh:receiverParticipants>
        <obh:receiverParticipants>your_imParticipant_1</obh:receiverParticipants>
        <obh:receiverParticipants>your_imParticipant_2</obh:receiverParticipants>
        <obh:receiversString>your_string_0</obh:receiversString>
        <obh:type>your_instantMessageType_0</obh:type>
</obh:instantMessageHeader>

JSON Example

(show inherited members)

{
    "beeType":"instantMessageHeader",
        "clientSideId":"your_{http://www.oracle.com/beehive}clientSideId_as_string0",
        "conversationId":your_{http://www.oracle.com/beehive}conversationId_as_int0,
        "formattingStyle":"your_{http://www.oracle.com/beehive}formattingStyle_as_string0",
        "fromParticipant":{ your_{http://www.oracle.com/beehive}fromParticipant_as_imParticipant0 },
        "receiverParticipants":[
            { your_{http://www.oracle.com/beehive}receiverParticipants_as_imParticipant0 },
            { your_{http://www.oracle.com/beehive}receiverParticipants_as_imParticipant1 },
            { your_{http://www.oracle.com/beehive}receiverParticipants_as_imParticipant2 }
        ],
        "receiversString":"your_{http://www.oracle.com/beehive}receiversString_as_string0",
        "type":{ your_{http://www.oracle.com/beehive}type_as_instantMessageType0 }
}

XML Schema


<xs:complexType name="instantMessageHeader">
    <xs:sequence>
        <xs:element minOccurs="0" name="clientSideId" type="xs:string"/>
        <xs:element name="conversationId" type="xs:int"/>
        <xs:element minOccurs="0" name="formattingStyle" type="xs:string"/>
        <xs:element minOccurs="0" name="fromParticipant" type="tns:imParticipant"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="receiverParticipants" type="tns:imParticipant"/>
        <xs:element minOccurs="0" name="receiversString" type="xs:string"/>
        <xs:element minOccurs="0" name="type" type="tns:instantMessageType"/>
    </xs:sequence>
</xs:complexType>

References

The following data represents the references to instantMessageHeader

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

instantMessage