Skip to main content

Class: ListValue

google.protobuf.ListValue

Represents a ListValue.

Implements

Constructors

constructor

new ListValue(properties?): ListValue

Constructs a new ListValue.

Parameters

NameTypeDescription
properties?IListValueProperties to set

Returns

ListValue

Properties

values

values: IValue[]

ListValue values.

Implementation of

IListValue.values

Methods

create

create(properties?): ListValue

Creates a new ListValue instance using the specified properties.

Parameters

NameTypeDescription
properties?IListValueProperties to set

Returns

ListValue

ListValue instance


decode

decode(reader, length?): ListValue

Decodes a ListValue message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ListValue

ListValue

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ListValue

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ListValue

ListValue

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIListValueListValue message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIListValueListValue message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ListValue

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ListValue

ListValue


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListValue

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toJSON

toJSON(): Object

Converts this ListValue to JSON.

Returns

Object

JSON object


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageListValueListValue
options?IConversionOptionsConversion options

Returns

Object

Plain object


verify

verify(message): string

Verifies a ListValue message.

Parameters

NameTypeDescription
messageObjectPlain object to verify

Returns

string

null if valid, otherwise the reason why it is not