rawCategory Element
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Contains a user-defined data category as an XML tree. The namespace attribute must be included.
Syntax
<rawCategory>
<myCustomElement namespace="HTTP://WWW.myDomain/2006/XHTML">
...
</myCustomElement>
</rawCategory>
Attributes
Attribute |
Data Type |
Description |
---|---|---|
Name |
string |
The name of the category. This is a required attribute. |
nameSpace |
string |
The namespace where the validating schema of the XML tree can be found. This is a required attribute. |
instanceMask |
integer |
The unique instance id for the category. This is a required attribute. |
Version |
integer |
The version of the category. This is a required attribute. |
Container |
string |
The ACL container from which this category is coming. This is a required attribute. |
publishTime |
datetime |
The time when this category was last published. This is a required attribute. |
endpointId |
integer |
The id of the endpoint from which this category originated. This is a required attribute. |
expireType |
string |
The type of expiry. Can be static, user, endpoint, or time. This is a required attribute. |
Expires |
datetime |
The duration for which this category data is valid. |
Element Information
Parent Element
Element |
Description |
---|---|
Envelope for receiving the contact presence categories. |
|
Publishes a set of user-defined categories. |
|
Envelope for receiving the logged-on user presence data. |
|
Envelope for receiving presence data of a contact. |
Child Elements
Element |
Occurrences |
Description |
---|---|---|
1 or more |
User defined element. Any element from the namespace specified in the namespace attribute is acceptable. The namespace must not be the namespace of the Unified Communications schema. |
Remarks
This element is used for custom categories defined by the independent software vendor. The child element any must include a namespace, which should specify the URL where the category defining schema is located.
The expireType attribute determines the way the Communicator Web Access server expires category instances. The following list represents the valid expireType values:
static: The category persists on the server until it is removed. Categories are removed when published with an expires attribute value of 0.
user: The category persists on the server as long as the user has one endpoint logged on.
endpoint: The category persists on the server as long as the endpoint that publishes the category remains logged on.
time: The category persists for the number of seconds as specified in the expires attribute.
The Version attribute of the element is the version number assigned to the instance of the category assigned by the Communicator Web Access server. After successfully publishing a category, the server sends an asynchronous response notifying the client of the new category version number. The new version number must be supplied in a subsequent publishing request for the category instance.
Examples
<rawCategory name="gpsLocation" instanceMask="0" version="4"
container="400" expireType="static">
<gpsLocation xmlns="..." attr="...">
<...>
</gpsLocation>
</rawCategory>