PushTechnology.ClientInterface.Client.Features.ITopicNotifications Interface Reference

Service allowing a client to receive topic notifications. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.ITopicNotifications:

Public Member Functions
ITopicNotifications	SetDetailRequired (TopicNotificationAddLevel addLevel, bool notifyRemoval, bool notifyUpdate)
	This is used to set the notification details required. More...
ITopicNotifications	Select (TopicNotificationSelectionMode mode, TopicSpecifierType topics)
	Sends a request to the server to update the selection of topics that notifications will be received for. More...

Properties
TopicNotificationAddLevel	NotificationLevel [get]
	Returns the current add notification level. More...
bool	IsNotifyingRemoval [get]
	Indicates whether notifying topic removals. More...
bool	IsNotifyingUpdate [get]
	Indicates whether notifying topic property updates. More...
Properties inherited from PushTechnology.ClientInterface.Client.Features.IFeature
ISession	Session [get]
	Get the session that the service is associated with. More...

Detailed Description

Service allowing a client to receive topic notifications.

A client can receive notifications of topics added, removed or updated (certain properties only).

The required notification detail should be specified using SetDetailRequired( IAddLevel, bool, bool ).

After setting the notification detail required, the range of topics that require notifications should be specified. This is done using the Select( ISelectionMode, ITopicSet ) method which may be used to add, replace, remove or clear selections.

Member Function Documentation

ITopicNotifications PushTechnology.ClientInterface.Client.Features.ITopicNotifications.Select	(	TopicNotificationSelectionMode	mode,
		TopicSpecifierType	topics
	)

Sends a request to the server to update the selection of topics that notifications will be received for.

As this is an asynchronous request to the serve

Parameters

mode
topics

Returns

ITopicNotifications PushTechnology.ClientInterface.Client.Features.ITopicNotifications.SetDetailRequired	(	TopicNotificationAddLevel	addLevel,
		bool	notifyRemoval,
		bool	notifyUpdate
	)

This is used to set the notification details required.

If this is not called then no notifications will be received.

This will send a request to the server to change the level of details.

Parameters

addLevel	The required notification level for add notifications.
notifyRemoval	true to request notifications of topic removals.
notifyUpdate

Returns

Property Documentation

bool PushTechnology.ClientInterface.Client.Features.ITopicNotifications.IsNotifyingRemoval

get

Indicates whether notifying topic removals.

bool PushTechnology.ClientInterface.Client.Features.ITopicNotifications.IsNotifyingUpdate

get

Indicates whether notifying topic property updates.

TopicNotificationAddLevel PushTechnology.ClientInterface.Client.Features.ITopicNotifications.NotificationLevel

get

Returns the current add notification level.

---

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

• UCIStack/Client/Features/ITopicNotifications.cs