Class AttachmentBuilder

constructor

• new AttachmentBuilder(
      attachment: BufferResolvable,
      data: AttachmentData,
  ): AttachmentBuilder

  Parameters

  • attachment: BufferResolvable

    The file

  • data: AttachmentData

    Extra data

  Returns AttachmentBuilder

attachment

Optionaldescription

Optionalduration

name

Optionaltitle

Optionalwaveform

spoiler

• get spoiler(): boolean

  Whether or not this attachment has been marked as a spoiler

  Returns boolean

fromURL

• fromURL(
      url: string,
      data: Partial<AttachmentData>,
      requestOptions: any,
  ): Promise<AttachmentBuilder>

  Create an attachment from url

  Parameters

  • url: string
  • data: Partial<AttachmentData>
  • requestOptions: any

  Returns Promise<AttachmentBuilder>

setDescription

• setDescription(description: string): AttachmentBuilder

  Sets the description of this attachment.

  Parameters

  • description: string

    The description of the file

  Returns AttachmentBuilder

  This attachment

setDuration

• setDuration(duration: number): AttachmentBuilder

  Sets the duration of this attachment.

  Parameters

  • duration: number

    The duration of the attachment in seconds

  Returns AttachmentBuilder

  This attachment

  Remarks

  This is only for voice message attachments.

setFile

• setFile(attachment: BufferResolvable): AttachmentBuilder

  Sets the file of this attachment.

  Parameters

  • attachment: BufferResolvable

    The file

  Returns AttachmentBuilder

  This attachment

setName

• setName(name: string): AttachmentBuilder

  Sets the name of this attachment.

  Parameters

  • name: string

    The name of the file

  Returns AttachmentBuilder

  This attachment

setSpoiler

• setSpoiler(spoiler?: boolean): AttachmentBuilder

  Sets whether this attachment is a spoiler

  Parameters

  • spoiler: boolean = true

    Whether the attachment should be marked as a spoiler

  Returns AttachmentBuilder

  This attachment

setTitle

• setTitle(title: string): AttachmentBuilder

  Sets the title of this attachment.

  Parameters

  • title: string

    The title of the file

  Returns AttachmentBuilder

  This attachment

setWaveform

• setWaveform(waveform: string): AttachmentBuilder

  Sets the waveform of this attachment.

  Parameters

  • waveform: string

    The base64 encoded byte array representing a sampled waveform

  Returns AttachmentBuilder

  This attachment

  Remarks

  This is only for voice message attachments.

toJSON

• toJSON(): any

  Returns any