Class: BotPluginMetadata

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

Represents a BotPluginMetadata.

Implements

• IBotPluginMetadata

Constructors

new BotPluginMetadata()

new BotPluginMetadata(properties?): BotPluginMetadata

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

Constructs a new BotPluginMetadata.

Parameters

properties?

IBotPluginMetadata

Properties to set

Returns

BotPluginMetadata

Properties

deprecatedField?

optional deprecatedField: null | PluginType

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

BotPluginMetadata deprecatedField.

Implementation of

IBotPluginMetadata.deprecatedField

---

expectedLinksCount?

optional expectedLinksCount: null | number

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

BotPluginMetadata expectedLinksCount.

Implementation of

IBotPluginMetadata.expectedLinksCount

---

faviconCdnUrl?

optional faviconCdnUrl: null | string

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

BotPluginMetadata faviconCdnUrl.

Implementation of

IBotPluginMetadata.faviconCdnUrl

---

parentPluginMessageKey?

optional parentPluginMessageKey: null | IMessageKey

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

BotPluginMetadata parentPluginMessageKey.

Implementation of

IBotPluginMetadata.parentPluginMessageKey

---

parentPluginType?

optional parentPluginType: null | PluginType

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

BotPluginMetadata parentPluginType.

Implementation of

IBotPluginMetadata.parentPluginType

---

pluginType?

optional pluginType: null | PluginType

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

BotPluginMetadata pluginType.

Implementation of

IBotPluginMetadata.pluginType

---

profilePhotoCdnUrl?

optional profilePhotoCdnUrl: null | string

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

BotPluginMetadata profilePhotoCdnUrl.

Implementation of

IBotPluginMetadata.profilePhotoCdnUrl

---

provider?

optional provider: null | SearchProvider

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

BotPluginMetadata provider.

Implementation of

IBotPluginMetadata.provider

---

referenceIndex?

optional referenceIndex: null | number

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

BotPluginMetadata referenceIndex.

Implementation of

IBotPluginMetadata.referenceIndex

---

searchProviderUrl?

optional searchProviderUrl: null | string

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

BotPluginMetadata searchProviderUrl.

Implementation of

IBotPluginMetadata.searchProviderUrl

---

searchQuery?

optional searchQuery: null | string

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

BotPluginMetadata searchQuery.

Implementation of

IBotPluginMetadata.searchQuery

---

thumbnailCdnUrl?

optional thumbnailCdnUrl: null | string

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

BotPluginMetadata thumbnailCdnUrl.

Implementation of

IBotPluginMetadata.thumbnailCdnUrl

Methods

toJSON()

toJSON(): object

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

Converts this BotPluginMetadata to JSON.

Returns

object

JSON object

---

create()

static create(properties?): BotPluginMetadata

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

Creates a new BotPluginMetadata instance using the specified properties.

Parameters

properties?

IBotPluginMetadata

Properties to set

Returns

BotPluginMetadata

BotPluginMetadata instance

---

decode()

static decode(reader, length?): BotPluginMetadata

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

Decodes a BotPluginMetadata 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

BotPluginMetadata

BotPluginMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): BotPluginMetadata

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

BotPluginMetadata

BotPluginMetadata

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

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

Parameters

message

IBotPluginMetadata

BotPluginMetadata 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:5475

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

Parameters

message

IBotPluginMetadata

BotPluginMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): BotPluginMetadata

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

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

Parameters

object

Plain object

Returns

BotPluginMetadata

BotPluginMetadata

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for BotPluginMetadata

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

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

Parameters

message

BotPluginMetadata

BotPluginMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a BotPluginMetadata message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not