Skip to main content

@wildix/xbees-conversations-client > DeleteChannelMemberCommand

DeleteChannelMemberCommand class​

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

Signature:

export declare class DeleteChannelMemberCommand extends DeleteChannelMemberCommand_base

Extends: DeleteChannelMemberCommand_base

Example​

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

import { ConversationsClient, DeleteChannelMemberCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, DeleteChannelMemberCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // DeleteChannelMemberInput
  channelId: "STRING_VALUE", // required
  userId: "STRING_VALUE",
  memberId: "STRING_VALUE", // required
  silent: true || false,
};
const command = new DeleteChannelMemberCommand(input);
const response = await client.send(command);
// {};