Class Carousel

constructor

• new Carousel(client: any): Carousel

  Parameters

  • client: any

  Returns Carousel

StaticMAX_CARDS

addCard

• addCard(card: CarouselCard | CarouselCard[]): this

  Add one card, or an array of cards. Media, text-only, and button-only cards are accepted.

  Parameters

  • card: CarouselCard | CarouselCard[]

  Returns this

addCards

• addCards(...cards: CarouselCard[]): this

  Add several prebuilt cards in one fluent call.

  Parameters

  • ...cards: CarouselCard[]

  Returns this

addTextCard

• addTextCard(card?: CarouselTextCardOptions): this

  Add a text/button-only card without manually constructing the proto-shaped card.

  Parameters

  • Optionalcard: CarouselTextCardOptions

  Returns this

assertValid

• assertValid(): this

  Returns this

build

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

  Build the WAMessage without sending. Pass { validate: true } to run assertValid() first.

  Parameters

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

  Returns any

clearCards

• clearCards(): this

  Returns this

countCards

• countCards(): number

  Returns number

getCards

• getCards(): CarouselCard[]

  Returns CarouselCard[]

send

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

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

  Parameters

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

  Returns Promise<any>

setCarouselOptions

• setCarouselOptions(options?: CarouselOptions): this

  Configure carousel-level proto metadata. Defaults: { carouselCardType: UNKNOWN, messageVersion: 1 }.

  Parameters

  • Optionaloptions: CarouselOptions

  Returns this

validate

• validate(): CarouselValidationResult

  Returns CarouselValidationResult

StaticassessCard

• assessCard(card: CarouselCard): CarouselAssessResult

  Parameters

  • card: CarouselCard

  Returns CarouselAssessResult

StaticisValidCard

• isValidCard(card: CarouselCard): boolean

  Parameters

  • card: CarouselCard

  Returns boolean