Class: BotMetadata

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

Represents a BotMetadata.

Implements

• IBotMetadata

Constructors

new BotMetadata()

new BotMetadata(properties?): BotMetadata

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

Constructs a new BotMetadata.

Parameters

properties?

IBotMetadata

Properties to set

Returns

BotMetadata

Properties

aiConversationContext?

optional aiConversationContext: null | Uint8Array<ArrayBufferLike>

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

BotMetadata aiConversationContext.

Implementation of

IBotMetadata.aiConversationContext

---

avatarMetadata?

optional avatarMetadata: null | IBotAvatarMetadata

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

BotMetadata avatarMetadata.

Implementation of

IBotMetadata.avatarMetadata

---

botAgeCollectionMetadata?

optional botAgeCollectionMetadata: null | IBotAgeCollectionMetadata

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

BotMetadata botAgeCollectionMetadata.

Implementation of

IBotMetadata.botAgeCollectionMetadata

---

botLinkedAccountsMetadata?

optional botLinkedAccountsMetadata: null | IBotLinkedAccountsMetadata

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

BotMetadata botLinkedAccountsMetadata.

Implementation of

IBotMetadata.botLinkedAccountsMetadata

---

botMetricsMetadata?

optional botMetricsMetadata: null | IBotMetricsMetadata

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

BotMetadata botMetricsMetadata.

Implementation of

IBotMetadata.botMetricsMetadata

---

botModeSelectionMetadata?

optional botModeSelectionMetadata: null | IBotModeSelectionMetadata

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

BotMetadata botModeSelectionMetadata.

Implementation of

IBotMetadata.botModeSelectionMetadata

---

botPromotionMessageMetadata?

optional botPromotionMessageMetadata: null | IBotPromotionMessageMetadata

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

BotMetadata botPromotionMessageMetadata.

Implementation of

IBotMetadata.botPromotionMessageMetadata

---

botQuotaMetadata?

optional botQuotaMetadata: null | IBotQuotaMetadata

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

BotMetadata botQuotaMetadata.

Implementation of

IBotMetadata.botQuotaMetadata

---

capabilityMetadata?

optional capabilityMetadata: null | IBotCapabilityMetadata

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

BotMetadata capabilityMetadata.

Implementation of

IBotMetadata.capabilityMetadata

---

imagineMetadata?

optional imagineMetadata: null | IBotImagineMetadata

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

BotMetadata imagineMetadata.

Implementation of

IBotMetadata.imagineMetadata

---

invokerJid?

optional invokerJid: null | string

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

BotMetadata invokerJid.

Implementation of

IBotMetadata.invokerJid

---

memoryMetadata?

optional memoryMetadata: null | IBotMemoryMetadata

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

BotMetadata memoryMetadata.

Implementation of

IBotMetadata.memoryMetadata

---

memuMetadata?

optional memuMetadata: null | IBotMemuMetadata

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

BotMetadata memuMetadata.

Implementation of

IBotMetadata.memuMetadata

---

messageDisclaimerText?

optional messageDisclaimerText: null | string

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

BotMetadata messageDisclaimerText.

Implementation of

IBotMetadata.messageDisclaimerText

---

modelMetadata?

optional modelMetadata: null | IBotModelMetadata

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

BotMetadata modelMetadata.

Implementation of

IBotMetadata.modelMetadata

---

personaId?

optional personaId: null | string

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

BotMetadata personaId.

Implementation of

IBotMetadata.personaId

---

pluginMetadata?

optional pluginMetadata: null | IBotPluginMetadata

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

BotMetadata pluginMetadata.

Implementation of

IBotMetadata.pluginMetadata

---

progressIndicatorMetadata?

optional progressIndicatorMetadata: null | IBotProgressIndicatorMetadata

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

BotMetadata progressIndicatorMetadata.

Implementation of

IBotMetadata.progressIndicatorMetadata

---

reminderMetadata?

optional reminderMetadata: null | IBotReminderMetadata

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

BotMetadata reminderMetadata.

Implementation of

IBotMetadata.reminderMetadata

---

renderingMetadata?

optional renderingMetadata: null | IBotRenderingMetadata

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

BotMetadata renderingMetadata.

Implementation of

IBotMetadata.renderingMetadata

---

richResponseSourcesMetadata?

optional richResponseSourcesMetadata: null | IBotSourcesMetadata

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

BotMetadata richResponseSourcesMetadata.

Implementation of

IBotMetadata.richResponseSourcesMetadata

---

sessionMetadata?

optional sessionMetadata: null | IBotSessionMetadata

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

BotMetadata sessionMetadata.

Implementation of

IBotMetadata.sessionMetadata

---

suggestedPromptMetadata?

optional suggestedPromptMetadata: null | IBotSuggestedPromptMetadata

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

BotMetadata suggestedPromptMetadata.

Implementation of

IBotMetadata.suggestedPromptMetadata

---

timezone?

optional timezone: null | string

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

BotMetadata timezone.

Implementation of

IBotMetadata.timezone

Methods

toJSON()

toJSON(): object

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

Converts this BotMetadata to JSON.

Returns

object

JSON object

---

create()

static create(properties?): BotMetadata

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

Creates a new BotMetadata instance using the specified properties.

Parameters

properties?

IBotMetadata

Properties to set

Returns

BotMetadata

BotMetadata instance

---

decode()

static decode(reader, length?): BotMetadata

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

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

BotMetadata

BotMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): BotMetadata

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

BotMetadata

BotMetadata

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

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

Parameters

message

IBotMetadata

BotMetadata 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:4941

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

Parameters

message

IBotMetadata

BotMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): BotMetadata

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

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

Parameters

object

Plain object

Returns

BotMetadata

BotMetadata

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for BotMetadata

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

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

Parameters

message

BotMetadata

BotMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a BotMetadata message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not