Class ButtonV3

constructor

• new ButtonV3(client: any): ButtonV3

  Parameters

  • client: any

  Returns ButtonV3

StaticMAX_BUTTONS

addButton

• addButton(hydratedButton: Record<string, any>): this

  Max 3 buttons — throws past the limit.

  Parameters

  • hydratedButton: Record<string, any>

  Returns this

addCall

• addCall(display_text: string, phone_number: string): this

  Parameters

  • display_text: string
  • phone_number: string

  Returns this

addReply

• addReply(display_text: string, id: string): this

  Parameters

  • display_text: string
  • id: string

  Returns this

addUrl

• addUrl(display_text: string, url: string, options?: Record<string, any>): this

  Parameters

  • display_text: string
  • url: string
  • Optionaloptions: Record<string, any>

  Returns this

assertValid

• assertValid(): this

  Returns this

build

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

  Parameters

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

  Returns Promise<Record<string, any>>

clearButtons

• clearButtons(): this

  Returns this

countButtons

• countButtons(): number

  Returns number

getButtons

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

  Returns Record<string, any>[]

loadFrom

• loadFrom(msg: Record<string, any>): this

  Load an existing templateMessage (e.g. from a fetched/quoted message) for editing.

  Parameters

  • msg: Record<string, any>

  Returns this

send

• send(
      jid: string,
      options?: Record<string, any> & {
          additionalNodes?: 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> & { additionalNodes?: any[]; validate?: boolean }

  Returns Promise<any>

setDocument

• setDocument(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

setImage

• setImage(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

setMedia

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

  Parameters

  • obj: Record<string, any>

  Returns this

setVideo

• setVideo(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

toTemplate

• toTemplate(): Promise<Record<string, any>>

  Returns Promise<Record<string, any>>

validate

• validate(): ButtonV3ValidationResult

  Returns ButtonV3ValidationResult