Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Topics.IRecordTopicDetailsBuilder Interface Reference

Builder for Record topic details. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IRecordTopicDetailsBuilder:
PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder

Public Member Functions

IRecordTopicDetailsBuilder Metadata (IMContent metadata)
 Sets the content metadata to be used for the topic. More...
 
IRecordTopicDetailsBuilder EmptyFieldValue (string emptyValue)
 Sets the value to be used to represent empty fields in delta content generated by the topic. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >
new TB SetReference (string reference)
 Sets the initial value of the topic reference. More...
 
new TB SetTidyOnUnsubscribe (bool tidy)
 Sets the 'tidy on unsubscribe' flag. More...
 
new TB SetProperty (string key, string value)
 Sets a topic property. More...
 
new TB Reset ()
 Resets the builder to its initial values. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >
new TD Build ()
 Build the content. More...
 

Detailed Description

Builder for Record topic details.

Member Function Documentation

IRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IRecordTopicDetailsBuilder.EmptyFieldValue ( string  emptyValue)

Sets the value to be used to represent empty fields in delta content generated by the topic.

This allows it to be possible for a client receiving a delta to distinguish between a field that had not changed and a field that has changed to become empty.

This will be used in generated deltas.

If not set then empty fields will be rendered as zero length Strings and thus be indistinguishable from unchanged fields.

Parameters
emptyValuethe empty value which can be any String, ideally a single character. The value should be a value that would not occur normally in a field, thus a non visible character is ideal. It is recommended that Constants.EMPTY_FIELD_STRING is used as it is a special character that is rendered when messages are displayed. The value may not contain reserved character values (so avoid 0x00 to 0x09). The value may not be null
Returns
this builder
IRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IRecordTopicDetailsBuilder.Metadata ( IMContent  metadata)

Sets the content metadata to be used for the topic.

If no metadata is explicitly supplied then a default is assumed.

Parameters
metadatathe content metadata
Returns
this builder

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