PushTechnology.ClientInterface.Client.Topics.Details.ITopicSpecification Interface Reference

Represents the specification of a topic. More...

Inherited by PushTechnology.ClientInterface.Client.Topics.Details.TopicSpecification.

Public Member Functions
ITopicSpecification	WithProperty (string key, string value)
	Creates a new specification with the specified property value set. More...
ITopicSpecification	WithProperties (IDictionary< string, string > properties)
	Creates a new specification with the specified properties. More...

Properties
TopicType	Type [get]
	Returns the topic type. More...
IDictionary< string, string >	Properties [get]
	Returns the topic properties as a dictionary. More...

Detailed Description

Represents the specification of a topic.

A topic is specified in terms of its TopicType and a dictionary of optional property settings which can alter the default behavior of the topic.

All possible properties are defined in TopicSpecificationProperty.

Member Function Documentation

ITopicSpecification PushTechnology.ClientInterface.Client.Topics.Details.ITopicSpecification.WithProperties

(

IDictionary< string, string >

properties

)

Creates a new specification with the specified properties.

Parameters

properties

A dictionary of properties.

Returns

A new ITopicSpecification based upon this one but with all properties replaced by those in the given dictionary. Previous property settings will not be copied to the new specification.

Exceptions

ArgumentException

The properties is null or any of the given properties are invalid.

ITopicSpecification PushTechnology.ClientInterface.Client.Topics.Details.ITopicSpecification.WithProperty	(	string	key,
		string	value
	)

Creates a new specification with the specified property value set.

Parameters

key	The property key.
value	The property value.

Returns

A new ITopicSpecification based upon the current but with the specified property set to the specified value. All other property settings will be copied to the new specification.

Exceptions

ArgumentException

The key or value is null or invalid.

Property Documentation

IDictionary<string, string> PushTechnology.ClientInterface.Client.Topics.Details.ITopicSpecification.Properties

get

Returns the topic properties as a dictionary.

This may be empty depending upon the level of detail requested.

TopicType PushTechnology.ClientInterface.Client.Topics.Details.ITopicSpecification.Type

get

Returns the topic type.

---

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

• LegacyModule/Client/Topics/Details/ITopicSpecification.cs