Deleting an Oracle Radio WebSocket Channel

Send a DELETE_CHANNEL message to delete a Radio channel and notify its subscribers.

Permissions and Prerequisites

The following permissions and prerequisites apply to this operation.

Requirement	Value
Authentication	Complete the supported authentication path for the client before sending this operation. See authentication.
Radio permission	Administrator access and `radio.channel.delete`.
Channel access	The named channel must be in the authenticated user's Radio channel scope and must be eligible for deletion.
Session state	The WebSocket connection must be open.

Send the DELETE_CHANNEL message as a JSON text message.

Name	Data type	Required	Default	Constraints	Description
`type`	string	Yes	None	Must be `DELETE_CHANNEL`.	Identifies the channel-delete operation.
`channel`	string	Yes	None	Channel name.	Name of the channel to delete.

{
  "type": "DELETE_CHANNEL",
  "channel": "team-alpha"
}

The following table lists the messages the client can receive and explains their purpose.

Message type	Kind	Description
`CHANNEL_DELETED`	Direct response	Confirms deletion and can report the number of subscribers notified.
`CHANNEL_DELETED`	Asynchronous event	Notifies connected subscribers that the channel was deleted, including who deleted it and a message.
`ERROR`	Denial or error	Indicates insufficient administrator permission, an invalid request, a channel that can't be deleted, or another processing failure.

The following table describes the response properties, their data types, and whether they are required.

Name	Data type	Required	Description
`type`	string	Yes	Response type. The value is `CHANNEL_DELETED`.
`channel`	string	Yes	Deleted channel name.
`deletedBy`	string	Conditional	User that deleted the channel. Present in a subscriber notification.
`subscribersNotified`	integer	Conditional	Number of subscribers notified. Present in the requester response.
`message`	string	Conditional	Deletion message. Present in a subscriber notification.

{
  "type": "CHANNEL_DELETED",
  "channel": "team-alpha",
  "subscribersNotified": 2
}