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. |
Output
This method doesn't return any value.
Sample code
Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
Permanently delete the support channel metadata.
delete()
1