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

The interface for a topic details builder. More...

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

Public Member Functions
ITopicDetailsBuilder< TD >	SetReference (string reference)
	Sets the initial value of the topic reference. More...
ITopicDetailsBuilder< TD >	SetTidyOnUnsubscribe (bool tidy)
	Sets the 'tidy on unsubscribe' flag. More...
ITopicDetailsBuilder< TD >	SetProperty (string key, string value)
	Sets a topic property. More...
ITopicDetailsBuilder< TD >	Reset ()
	Resets the builder to its initial values. More...
new TD	Build ()
	Build the content. More...

Detailed Description

The interface for a topic details builder.

Template Parameters

TD	The topic details.

Type Constraints

TD

:

ITopicDetails

Member Function Documentation

new TD PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >.Build

(

)

Build the content.

Returns

A valid topic details object.

Implements PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder.

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

(

)

Resets the builder to its initial values.

Returns

This builder.

Implemented in PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.

ITopicDetailsBuilder<TD> PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< 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.

Implemented in PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.

ITopicDetailsBuilder<TD> PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< 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.

Implemented in PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.

ITopicDetailsBuilder<TD> PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< 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.

Implemented in PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >.

---

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

• LegacyModule/Client/Topics/ITopicDetailsBuilder.cs