Skip to main content

Class: BotProgressIndicatorMetadata

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

Represents a BotProgressIndicatorMetadata.

Implements

Constructors

new BotProgressIndicatorMetadata()

new BotProgressIndicatorMetadata(properties?): BotProgressIndicatorMetadata

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

Constructs a new BotProgressIndicatorMetadata.

Parameters

properties?

IBotProgressIndicatorMetadata

Properties to set

Returns

BotProgressIndicatorMetadata

Properties

progressDescription?

optional progressDescription: null | string

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

BotProgressIndicatorMetadata progressDescription.

Implementation of

IBotProgressIndicatorMetadata.progressDescription


stepsMetadata

stepsMetadata: IBotPlanningStepMetadata[]

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

BotProgressIndicatorMetadata stepsMetadata.

Implementation of

IBotProgressIndicatorMetadata.stepsMetadata

Methods

toJSON()

toJSON(): object

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

Converts this BotProgressIndicatorMetadata to JSON.

Returns

object

JSON object


create()

static create(properties?): BotProgressIndicatorMetadata

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

Creates a new BotProgressIndicatorMetadata instance using the specified properties.

Parameters

properties?

IBotProgressIndicatorMetadata

Properties to set

Returns

BotProgressIndicatorMetadata

BotProgressIndicatorMetadata instance


decode()

static decode(reader, length?): BotProgressIndicatorMetadata

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

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

BotProgressIndicatorMetadata

BotProgressIndicatorMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited()

static decodeDelimited(reader): BotProgressIndicatorMetadata

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

BotProgressIndicatorMetadata

BotProgressIndicatorMetadata

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

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

Parameters

message

IBotProgressIndicatorMetadata

BotProgressIndicatorMetadata 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:5070

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

Parameters

message

IBotProgressIndicatorMetadata

BotProgressIndicatorMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


fromObject()

static fromObject(object): BotProgressIndicatorMetadata

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

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

Parameters

object

Plain object

Returns

BotProgressIndicatorMetadata

BotProgressIndicatorMetadata


getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for BotProgressIndicatorMetadata

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

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

Parameters

message

BotProgressIndicatorMetadata

BotProgressIndicatorMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object


verify()

static verify(message): null | string

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

Verifies a BotProgressIndicatorMetadata message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not