Skip to main content

Class: BotImagineMetadata

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

Represents a BotImagineMetadata.

Implements​

Constructors​

new BotImagineMetadata()​

new BotImagineMetadata(properties?): BotImagineMetadata

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

Constructs a new BotImagineMetadata.

Parameters​

properties?​

IBotImagineMetadata

Properties to set

Returns​

BotImagineMetadata

Properties​

imagineType?​

optional imagineType: null | ImagineType

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

BotImagineMetadata imagineType.

Implementation of​

IBotImagineMetadata.imagineType

Methods​

toJSON()​

toJSON(): object

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

Converts this BotImagineMetadata to JSON.

Returns​

object

JSON object

create()​

static create(properties?): BotImagineMetadata

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

Creates a new BotImagineMetadata instance using the specified properties.

Parameters​

properties?​

IBotImagineMetadata

Properties to set

Returns​

BotImagineMetadata

BotImagineMetadata instance

decode()​

static decode(reader, length?): BotImagineMetadata

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

Decodes a BotImagineMetadata 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​

BotImagineMetadata

BotImagineMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BotImagineMetadata

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

BotImagineMetadata

BotImagineMetadata

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:3663

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

Parameters​

message​

IBotImagineMetadata

BotImagineMetadata 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:3671

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

Parameters​

message​

IBotImagineMetadata

BotImagineMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BotImagineMetadata

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

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

Parameters​

object​

Plain object

Returns​

BotImagineMetadata

BotImagineMetadata

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for BotImagineMetadata

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:3712

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

Parameters​

message​

BotImagineMetadata

BotImagineMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a BotImagineMetadata message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not