Class ButtonV2

constructor

• new ButtonV2(client: any): ButtonV2

  Parameters

  • client: any

  Returns ButtonV2

StaticMAX_BUTTONS

addButton

• addButton(displayText?: string, buttonId?: string): this

  Add a simple quick-reply button. buttonId defaults to a random uuid.

  Parameters

  • OptionaldisplayText: string
  • OptionalbuttonId: string

  Returns this

addRawButton

• addRawButton(obj: Record<string, any>): this

  Push a raw pre-built button object.

  Parameters

  • obj: Record<string, any>

  Returns this

assertValid

• assertValid(): this

  Returns this

build

• build(jid: string, options?: ButtonV2BuildOptions): Promise<any>

  Build the WAMessage without sending.

  Parameters

  • jid: string
  • Optionaloptions: ButtonV2BuildOptions

  Returns Promise<any>

button

• button(displayText?: string, buttonId?: string): this

  Alias for addButton().

  Parameters

  • OptionaldisplayText: string
  • OptionalbuttonId: string

  Returns this

clearButtons

• clearButtons(): this

  Returns this

countButtons

• countButtons(): number

  Returns number

getButtons

• getButtons(): Record<string, any>[]

  Returns Record<string, any>[]

row

• row(cb: (row: RowBuilder) => void): this

  Group buttons via a RowBuilder callback.

  Parameters

  • cb: (row: RowBuilder) => void

  Returns this

send

• send(
      jid: string,
      options?: Record<string, any> & { validate?: boolean },
  ): Promise<any>

  Build and send. Validates by default; pass { validate:false } for low-level experiments.

  Parameters

  • jid: string
  • Optionaloptions: Record<string, any> & { validate?: boolean }

  Returns Promise<any>

setMedia

• setMedia(obj: Record<string, any>): this

  Raw pre-built header media object.

  Parameters

  • obj: Record<string, any>

  Returns this

setThumbnail

• setThumbnail(path: string | Buffer<ArrayBufferLike>): this

  Header thumbnail (fallback location-header image).

  Parameters

  • path: string | Buffer<ArrayBufferLike>

  Returns this

validate

• validate(): ButtonV2ValidationResult

  Pre-flight validation for legacy buttonsMessage.

  Returns ButtonV2ValidationResult