Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
Public Member Functions | List of all members
PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetails Interface Reference

Details of a service topic. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetails:
PushTechnology.ClientInterface.Client.Topics.ITopicDetails

Public Member Functions

IServiceTopicDetailsBuilder CreateBuilder ()
 Returns a new builder initialised with the values from these details. More...
 

Additional Inherited Members

- Properties inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetails
TopicDetailsLevel Level [get]
 Returns the level of detail available. More...
 
TopicType Type [get]
 Returns the topic type. More...
 
ITopicDetailsSchema Schema [get]
 Returns the topic schema. More...
 
ITopicDetailsAttributes Attributes [get]
 Returns the topic attributes. More...
 

Detailed Description

Details of a service topic.

This type of topic provides the mechanism for routing and executing user-written request/response services. Such services are invoked by clients using the 'Services' feature.

each service request comprises a 'request type', context and optional user header values and/or content.

The service request can be handled server-side by a nominated user-written class that is available at the server. If a server-side class is used, it must implement the com.pushtechnology.diffusion.api.data.service.ServiceHandler interface defined by the Classic API.

At this release of the Unified API, though such topics can be created there is no feature within the client to invoke such services and none within the client to action requests to services. However, topics may be created providing they have a server-side handler class and they are only to be used by users of the Classic API.

To create an instance of such details use a builder obtained from the ITopicControl feature as follows:

var control = session.GetTopicControlFeature(); var builder = control.CreateDetailsBuilder<IServiceTopicDetailsBuilder>();

The minimum that must be provided to the builder is the name of the handler.

Member Function Documentation

IServiceTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetails.CreateBuilder ( )

Returns a new builder initialised with the values from these details.

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