Skip to main content

@wildix/xbees-conversations-client > DeleteChannelCommand

DeleteChannelCommand class​

Deletes an existing channel. This operation is idempotent, meaning that if the channel does not exist, the operation will still return a successful response.

Signature:

export declare class DeleteChannelCommand extends DeleteChannelCommand_base

Extends: DeleteChannelCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ConversationsClient, DeleteChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, DeleteChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // DeleteChannelInput
  channelId: "STRING_VALUE", // required
};
const command = new DeleteChannelCommand(input);
const response = await client.send(command);
// {};