Class Attachment

Represents an attachment, such as a file or image, in a message or channel.

Hierarchy (View Summary)

Base
- Attachment

Index

Constructors

constructor

new Attachment(
    client: client,
    data: {
        _id: string;
        content_type: string;
        deleted?: boolean | null;
        filename: string;
        message_id?: string | null;
        metadata:
            | { type: "File" }
            | { type: "Text" }
            | { height: number; type: "Image"; width: number }
            | { height: number; type: "Video"; width: number }
            | { type: "Audio" };
        object_id?: string | null;
        reported?: boolean | null;
        server_id?: string | null;
        size: number;
        tag: string;
        user_id?: string | null;
    },
): Attachment
Creates a new Attachment instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: string;
      content_type: string;
      deleted?: boolean | null;
      filename: string;
      message_id?: string | null;
      metadata:
          | { type: "File" }
          | { type: "Text" }
          | { height: number; type: "Image"; width: number }
          | { height: number; type: "Video"; width: number }
          | { type: "Audio" };
      object_id?: string | null;
      reported?: boolean | null;
      server_id?: string | null;
      size: number;
      tag: string;
      user_id?: string | null;
  }
  The raw data for the attachment from the API.
  - _id: string
    Description
    Unique Id
  - content_type: string
    Description
    Raw content type of this file
  - Optionaldeleted?: boolean | null
    Description
    Whether this file was deleted
  - filename: string
    Description
    Original filename
  - Optionalmessage_id?: string | null
  - metadata:
        | { type: "File" }
        | { type: "Text" }
        | { height: number; type: "Image"; width: number }
        | { height: number; type: "Video"; width: number }
        | { type: "Audio" }
    Description
    Parsed metadata of this file
  - Optionalobject_id?: string | null
    Description
    Id of the object this file is associated with
  - Optionalreported?: boolean | null
    Description
    Whether this file was reported
  - Optionalserver_id?: string | null
  - size: number
    Format: int
    
    Description
    Size of this file (in bytes)
  - tag: string
    Description
    Tag / bucket this file was uploaded to
  - Optionaluser_id?: string | null
Returns Attachment
Overrides Base.constructor
- Defined in work/stoatbot.js/stoatbot.js/src/struct/attachment.ts:29

Properties

`Readonly`client

client: client

The client instance.

filename

filename: string

The filename of the attachment.

id

id: string

The unique identifier for the object.

metadata

metadata:
    | { type: "File" }
    | { type: "Text" }
    | { height: number; type: "Image"; width: number }
    | { height: number; type: "Video"; width: number }
    | { type: "Audio" }

Metadata associated with the attachment (e.g., dimensions for images).

Type Declaration

{ type: "File" }
{ type: "Text" }
{ height: number; type: "Image"; width: number }
- height: number
  Format: uint
- type: "Image"
- width: number
  Format: uint
{ height: number; type: "Video"; width: number }
- height: number
  Format: uint
- type: "Video"
- width: number
  Format: uint
{ type: "Audio" }

size

size: number

The size of the attachment in bytes.

type

type: string

The MIME type of the attachment (e.g., image/png, application/pdf).

Methods

_clone

_clone(): this
Creates a deep clone of the object.

Returns this
A clone of the object.
Inherited from Base._clone
- Defined in work/stoatbot.js/stoatbot.js/src/struct/base.ts:84

_update

_update(data: PartialObject, clear?: string[]): this
Updates the object with new data and returns a clone of the object.
Parameters
- data: PartialObject
  The data to update the object with.
- Optionalclear: string[]
  Fields to clear in the object.
Returns this
A clone of the updated object.
Inherited from Base._update
- Defined in work/stoatbot.js/stoatbot.js/src/struct/base.ts:56

equals

equals(obj?: Attachment | null): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: Attachment | null
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from Base.equals
- Defined in work/stoatbot.js/stoatbot.js/src/struct/base.ts:29

Class Attachment

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_id: string

Description

content_type: string

Description

Optionaldeleted?: boolean | null

Description

filename: string

Description

Optionalmessage_id?: string | null

metadata: | { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }

Description

Optionalobject_id?: string | null

Description

Optionalreported?: boolean | null

Description

Optionalserver_id?: string | null

size: number

Description

tag: string

Description

Optionaluser_id?: string | null

Returns Attachment

Properties

Readonlyclient

filename

id

metadata

Type Declaration

height: number

type: "Image"

width: number

height: number

type: "Video"

width: number

size

type

Methods

_clone

Returns this

_update

Parameters

Returns this

equals

Parameters

Returns boolean

Settings

On This Page

`Optional`deleted?: boolean | null

`Optional`message_id?: string | null

metadata:
| { type: "File" }
| { type: "Text" }
| { height: number; type: "Image"; width: number }
| { height: number; type: "Video"; width: number }
| { type: "Audio" }

`Optional`object_id?: string | null

`Optional`reported?: boolean | null

`Optional`server_id?: string | null

`Optional`user_id?: string | null

`Readonly`client