Specifies the type of an update request. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType:

Public Types
enum	UpdateRequestTypeEnum { UpdateRequestTypeEnum.CONTENT, UpdateRequestTypeEnum.PAGED_RECORD_ORDERED, UpdateRequestTypeEnum.PAGED_STRING_ORDERED, UpdateRequestTypeEnum.PAGED_RECORD_UNORDERED, UpdateRequestTypeEnum.PAGED_STRING_UNORDERED }
	The enumeration representing an update request. More...

Static Public Attributes
static readonly UpdateRequestType	CONTENT = new UpdateRequestType(UpdateRequestTypeEnum.CONTENT, 0)
	Unspecified content that can be used to update a snapshot/delta-type topic. More...

static readonly UpdateRequestType	PAGED_RECORD_ORDERED
	An update to a TopicType.PAGED_RECORD topic that has ordered lines of data. More...

static readonly UpdateRequestType	PAGED_STRING_ORDERED
	An update to a TopicType.PAGED_STRING topic that has ordered lines of data. More...

static readonly UpdateRequestType	PAGED_RECORD_UNORDERED
	An update to a TopicType.PAGED_RECORD topic that has unordered lines of data. More...

static readonly UpdateRequestType	PAGED_STRING_UNORDERED
	An update to a TopicType.PAGED_STRING topic that has unordered lines of data. More...

Detailed Description

Specifies the type of an update request.

Member Enumeration Documentation

enum PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.UpdateRequestTypeEnum

The enumeration representing an update request.

Enumerator
CONTENT	Unspecified content that can be used to update a snapshot/delta-type topic. The effect of such updates at the server will depend upon the topic type as follows: TopicType.Stateful topics. The content must be formatted in a way that is suitable for the topic type and will be applied according to the UpdateAction. For a UpdateAction.MATCH action then the content should be a full representation of the topic state and will be compared with the current state and deltas of change will then be published to all subscribed clients. For a UpdateAction.REFRESH action the whole topic state will be replaced by the supplied content and a snapshot published to all subscribed clients. For a UpdateAction.UPDATE action the content will be treated as a partial update (an input delta) and the state of any missing fields will remain as within the current state. This only applies to some topic types. For a TopicType.SINGLE_VALUE topic this would have the same effect as a match action. TopicType.DELEGATED or TopicType.STATELESS topics. The content will be relayed 'as is' to all clients that are subscribed to the topic. A UpdateAction.MATCH action would be relayed as a snapshot otherwise the content is relayed as a delta. Other topic types (i.e. TopicType.Functional topics. An update should not be applied to such topic types and an attempt to do so will result in an update error.
PAGED_RECORD_ORDERED	An update to a TopicType.PAGED_RECORD topic that has ordered lines of data. If an attempt is made to apply such an update to any other type of topic then an update error would occur.
PAGED_STRING_ORDERED	An update to a TopicType.PAGED_STRING topic that has ordered lines of data. If an attempt is made to apply such an update to any other type of topic then an update error would occur.
PAGED_RECORD_UNORDERED	An update to a TopicType.PAGED_RECORD topic that has unordered lines of data. If an attempt is made to apply such an update to any other type of topic then an update error would occur.
PAGED_STRING_UNORDERED	An update to a TopicType.PAGED_STRING topic that has unordered lines of data. If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Member Data Documentation

readonly UpdateRequestType PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.CONTENT = new UpdateRequestType(UpdateRequestTypeEnum.CONTENT, 0)

static

Unspecified content that can be used to update a snapshot/delta-type topic.

The effect of such updates at the server will depend upon the topic type as follows:

TopicType.Stateful topics.

The content must be formatted in a way that is suitable for the topic type and will be applied according to the UpdateAction.

For a UpdateAction.MATCH action then the content should be a full representation of the topic state and will be compared with the current state and deltas of change will then be published to all subscribed clients.

For a UpdateAction.REFRESH action the whole topic state will be replaced by the supplied content and a snapshot published to all subscribed clients.

For a UpdateAction.UPDATE action the content will be treated as a partial update (an input delta) and the state of any missing fields will remain as within the current state. This only applies to some topic types. For a TopicType.SINGLE_VALUE topic this would have the same effect as a match action.

TopicType.STATELESS topics.

The content will be relayed 'as is' to all clients that are subscribed to the topic. A UpdateAction.MATCH action would be relayed as a snapshot otherwise the content is relayed as a delta.

Other topic types (i.e. TopicType.Functional topics.

An update should not be applied to such topic types and an attempt to do so will result in an update error.

readonly UpdateRequestType PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.PAGED_RECORD_ORDERED

static

Initial value:

=

new UpdateRequestType(UpdateRequestTypeEnum.PAGED_RECORD_ORDERED, 1)

An update to a TopicType.PAGED_RECORD topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

readonly UpdateRequestType PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.PAGED_RECORD_UNORDERED

static

Initial value:

=

new UpdateRequestType(UpdateRequestTypeEnum.PAGED_RECORD_UNORDERED, 3)

An update to a TopicType.PAGED_RECORD topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

readonly UpdateRequestType PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.PAGED_STRING_ORDERED

static

Initial value:

=

new UpdateRequestType(UpdateRequestTypeEnum.PAGED_STRING_ORDERED, 2)

An update to a TopicType.PAGED_STRING topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

readonly UpdateRequestType PushTechnology.ClientInterface.Client.Content.Update.UpdateRequestType.PAGED_STRING_UNORDERED

static

Initial value:

=

new UpdateRequestType(UpdateRequestTypeEnum.PAGED_STRING_UNORDERED, 4)

An update to a TopicType.PAGED_STRING topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

The documentation for this class was generated from the following file:

UCIStack/Client/Content/Update/UpdateRequestType.cs

Public Types

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Member Data Documentation