deleteVirtualSocket

const deleteVirtualSocket: any = addon.deleteVirtualSocket

Defined in: index.cts:544

Deletes a virtual socket and unsubscribes it from all channels. This is a convenient way to bulk-unsubscribe a virtual socket from all its channels at once.

Param

virtualSocketId

The unique identifier of the virtual socket to delete.

Param

expectedTargetSocketId

Optional. If provided, the virtual socket will only be deleted if it points to this specific target socket ID. This can help prevent unauthorized unsubscribes.

Returns

true if the virtual socket was deleted, false if it was not found or target didn’t match.