Delete channels
Remove a channel permanently with delete() or deleteChannel().
Both methods produce the same result. Call delete() on a Channel object or deleteChannel() on the Chat object with the channel ID.
Requires App Context
Enable App Context for your keyset in the Admin Portal.
Method signature
These methods take the following parameters:
-
delete()(on theChannelobject)1channel.delete() async throws -
deleteChannel()(on theChatobject)1chat.deleteChannel(
2 id: String
3) async throws
Input
| Parameter | Required in delete() | Required in deleteChannel() | Description |
|---|---|---|---|
idType: StringDefault: n/a | No | Yes | Unique channel identifier. |