Interface ITopicSpecification

Represents the specification of a topic.

Namespace: PushTechnology.ClientInterface.Client.Topics.Details

Assembly: Diffusion.Client.dll

Syntax

public interface ITopicSpecification

Remarks

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.

Properties

Properties

Returns the topic properties as a dictionary.

Declaration

IReadOnlyDictionary<string, string> Properties { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, String>	The topic properties as a dictionary.

Remarks

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

Type

Returns the topic type.

Declaration

TopicType Type { get; }

Property Value

Type	Description
TopicType	The topic type.

Methods

WithProperties(IDictionary<String, String>)

Creates a new specification with the specified properties.

Declaration

ITopicSpecification WithProperties(IDictionary<string, string> properties)

Parameters

Type	Name	Description
IDictionary<String, String>	properties	A dictionary of properties.

Returns

Type	Description
ITopicSpecification	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.

WithProperty(String, String)

Creates a new specification with the specified property value set.

Declaration

ITopicSpecification WithProperty(string key, string value)

Parameters

Type	Name	Description
String	key	The property key.
String	value	The property value.

Returns

Type	Description
ITopicSpecification	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.