new Value(opt_dataopt)
Generated by JsPbCodeGenerator.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_data |
Array |
<optional> |
Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid. |
Extends
- jspb.Message
Members
(static) KindCase :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
KIND_NOT_SET |
number | |
NULL_VALUE |
number | |
NUMBER_VALUE |
number | |
STRING_VALUE |
number | |
BOOL_VALUE |
number | |
STRUCT_VALUE |
number | |
LIST_VALUE |
number |
(static) displayName
Methods
clearBoolValue() → (non-null) {proto.google.protobuf.Value}
Clears the field making it undefined.
Returns:
returns this
clearListValue() → (non-null) {proto.google.protobuf.Value}
Clears the message field making it undefined.
Returns:
returns this
clearNullValue() → (non-null) {proto.google.protobuf.Value}
Clears the field making it undefined.
Returns:
returns this
clearNumberValue() → (non-null) {proto.google.protobuf.Value}
Clears the field making it undefined.
Returns:
returns this
clearStringValue() → (non-null) {proto.google.protobuf.Value}
Clears the field making it undefined.
Returns:
returns this
clearStructValue() → (non-null) {proto.google.protobuf.Value}
Clears the message field making it undefined.
Returns:
returns this
getBoolValue() → {boolean}
optional bool bool_value = 4;
Returns:
- Type
- boolean
getKindCase() → {proto.google.protobuf.Value.KindCase}
Returns:
getListValue() → (nullable) {proto.google.protobuf.ListValue}
optional ListValue list_value = 6;
Returns:
getNullValue() → (non-null) {proto.google.protobuf.NullValue}
optional NullValue null_value = 1;
Returns:
getNumberValue() → {number}
optional double number_value = 2;
Returns:
- Type
- number
getStringValue() → {string}
optional string string_value = 3;
Returns:
- Type
- string
getStructValue() → (nullable) {proto.google.protobuf.Struct}
optional Struct struct_value = 5;
Returns:
hasBoolValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasListValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasNullValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasNumberValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasStringValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasStructValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
Serializes the message to binary data (in protobuf wire format).
Returns:
- Type
- Uint8Array
setBoolValue(value) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setListValue(value) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.ListValue | undefined |
Returns:
returns this
setNullValue(valuenon-null) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.NullValue |
Returns:
returns this
setNumberValue(value) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number |
Returns:
returns this
setStringValue(value) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setStructValue(value) → (non-null) {proto.google.protobuf.Value}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.Struct | undefined |
Returns:
returns this
toJavaScript() → (nullable) {proto.google.protobuf.JavaScriptValue}
Converts this Value object to a plain JavaScript value.
Returns:
a plain JavaScript
value representing this Struct.
toObject(opt_includeInstanceopt) → (non-null) {Object}
Creates an object representation of this proto.
Field names that are reserved in JavaScript and will be renamed to pb_name.
Optional fields that are not set will be set to undefined.
To access a reserved field use, foo.pb_, eg, foo.pb_default.
For the list of reserved names please see:
net/proto2/compiler/js/internal/generator.cc#kKeyword.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_includeInstance |
boolean |
<optional> |
Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration |
Returns:
- Type
- Object
(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.Value}
Deserializes binary data (in protobuf wire format).
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.Value}
Deserializes binary data (in protobuf wire format) from the
given reader into the given message object.
Parameters:
| Name | Type | Description |
|---|---|---|
msg |
proto.google.protobuf.Value | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
Returns:
(static) fromJavaScript(valuenon-null) → (non-null) {proto.google.protobuf.Value}
Converts this JavaScript value to a new Value proto.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.JavaScriptValue | The value to convert. |
Returns:
The newly constructed value.
(static) serializeBinaryToWriter(messagenon-null, writernon-null)
Serializes the given message to binary data (in protobuf wire
format), writing to the given BinaryWriter.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
proto.google.protobuf.Value | |
writer |
jspb.BinaryWriter |
(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}
Static version of the {@see toObject} method.
Parameters:
| Name | Type | Description |
|---|---|---|
includeInstance |
boolean | undefined | Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration |
msg |
proto.google.protobuf.Value | The msg instance to transform. |
Returns:
- Type
- Object