Class Attachment

Hierarchy

BaseObject<File>
- Attachment

Index

Constructors

constructor

new Attachment(client: Client, data: {
    _id: string;
    content_type: string;
    deleted?: boolean;
    filename: string;
    message_id?: string;
    metadata: {
        type: "File";
    } | {
        type: "Text";
    } | {
        height: number;
        type: "Image";
        width: number;
    } | {
        height: number;
        type: "Video";
        width: number;
    } | {
        type: "Audio";
    };
    object_id?: string;
    reported?: boolean;
    server_id?: string;
    size: number;
    tag: string;
    user_id?: string;
}): Attachment
Parameters
- client: Client
- data: {
      _id: string;
      content_type: string;
      deleted?: boolean;
      filename: string;
      message_id?: string;
      metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      };
      object_id?: string;
      reported?: boolean;
      server_id?: string;
      size: number;
      tag: string;
      user_id?: string;
  }
  - _id: string
    
    Description
    Unique Id
  - content_type: string
    
    Description
    Raw content type of this file
  - Optional deleted?: boolean
    
    Description
    Whether this file was deleted
  - filename: string
    
    Description
    Original filename
  - Optional message_id?: string
  - 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
  - Optional object_id?: string
    
    Description
    Id of the object this file is associated with
  - Optional reported?: boolean
    
    Description
    Whether this file was reported
  - Optional server_id?: string
  - size: number
    
    Format: int
    
    Description
    Size of this file (in bytes)
  - tag: string
    
    Description
    Tag / bucket this file was uploaded to
  - Optional user_id?: string
Returns Attachment
Overrides BaseObject.constructor
- Defined in core/src/objects/Attachment.ts:24

Properties

client

client: Client

deleted

deleted: boolean = false

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

bucket

get bucket(): AttachmentBucket
Bucket this attachment was uploaded to.

Returns AttachmentBucket
- Defined in core/src/objects/Attachment.ts:44

contentType

get contentType(): string
MIME type of this file.

Returns string
- Defined in core/src/objects/Attachment.ts:32

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

metadata

get metadata(): {
    type: "File";
} | {
    type: "Text";
} | {
    height: number;
    type: "Image";
    width: number;
} | {
    height: number;
    type: "Video";
    width: number;
} | {
    type: "Audio";
}
Parsed file metadata.

Returns {
    type: "File";
} | {
    type: "Text";
} | {
    height: number;
    type: "Image";
    width: number;
} | {
    height: number;
    type: "Video";
    width: number;
} | {
    type: "Audio";
}
- Defined in core/src/objects/Attachment.ts:40

name

get name(): string
Original file name.

Returns string
- Defined in core/src/objects/Attachment.ts:28

size

get size(): number
File size in bytes.

Returns number
- Defined in core/src/objects/Attachment.ts:36

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

Methods

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

generateDownloadURL

generateDownloadURL(): string
Generate a link to download this attachment.

Returns string
- Defined in core/src/objects/Attachment.ts:72

generateURL

generateURL(...args: AttachmentArgs): string
Generate a URL to this attachment with optional parameters.
Parameters
- Rest ...args: AttachmentArgs
Returns string
- Defined in core/src/objects/Attachment.ts:49

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): Attachment
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns Attachment
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): Attachment
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns Attachment
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

toString

toString(): string
Converts this object to a string.

Returns
The object ID.

Returns string
Inherited from BaseObject.toString
- Defined in core/src/objects/BaseObject.ts:33

update

update(data?: Partial<{
    _id: string;
    content_type: string;
    deleted?: boolean;
    filename: string;
    message_id?: string;
    metadata: {
        type: "File";
    } | {
        type: "Text";
    } | {
        height: number;
        type: "Image";
        width: number;
    } | {
        height: number;
        type: "Video";
        width: number;
    } | {
        type: "Audio";
    };
    object_id?: string;
    reported?: boolean;
    server_id?: string;
    size: number;
    tag: string;
    user_id?: string;
}>): Attachment
Update this object with new API data.
Parameters
- data: Partial<{
      _id: string;
      content_type: string;
      deleted?: boolean;
      filename: string;
      message_id?: string;
      metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      };
      object_id?: string;
      reported?: boolean;
      server_id?: string;
      size: number;
      tag: string;
      user_id?: string;
  }> = {}
Returns Attachment
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24

Class Attachment

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

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

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

Returns Attachment

Properties

client

deleted

Accessors

Protected _id

Returns ""

bucket

Returns AttachmentBucket

contentType

Returns string

createdAt

Returns number

id

Returns string

metadata

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

name

Returns string

size

Returns number

source

Returns APIType

Methods

fireUpdate

Parameters

Optional updated: any[]

Returns void

generateDownloadURL

Returns string

generateURL

Parameters

Rest ...args: AttachmentArgs

Returns string

offUpdate

Returns

Parameters

callback: MiniEmitterCallback<any>

Returns Attachment

onUpdate

Returns

Parameters

callback: MiniEmitterCallback<any>

Returns Attachment

toString

Returns

Returns string

update

`Optional` deleted?: boolean

`Optional` message_id?: string

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

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Protected` _id

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

`Optional` updated: any[]

`Rest` ...args: AttachmentArgs