PresenceCategoryWithMetaData Class

Definition

PresenceCategoryWithMetaData class represents a Rich Presence Category data and contains certain meta data information in addition to the category data.

public ref class PresenceCategoryWithMetaData
public class PresenceCategoryWithMetaData
type PresenceCategoryWithMetaData = class
Public Class PresenceCategoryWithMetaData
Inheritance
PresenceCategoryWithMetaData

Remarks

Category data represents the actual presence category data published along with other attributes. The attributes such as instanceId, version, container and expireType, will always be populated (unless the category is deleted where only the value of the ContainerId property will be populated) when it is the presence of the endpoint owners. When an object of this class is received while subscribing to other people's presence, only category data and container ID will have valid information.

Name, ContainerIdand InstanceId forms a key that must be unique within a publication service request. Otherwise the server responds with a duplicate publication error.

All the attributes are settable, except Version, which is supplied internally by UCMA. When a category is successfully published, the server updates its cached category version number of the category at its end and informs all the endpoints if they have subscribed to receive notifications.

Constructors

PresenceCategoryWithMetaData(Int64, Int32, PresenceCategory)

Creates a new instance of the PresenceCategoryWithMetaData class.

PresenceCategoryWithMetaData(String, Int64, Int32)

Creates a new instance of the PresenceCategoryWithMetaData class with empty data.

Fields

UnknownContainer

Constant for unknown container

UnknownExpires

Constant for unknown expiry time

Properties

Category

Gets or sets the actual presence category data.

ContainerId

Gets the container ID of the container wherein the category is published.

Expires

Gets or sets the expiration time for the category.

ExpiryPolicy

Gets or sets expiration type for the category. The default expiration type is "endpoint".

ExtensionXml

Gets or sets the extension category xml set by derived classes.

InstanceId

Gets the instance ID of the category item.

Name

Gets the name of the category.

PublishTime

Gets the time of publication for the Category item.

Version

Gets the version number of the category item.

Methods

CreateInnerDataXml()

Creates an XML string that represents the presence category data.

ParseInnerDataXml(XmlReader)

Parses XML into an instance that represents the presence category.

Applies to