PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD > Interface Template Reference

Topic details builder. More...

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

Public Member Functions
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

Topic details builder.

This is the base builder interface defining the setting of attributes that are common to all topic types. This will be extended for topic types that have additional attributes and/or metadata.

Template Parameters

TB	The builder type.
TD

Type Constraints

TB	:	ITopicDetailsBuilder<TD>
TD	:	ITopicDetails

Member Function Documentation

new TB PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.Reset

(

)

Resets the builder to its initial values.

Returns

This builder.

Implements PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >.

new TB PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.SetProperty	(	string	key,
		string	value
	)

Sets a topic property.

This is used for setting restricted or legacy topic properties.

Parameters

key	The property key. The values for these keys and permitted values are published in the user documentation.
value	The property value.

Returns

This builder.

Implements PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >.

new TB PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.SetReference

(

string

reference

)

Sets the initial value of the topic reference.

If not explicitly supplied then there will be no topic reference.

Parameters

reference

The reference.

Returns

This builder.

Implements PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >.

new TB PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.SetTidyOnUnsubscribe

(

bool

tidy

)

Sets the 'tidy on unsubscribe' flag.

Parameters

tidy	true to set tidy on unsubscribe. The default is false.

Returns

This builder.

Implements PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >.

---

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

• LegacyModule/Client/Topics/ITopicDetailsBuilder.cs