The NotificationRegistration represents the registration state of the associated listener on the server. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration:

Public Member Functions
Task< object >	SelectAsync (ITopicSelector selector)
	Requests to receive notifications for all topics matched by the provided topic selector. More...

Task< object >	SelectAsync (ITopicSelector selector, CancellationToken cancellationToken)
	Requests to receive notifications for all topics matched by the provided topic selector. More...

Task< object >	SelectAsync (string selector)
	Requests to receive notifications for all topics matched by the provided selector. More...

Task< object >	SelectAsync (string selector, CancellationToken cancellationToken)
	Requests to receive notifications for all topics matched by the provided selector. More...

Task< object >	DeselectAsync (ITopicSelector selector)
	Requests to stop receiving notifications for all topics matched by the given selector. More...

Task< object >	DeselectAsync (ITopicSelector selector, CancellationToken cancellationToken)
	Requests to stop receiving notifications for all topics matched by the given selector. More...

Task< object >	DeselectAsync (string selector)
	Requests to stop receiving notifications for all topics matched by the given selector. More...

Task< object >	DeselectAsync (string selector, CancellationToken cancellationToken)
	Requests to stop receiving notifications for all topics matched by the given selector. More...

Public Member Functions inherited from PushTechnology.ClientInterface.Client.Callbacks.IRegistration
Task< object >	Close ()
	Requests that the handler is unregistered from the server. More...

Task< object >	CloseAsync ()
	Requests that the handler is unregistered from the server. More...

Detailed Description

The NotificationRegistration represents the registration state of the associated listener on the server.

The NotificationRegistration also provides operations to control which topic paths the listener will receive notifications for.

Added in version 6.1.

Member Function Documentation

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.DeselectAsync ( ITopicSelector selector )

Requests to stop receiving notifications for all topics matched by the given selector.

If the operation completes successfully, the Task result will be null.

Parameters

selector The selector to register.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.DeselectAsync	(	ITopicSelector	selector,
		CancellationToken	cancellationToken
	)

Requests to stop receiving notifications for all topics matched by the given selector.

If the operation completes successfully, the Task result will be null.

This method is the same as calling DeselectAsync(ITopicSelector, CancellationToken) with CancellationToken.None.

Parameters

selector	The selector to register.
cancellationToken	The cancellation token used to cancel the current operation.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: DeselectAsync(ITopicSelector)

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.DeselectAsync ( string selector )

Requests to stop receiving notifications for all topics matched by the given selector.

If the operation completes successfully, the Task result will be null.

This is equivalent to calling DeselectAsync(ITopicSelector) with a selector parsed using ITopicSelectors.Parse(string).

This method is the same as calling DeselectAsync(string, CancellationToken) with CancellationToken.None.

Parameters

selector The selector to register.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: DeselectAsync(ITopicSelector), DeselectAsync(string, CancellationToken)

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.DeselectAsync	(	string	selector,
		CancellationToken	cancellationToken
	)

Requests to stop receiving notifications for all topics matched by the given selector.

If the operation completes successfully, the Task result will be null.

This is equivalent to calling DeselectAsync(ITopicSelector) with a selector parsed using ITopicSelectors.Parse(string).

Parameters

selector	The selector to register.
cancellationToken	The cancellation token used to cancel the current operation.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: DeselectAsync(ITopicSelector, CancellationToken)

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.SelectAsync ( ITopicSelector selector )

Requests to receive notifications for all topics matched by the provided topic selector.

If the operation completes successfully, the Task result will be null.

This method is the same as calling SelectAsync(ITopicSelector, CancellationToken) with CancellationToken.None.

Parameters

selector The selector to register.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: SelectAsync(ITopicSelector, CancellationToken)

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.SelectAsync	(	ITopicSelector	selector,
		CancellationToken	cancellationToken
	)

Requests to receive notifications for all topics matched by the provided topic selector.

If the operation completes successfully, the Task result will be null.

Parameters

selector	The selector to register.
cancellationToken	The cancellation token used to cancel the current operation.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.SelectAsync ( string selector )

Requests to receive notifications for all topics matched by the provided selector.

If the operation completes successfully, the Task result will be null.

This is equivalent to calling SelectAsync(ITopicSelector) with a selector parsed using ITopicSelectors.Parse(string).

This method is the same as calling SelectAsync(string, CancellationToken) with CancellationToken.None.

Parameters

selector The selector to register.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: SelectAsync(ITopicSelector), SelectAsync(string, CancellationToken)

Task<object> PushTechnology.ClientInterface.Client.Features.Control.Topics.INotificationRegistration.SelectAsync	(	string	selector,
		CancellationToken	cancellationToken
	)

Requests to receive notifications for all topics matched by the provided selector.

If the operation completes successfully, the Task result will be null.

This is equivalent to calling SelectAsync(ITopicSelector) with a selector parsed using ITopicSelectors.Parse(string).

Parameters

selector	The selector to register.
cancellationToken	The cancellation token used to cancel the current operation.

Returns: The Task representing the current operation.

Exceptions

Session.SessionSecurityException	The calling session does not have Types.TopicPermission.SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned task.
Session.SessionClosedException	The calling session is closed. Thrown by the returned `Task`.

See Also: SelectAsync(ITopicSelector, CancellationToken)

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

Client.Public/Features/Control/Topics/ITopicNotifications.cs

Public Member Functions

Detailed Description

Member Function Documentation