Class: TopicNotificationRegistration

TopicNotificationRegistration

new TopicNotificationRegistration()

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

The TopicNotificationRegistration provides operations to control which topic paths the listener will receive notifications for. It can also close the listener and remove it from the server.

Methods

close()

Request that the listener is unregistered from the server.

deselect(topicSelector) → {Result.<undefined>}

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

This function can take any number of arguments. Each argument can be a string or a TopicSelector. Alternatively, an array of strings and TopicSelectors can be passed as a single argument.

Parameters:
Name Type Description
topicSelector String | TopicSelector | Array.<String> the selector to register
Returns:
A Result.<undefined> for this operation
Type
Result.<undefined>

select(topicSelector) → {Result.<undefined>}

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

This function can take any number of arguments. Each argument can be a string or a TopicSelector. Alternatively, an array of strings and TopicSelectors can be passed as a single argument.

Parameters:
Name Type Description
topicSelector String | TopicSelector | Array.<String> the selector to register
Returns:
A Result.<undefined> for this operation
Type
Result.<undefined>