Class AttachMediaModel

80666

480666 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- AttachMediaModel

Index

Constructors

constructor

Constructors

constructor

new AttachMediaModel(
proterties?: ModelPropertiesContructor<AttachMediaModel>,
options?: ModelOptions,
): AttachMediaModel
Parameters
- Optionalproterties: ModelPropertiesContructor<AttachMediaModel>
- Optionaloptions: ModelOptions
Returns AttachMediaModel
Inherited from Model.constructor
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:58

Properties

`Readonly`attributes

attributes: Props & Session

`Optional`caption

caption?: any

`Optional`collection

collection?: undefined

`Optional`documentPageCount

documentPageCount?: any

`Optional`editedFile

editedFile?: any

`Optional`exception

exception?: any

`Optional`file

file?: any

`Optional` `Readonly`fileExt

fileExt?: any

`Optional`filename

filename?: any

`Optional`fileOrigin

fileOrigin?: any

`Optional` `Readonly`filesize

filesize?: any

`Optional`fullPreview

fullPreview?: any

`Optional`fullPreviewSize

fullPreviewSize?: any

`Optional`gifAttribution

gifAttribution?: any

`Optional`id

id?: any

isGif

isGif: boolean

`Readonly`isState

isState: true

isVcardOverMmsDocument

isVcardOverMmsDocument: boolean

`Optional`mediaEditorData

mediaEditorData?: any

`Optional`mediaPrep

mediaPrep?: any

`Optional`mimetype

mimetype?: any

`Readonly`mirrorMask

mirrorMask: {
    "change:caption"?: number;
    "change:documentPageCount"?: number;
    "change:editedFile"?: number;
    "change:exception"?: number;
    "change:file"?: number;
    "change:fileExt"?: number;
    "change:filename"?: number;
    "change:fileOrigin"?: number;
    "change:filesize"?: number;
    "change:fullPreview"?: number;
    "change:fullPreviewSize"?: number;
    "change:gifAttribution"?: number;
    "change:id"?: number;
    "change:isGif": number;
    "change:isVcardOverMmsDocument": number;
    "change:mediaEditorData"?: number;
    "change:mediaPrep"?: number;
    "change:mimetype"?: number;
    "change:originalMimetype"?: number;
    "change:preview"?: number;
    "change:previewable"?: number;
    "change:processPromise"?: number;
    "change:stale"?: number;
    "change:state"?: number;
    "change:type"?: number;
    "change:uiProcessed"?: number;
}

`Optional`originalMimetype

originalMimetype?: any

`Optional`parent

parent?: any

`Optional`preview

preview?: any

`Optional` `Readonly`previewable

previewable?: any

`Optional`processPromise

processPromise?: any

proxyName

proxyName: string

`Optional`stale

stale?: any

`Optional`state

state?: any

`Optional`type

type?: any

`Optional`uiProcessed

uiProcessed?: any

`Static` `Optional`allowedIds

allowedIds?: any[]

`Static` `Optional`idClass

idClass?: any

`Static`Proxy

Proxy: string

Methods

addChild

addChild(id: Stringable, context: { [key: string]: any }): void
Parameters
- id: Stringable
- context: { [key: string]: any }
Returns void
Inherited from Model.addChild
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:51

bind

bind(eventName: Event, listener: Listener, context?: any): this
Alias of on
Parameters
- eventName: Event
- listener: Listener
- Optionalcontext: any
Returns this
Alias
on
Inherited from Model.bind
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:85

canRedoMediaEditorData

canRedoMediaEditorData(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:67

canUndoMediaEditorData

canUndoMediaEditorData(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:66

clear

clear(): void
Returns void
Inherited from Model.clear
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:58

decObservers

decObservers(): void
Returns void
Inherited from Model.decObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:49

delete

delete(): void
Returns void
Inherited from Model.delete
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:59

emit

emit(eventName: Event, ...args: any[]): this
Alias of trigger
Parameters
- eventName: Event
- ...args: any[]
Returns this
Alias
trigger
Inherited from Model.emit
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:105

get

get<T extends keyof AttachMediaModel>(attr: T): AttachMediaModel[T]
Type Parameters
- T extends keyof AttachMediaModel
Parameters
- attr: T
Returns AttachMediaModel[T]
Inherited from Model.get
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:54

getDefault

getDefault<T extends keyof AttachMediaModel>(attr: T): any
Type Parameters
- T extends keyof AttachMediaModel
Parameters
- attr: T
Returns any
Inherited from Model.getDefault
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:61

getFileType

getFileType(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:61

hasObservers

hasObservers(): boolean
Returns boolean
Inherited from Model.hasObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:50

hasUnfiredChanges

hasUnfiredChanges(): boolean
Returns boolean
Inherited from Model.hasUnfiredChanges
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:56

incObservers

incObservers(e?: boolean): void
Parameters
- Optionale: boolean
Returns void
Inherited from Model.incObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:48

initialize

initialize(): void
Returns void
Inherited from Model.initialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:47

isListening

isListening(eventName: Event): boolean
Parameters
- eventName: Event
Returns boolean
Inherited from Model.isListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:80

isViewableOnce

isViewableOnce(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:62

listenTo

listenTo(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenTo
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:67

listenToAndRun

listenToAndRun(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenToAndRun
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:79

listenToOnce

listenToOnce(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenToOnce
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:73

off

off(eventName?: Event, listener?: Listener, context?: any): this
Removes the specified listener from the listener array for the event named eventName.
Parameters
- OptionaleventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.off
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:55

on

on(eventName: Event, listener: Listener, context?: any): this
Adds the listener function to the end of the listeners array for the event named eventName.
Parameters
- eventName: Event
  The name of the event.
- listener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.on
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:37

once

once(eventName: Event, listener: Listener, context?: any): this
Adds a one-time listener function for the event named eventName.
Parameters
- eventName: Event
  The name of the event.
- listener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.once
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:46

processAttachment

processAttachment(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:59

redoMediaEditorData

redoMediaEditorData(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:65

removeAllListeners

removeAllListeners(): this
Removes all listeners.

Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.removeAllListeners
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:100

removeListener

removeListener(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.removeListener
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:95

reset

reset(): void
Returns void
Inherited from Model.reset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:60

sendToChat

sendToChat(e?: any, t?: any): any
Parameters
- Optionale: any
- Optionalt: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:60

serialize

serialize(): Props
Returns Props
Inherited from ModelProxy.serialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:26

set

set(...args: any): any
Parameters
- ...args: any
Returns any
Inherited from Model.set
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:55

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from Model.stopListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:61

toJSON

toJSON(): Props
Returns Props
Inherited from ModelProxy.toJSON
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:25

trigger

trigger(eventName: Event, ...args: any[]): this
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Parameters
- eventName: Event
- ...args: any[]
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.trigger
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:60

unbind

unbind(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.unbind
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:90

undoMediaEditorData

undoMediaEditorData(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:64

unset

unset(ids: Stringable | Stringable[], t?: any): void
Parameters
- ids: Stringable | Stringable[]
- Optionalt: any
Returns void
Inherited from Model.unset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:57

updateCaption

updateCaption(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:71

updateEditedFile

updateEditedFile(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:68

updateFullPreview

updateFullPreview(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:70

updateMediaEditorData

updateMediaEditorData(e?: any, t?: any): any
Parameters
- Optionale: any
- Optionalt: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:63

updatePreview

updatePreview(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/AttachMediaModel.d.ts:69

`Static`isIdType

isIdType(e: any): boolean
Parameters
- e: any
Returns boolean
Inherited from Model.isIdType
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:62

Class AttachMediaModel

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AttachMediaModel

Properties

Readonlyattributes

Optionalcaption

Optionalcollection

OptionaldocumentPageCount

OptionaleditedFile

Optionalexception

Optionalfile

Optional ReadonlyfileExt

Optionalfilename

OptionalfileOrigin

Optional Readonlyfilesize

OptionalfullPreview

OptionalfullPreviewSize

OptionalgifAttribution

Optionalid

isGif

ReadonlyisState

isVcardOverMmsDocument

OptionalmediaEditorData

OptionalmediaPrep

Optionalmimetype

ReadonlymirrorMask

OptionaloriginalMimetype

Optionalparent

Optionalpreview

Optional Readonlypreviewable

OptionalprocessPromise

proxyName

Optionalstale

Optionalstate

Optionaltype

OptionaluiProcessed

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

Methods

addChild

Parameters

Returns void

bind

Parameters

Returns this

Alias

canRedoMediaEditorData

Returns boolean

canUndoMediaEditorData

Returns boolean

clear

Returns void

decObservers

Returns void

delete

Returns void

emit

Parameters

Returns this

Alias

get

Type Parameters

Parameters

Returns AttachMediaModel[T]

getDefault

Type Parameters

Parameters

Returns any

getFileType

Returns any

`Readonly`attributes

`Optional`caption

`Optional`collection

`Optional`documentPageCount

`Optional`editedFile

`Optional`exception

`Optional`file

`Optional` `Readonly`fileExt

`Optional`filename

`Optional`fileOrigin

`Optional` `Readonly`filesize

`Optional`fullPreview

`Optional`fullPreviewSize

`Optional`gifAttribution

`Optional`id

`Readonly`isState

`Optional`mediaEditorData

`Optional`mediaPrep

`Optional`mimetype

`Readonly`mirrorMask

`Optional`originalMimetype

`Optional`parent

`Optional`preview

`Optional` `Readonly`previewable

`Optional`processPromise

`Optional`stale

`Optional`state

`Optional`type

`Optional`uiProcessed

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy