ComponentFileclass

Utils Component File Structure

On this page

Overview
Constructor1
Properties4
Methods15

Utils Component File Structure

import { Utils } from 'detritus-client';

Utils.ComponentFile;

Hierarchy

StructureComponentFile

4 properties5 methods10 inheritedsrc/utils/components/file.ts:29

Constructor

new ComponentFile

src/utils/components/file.ts:37

new ComponentFile(data?: ComponentFileData)

Properties

file

ComponentUnfurledMedia

id?

number

optional

spoiler?

boolean

optional

type

MessageComponentTypes

Default MessageComponentTypes.FILE

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from Structure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/utils/components/file.ts:58

merge(data?: BaseStructureData): void

Overrides Structure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from Structure.mergeValue

setFile()

src/utils/components/file.ts:43

setFile(file: ComponentUnfurledMedia | ComponentUnfurledMediaData): this

setId()

src/utils/components/file.ts:48

setId(id: number): this

setSpoiler()

src/utils/components/file.ts:53

setSpoiler(spoiler: boolean): this

toJSON()

src/utils/components/file.ts:82

toJSON(): RawChannelMessageComponent

Overrides Structure.toJSON