Class MediaDataModel

2320

502320 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- MediaDataModel

Index

Constructors

constructor

Constructors

constructor

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

Properties

`Optional`animatedAsNewMsg

animatedAsNewMsg?: any

`Optional`animationDuration

animationDuration?: any

`Optional`aspectRatio

aspectRatio?: any

`Readonly`attributes

attributes: Props & Session

`Optional`collection

collection?: undefined

`Optional`directPath

directPath?: any

`Optional`documentPreview

documentPreview?: any

`Optional`duration

duration?: any

`Optional`durationFloat

durationFloat?: any

`Optional`emojis

emojis?: any

`Optional`encFilehash

encFilehash?: any

`Optional`filehash

filehash?: any

`Optional`filename

filename?: any

`Optional`firstFrameLength

firstFrameLength?: any

`Optional`firstFrameSidecar

firstFrameSidecar?: any

`Optional`fullHeight

fullHeight?: any

`Optional`fullPreviewData

fullPreviewData?: any

`Optional`fullPreviewSize

fullPreviewSize?: any

`Optional`fullWidth

fullWidth?: any

`Optional`gifAttribution

gifAttribution?: any

isAnimated

isAnimated: boolean

isGif

isGif: boolean

`Readonly`isState

isState: true

isVcardOverMmsDocument

isVcardOverMmsDocument: boolean

isViewOnce

isViewOnce: boolean

`Optional`mediaBlob

mediaBlob?: OpaqueData

`Optional`mediaKey

mediaKey?: any

`Optional`mediaKeyTimestamp

mediaKeyTimestamp?: any

`Optional`mediaStage

mediaStage?: any

`Optional`mimetype

mimetype?: any

`Readonly`mirrorMask

mirrorMask: {
    "change:animatedAsNewMsg"?: number;
    "change:animationDuration"?: number;
    "change:aspectRatio"?: number;
    "change:directPath"?: number;
    "change:documentPreview"?: number;
    "change:duration"?: number;
    "change:durationFloat"?: number;
    "change:emojis"?: number;
    "change:encFilehash"?: number;
    "change:filehash"?: number;
    "change:filename"?: number;
    "change:firstFrameLength"?: number;
    "change:firstFrameSidecar"?: number;
    "change:fullHeight"?: number;
    "change:fullPreviewData"?: number;
    "change:fullPreviewSize"?: number;
    "change:fullWidth"?: number;
    "change:gifAttribution"?: number;
    "change:isAnimated": number;
    "change:isGif": number;
    "change:isVcardOverMmsDocument": number;
    "change:isViewOnce": number;
    "change:mediaBlob"?: number;
    "change:mediaKey"?: number;
    "change:mediaKeyTimestamp"?: number;
    "change:mediaStage"?: number;
    "change:mimetype"?: number;
    "change:pageCount"?: number;
    "change:parsedVcards"?: number;
    "change:preview"?: number;
    "change:progressiveStage"?: number;
    "change:renderableUrl"?: number;
    "change:rgbaBuffer"?: number;
    "change:rgbaHeight"?: number;
    "change:rgbaWidth"?: number;
    "change:sidecar"?: number;
    "change:singleLoopDuration"?: number;
    "change:size"?: number;
    "change:stale"?: number;
    "change:streamable"?: number;
    "change:subtype"?: number;
    "change:type"?: number;
}

`Optional`pageCount

pageCount?: any

`Optional`parent

parent?: any

`Optional`parsedVcards

parsedVcards?: any

`Optional`preview

preview?: any

`Optional`progressiveStage

progressiveStage?: any

proxyName

proxyName: string

`Optional`renderableUrl

renderableUrl?: any

`Optional`rgbaBuffer

rgbaBuffer?: any

`Optional`rgbaHeight

rgbaHeight?: any

`Optional`rgbaWidth

rgbaWidth?: any

`Optional`sidecar

sidecar?: any

`Optional`singleLoopDuration

singleLoopDuration?: any

`Optional`size

size?: any

`Optional`stale

stale?: any

`Optional` `Readonly`streamable

streamable?: any

`Optional`subtype

subtype?: any

`Optional`type

type?: any

`Static` `Optional`allowedIds

allowedIds?: any[]

`Static` `Optional`idClass

idClass?: any

`Static`Proxy

Proxy: string

`Static` `Optional`TYPE

TYPE?: any

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

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

getDefault

getDefault<T extends keyof MediaDataModel>(attr: T): any
Type Parameters
- T extends keyof MediaDataModel
Parameters
- attr: T
Returns any
Inherited from Model.getDefault
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.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

isDownloadable

isDownloadable(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/MediaDataModel.d.ts:80

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

isStreamable

isStreamable(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/MediaDataModel.d.ts:77

isStreamableType

isStreamableType(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/MediaDataModel.d.ts:79

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

listenToServiceWorkerSupport

listenToServiceWorkerSupport(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/MediaDataModel.d.ts:78

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

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

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

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

`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 MediaDataModel

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MediaDataModel

Properties

OptionalanimatedAsNewMsg

OptionalanimationDuration

OptionalaspectRatio

Readonlyattributes

Optionalcollection

OptionaldirectPath

OptionaldocumentPreview

Optionalduration

OptionaldurationFloat

Optionalemojis

OptionalencFilehash

Optionalfilehash

Optionalfilename

OptionalfirstFrameLength

OptionalfirstFrameSidecar

OptionalfullHeight

OptionalfullPreviewData

OptionalfullPreviewSize

OptionalfullWidth

OptionalgifAttribution

isAnimated

isGif

ReadonlyisState

isVcardOverMmsDocument

isViewOnce

OptionalmediaBlob

OptionalmediaKey

OptionalmediaKeyTimestamp

OptionalmediaStage

Optionalmimetype

ReadonlymirrorMask

OptionalpageCount

Optionalparent

OptionalparsedVcards

Optionalpreview

OptionalprogressiveStage

proxyName

OptionalrenderableUrl

OptionalrgbaBuffer

OptionalrgbaHeight

OptionalrgbaWidth

Optionalsidecar

OptionalsingleLoopDuration

Optionalsize

Optionalstale

Optional Readonlystreamable

Optionalsubtype

Optionaltype

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

Static OptionalTYPE

Methods

addChild

Parameters

Returns void

bind

Parameters

Returns this

Alias

clear

Returns void

decObservers

Returns void

delete

Returns void

emit

`Optional`animatedAsNewMsg

`Optional`animationDuration

`Optional`aspectRatio

`Readonly`attributes

`Optional`collection

`Optional`directPath

`Optional`documentPreview

`Optional`duration

`Optional`durationFloat

`Optional`emojis

`Optional`encFilehash

`Optional`filehash

`Optional`filename

`Optional`firstFrameLength

`Optional`firstFrameSidecar

`Optional`fullHeight

`Optional`fullPreviewData

`Optional`fullPreviewSize

`Optional`fullWidth

`Optional`gifAttribution

`Readonly`isState

`Optional`mediaBlob

`Optional`mediaKey

`Optional`mediaKeyTimestamp

`Optional`mediaStage

`Optional`mimetype

`Readonly`mirrorMask

`Optional`pageCount

`Optional`parent

`Optional`parsedVcards

`Optional`preview

`Optional`progressiveStage

`Optional`renderableUrl

`Optional`rgbaBuffer

`Optional`rgbaHeight

`Optional`rgbaWidth

`Optional`sidecar

`Optional`singleLoopDuration

`Optional`size

`Optional`stale

`Optional` `Readonly`streamable

`Optional`subtype

`Optional`type

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy

`Static` `Optional`TYPE