Skip to main content

Class: BotPromotionMessageMetadata

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

Represents a BotPromotionMessageMetadata.

Implements

Constructors

new BotPromotionMessageMetadata()

new BotPromotionMessageMetadata(properties?): BotPromotionMessageMetadata

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

Constructs a new BotPromotionMessageMetadata.

Parameters

properties?

IBotPromotionMessageMetadata

Properties to set

Returns

BotPromotionMessageMetadata

Properties

buttonTitle?

optional buttonTitle: null | string

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

BotPromotionMessageMetadata buttonTitle.

Implementation of

IBotPromotionMessageMetadata.buttonTitle


promotionType?

optional promotionType: null | BotPromotionType

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

BotPromotionMessageMetadata promotionType.

Implementation of

IBotPromotionMessageMetadata.promotionType

Methods

toJSON()

toJSON(): object

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

Converts this BotPromotionMessageMetadata to JSON.

Returns

object

JSON object


create()

static create(properties?): BotPromotionMessageMetadata

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

Creates a new BotPromotionMessageMetadata instance using the specified properties.

Parameters

properties?

IBotPromotionMessageMetadata

Properties to set

Returns

BotPromotionMessageMetadata

BotPromotionMessageMetadata instance


decode()

static decode(reader, length?): BotPromotionMessageMetadata

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

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

BotPromotionMessageMetadata

BotPromotionMessageMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited()

static decodeDelimited(reader): BotPromotionMessageMetadata

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

BotPromotionMessageMetadata

BotPromotionMessageMetadata

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

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

Parameters

message

IBotPromotionMessageMetadata

BotPromotionMessageMetadata 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:6198

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

Parameters

message

IBotPromotionMessageMetadata

BotPromotionMessageMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


fromObject()

static fromObject(object): BotPromotionMessageMetadata

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

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

Parameters

object

Plain object

Returns

BotPromotionMessageMetadata

BotPromotionMessageMetadata


getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for BotPromotionMessageMetadata

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

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

Parameters

message

BotPromotionMessageMetadata

BotPromotionMessageMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object


verify()

static verify(message): null | string

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

Verifies a BotPromotionMessageMetadata message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not