Class: Any

Any(opt_dataopt)

new Any(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.
Source:

Extends

  • jspb.Message

Members

(static) displayName

Source:

Methods

getTypeName() → {string|undefined}

Returns the type name contained in this instance, if any.
Source:
Returns:
Type
string | undefined

getTypeUrl() → {string}

optional string type_url = 1;
Source:
Returns:
Type
string

getValue() → {string}

optional bytes value = 2;
Source:
Returns:
Type
string

getValue_asB64() → {string}

optional bytes value = 2; This is a type-conversion wrapper around `getValue()`
Source:
Returns:
Type
string

getValue_asU8() → (non-null) {Uint8Array}

optional bytes value = 2; Note that Uint8Array is not supported on all browsers.
Source:
See:
Returns:
Type
Uint8Array

pack(serializednon-null, name, opt_typeUrlPrefixopt)

Packs the given message instance into this Any. For binary format usage only.
Parameters:
Name Type Attributes Description
serialized Uint8Array The serialized data to pack.
name string The type name of this message object.
opt_typeUrlPrefix string <optional>
 the type URL prefix.
Source:

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setTypeUrl(value) → (non-null) {proto.google.protobuf.Any}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.google.protobuf.Any

setValue(valuenon-null) → (non-null) {proto.google.protobuf.Any}

Parameters:
Name Type Description
value string | Uint8Array
Source:
Returns:
returns this
Type
proto.google.protobuf.Any

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
Source:
Returns:
Type
Object

unpack(deserialize, name) → (nullable) {T}

Parameters:
Name Type Description
deserialize function Function that will deserialize the binary data properly.
name string The expected type name of this message object.
Source:
Returns:
If the name matched the expected name, returns the deserialized object, otherwise returns null.
Type
T

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.Any}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.google.protobuf.Any

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.Any}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.google.protobuf.Any The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.google.protobuf.Any

(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.Any
writer jspb.BinaryWriter
Source:

(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.Any The msg instance to transform.
Source:
Returns:
Type
Object