The reference to a registered handler. More...

Public Member Functions
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 reference to a registered handler.

Such a handler reference is provided whenever a handler with a server side presence is registered.

Added in version 5.0.

Member Function Documentation

Task<object> PushTechnology.ClientInterface.Client.Features.IRegisteredHandler.Close ( )

Requests that the handler is unregistered from the server.

After the handler is unregistered, the handler's

OnClose

method will be called. If the handler has already been unregistered, calling this method has no effect.

If the returned task completes successfully, the task result will be

null

. The result type is

object

to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

This method has been deprecated in version 6.1. Use CloseAsync instead.

Exceptions

Session.SessionClosedException The session is closed. Thrown by the returned task.

Task<object> PushTechnology.ClientInterface.Client.Features.IRegisteredHandler.CloseAsync ( )

Requests that the handler is unregistered from the server.

After the handler is unregistered, the handler's

OnClose

method will be called. If the handler has already been unregistered, calling this method has no effect.

If the returned Task completes successfully, the result will be

null

.

Added in version 6.1

Exceptions

Session.SessionClosedException The session is closed. Thrown by the returned Task.

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