Builder for Google Protocol Buffer topic details More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IProtocolBufferTopicDetailsBuilder:

Public Member Functions
IProtocolBufferTopicDetailsBuilder	MessageDetails (string protoClass, string messageName)
	Sets the Protocol Buffers message details. More...

IProtocolBufferTopicDetailsBuilder	UpdateMode (ProtocolBufferTopicUpdateMode updateMode)
	Sets the update mode. More...

IProtocolBufferTopicDetailsBuilder	DeletionValue (string value)
	Allows a deletion value to be specified for use with 'string' type optional fields. 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 Google Protocol Buffer topic details

Member Function Documentation

IProtocolBufferTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IProtocolBufferTopicDetailsBuilder.DeletionValue ( string value )

Allows a deletion value to be specified for use with 'string' type optional fields.

The purpose of this value is to allow a value which will be interpreted as meaning that an optional field has been removed.

When operating in full mode then when input messages do not have values for optional string fields and the current topic state does then it is assumed that the field is being removed and notification of this removal will be passed to the client by sending the field with this value.

When operating in UpdateMode#PARTIAL partial mode then is possible to use the deletion value to indicate the removal of a field in the update message and then field removal will be notified to the clients using the same value.

If no value is explicitly specified then the string "<del>" is assumed.

Parameters

value the deletion value which may be one or more characters which the client can interpret as meaning that an optional field has been removed

Returns: this builder

IProtocolBufferTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IProtocolBufferTopicDetailsBuilder.MessageDetails	(	string	protoClass,
		string	messageName
	)

Sets the Protocol Buffers message details.

Parameters

protoClass	the full name of the outer class containing the required message definition. This class must exist at the server. Such a class will have been generated from a `.proto` file using the `protoc` compiler
messageName	the name of the message within the specified class that defines the topic content

Returns: This builder

IProtocolBufferTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IProtocolBufferTopicDetailsBuilder.UpdateMode ( ProtocolBufferTopicUpdateMode updateMode )

Sets the update mode.

If the mode is not explicitly set then see partial is assumed.

Parameters

updateMode the update mode

Returns: this builder

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

UCIStack/Client/Topics/IProtocolBufferTopicDetailsBuilder.cs

Public Member Functions

Detailed Description

Member Function Documentation