TsgcWSPClient_Files › Methods › UnSubscribe

UnSubscribe Method

Cancels a previous Subscribe so the client no longer receives messages from the channel.

Syntax

procedure UnSubscribe(const aChannel: String; const aGuid: String = '');

Parameters

Name	Type	Description
aChannel	const String	Name of the channel the client leaves.
aGuid	const String	Optional target subprotocol Guid on the server; leave empty to use the default instance.

Remarks

Sends an unsubscribe request so the server stops forwarding messages for the specified channel. OnUnSubscription fires once the server processes the request.

Example

oProtocol.UnSubscribe('files.incoming');

Back to Methods