Class: BotMediaMetadata

Defined in: WAProto/index.d.ts:4337

Represents a BotMediaMetadata.

Implements

• IBotMediaMetadata

Constructors

new BotMediaMetadata()

new BotMediaMetadata(properties?): BotMediaMetadata

Defined in: WAProto/index.d.ts:4343

Constructs a new BotMediaMetadata.

Parameters

properties?

IBotMediaMetadata

Properties to set

Returns

BotMediaMetadata

Properties

directPath?

optional directPath: null | string

Defined in: WAProto/index.d.ts:4355

BotMediaMetadata directPath.

Implementation of

IBotMediaMetadata.directPath

---

fileEncSha256?

optional fileEncSha256: null | string

Defined in: WAProto/index.d.ts:4352

BotMediaMetadata fileEncSha256.

Implementation of

IBotMediaMetadata.fileEncSha256

---

fileSha256?

optional fileSha256: null | string

Defined in: WAProto/index.d.ts:4346

BotMediaMetadata fileSha256.

Implementation of

IBotMediaMetadata.fileSha256

---

mediaKey?

optional mediaKey: null | string

Defined in: WAProto/index.d.ts:4349

BotMediaMetadata mediaKey.

Implementation of

IBotMediaMetadata.mediaKey

---

mediaKeyTimestamp?

optional mediaKeyTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:4358

BotMediaMetadata mediaKeyTimestamp.

Implementation of

IBotMediaMetadata.mediaKeyTimestamp

---

mimetype?

optional mimetype: null | string

Defined in: WAProto/index.d.ts:4361

BotMediaMetadata mimetype.

Implementation of

IBotMediaMetadata.mimetype

---

orientationType?

optional orientationType: null | OrientationType

Defined in: WAProto/index.d.ts:4364

BotMediaMetadata orientationType.

Implementation of

IBotMediaMetadata.orientationType

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:4434

Converts this BotMediaMetadata to JSON.

Returns

object

JSON object

---

create()

static create(properties?): BotMediaMetadata

Defined in: WAProto/index.d.ts:4371

Creates a new BotMediaMetadata instance using the specified properties.

Parameters

properties?

IBotMediaMetadata

Properties to set

Returns

BotMediaMetadata

BotMediaMetadata instance

---

decode()

static decode(reader, length?): BotMediaMetadata

Defined in: WAProto/index.d.ts:4397

Decodes a BotMediaMetadata message from the specified reader or buffer.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?

number

Message length if known beforehand

Returns

BotMediaMetadata

BotMediaMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): BotMediaMetadata

Defined in: WAProto/index.d.ts:4406

Decodes a BotMediaMetadata message from the specified reader or buffer, length delimited.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

BotMediaMetadata

BotMediaMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:4379

Encodes the specified BotMediaMetadata message. Does not implicitly verify messages.

Parameters

message

IBotMediaMetadata

BotMediaMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:4387

Encodes the specified BotMediaMetadata message, length delimited. Does not implicitly verify messages.

Parameters

message

IBotMediaMetadata

BotMediaMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): BotMediaMetadata

Defined in: WAProto/index.d.ts:4420

Creates a BotMediaMetadata message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

BotMediaMetadata

BotMediaMetadata

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:4441

Gets the default type url for BotMediaMetadata

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:4428

Creates a plain object from a BotMediaMetadata message. Also converts values to other types if specified.

Parameters

message

BotMediaMetadata

BotMediaMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:4413

Verifies a BotMediaMetadata message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not