goog.proto2.Message

Provided By	`goog.proto2.Message`

Abstract base class for all Protocol Buffer 2 messages. It will be subclassed in the code generated by the Protocol Compiler. Any other subclasses are prohibited.

new Message()

Parameters	None.

VIEW SOURCE

Instance Methods

Adds the given value to the field specified by the given field descriptor. Note that the field must be repeated.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field in which to add the the value.
`value`	`*`
	The new value to add to the field.

VIEW SOURCE

Adds the value to the repeating field indicated by the given tag.

GENERATED CODE USE ONLY. Basis of the add{Field} methods.

Parameters

`tag`	`number`
	The field's tag index.
`value`	`*`
	The value to add.

VIEW SOURCE

Gets the values at the field indicated by the given tag.

GENERATED CODE USE ONLY. Basis of the {field}Array methods.

Parameters

`tag`	`number`
	The field's tag index.

Returns

Array<?>

The values found. If none, returns an empty array.

VIEW SOURCE

Returns the array of values found for the given repeated field.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to return the values.

Returns

Array<?>

The values found.

VIEW SOURCE

Clears the field specified.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field to clear.

VIEW SOURCE

Clears the field specified by tag.

GENERATED CODE USE ONLY. Basis of the clear{Field} methods.

Parameters

`tag`	`number`
	The tag of the field to clear.

VIEW SOURCE

Parameters

None.

Returns

goog.proto2.Message

Recursive clone of the message only including the known fields.

VIEW SOURCE

Recursively copies the known fields from the given message to this message. Removes the fields which are not present in the source message.

Parameters

`message`	`goog.proto2.Message`
	The source message.

VIEW SOURCE

Returns the number of values stored in the field by the given tag.

GENERATED CODE USE ONLY. Basis of the {field}Count methods.

Parameters

`tag`	`number`
	The tag.

Returns

number

The number of values.

VIEW SOURCE

Returns the number of values stored in the given field.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to count the number of values.

Returns

number

The count of the values in the given field.

VIEW SOURCE

Compares this message with another one ignoring the unknown fields.

Parameters

`other`	`?`
	The other message.

Returns

boolean

Whether they are equal. Returns false if the other argument is a different type of message or not a message.

VIEW SOURCE

Iterates over all the unknown fields in the message.

Parameters

`callback`	`function(number, *): ?`
	A callback method which gets invoked for each unknown field.
`opt_scope`	`(T\|null)=`
	The scope under which to execute the callback. If not given, the current message will be used.

VIEW SOURCE

Returns the value stored at the field specified by the given field descriptor.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to get the value.
`opt_index`	`number=`
	If the field is repeated, the index to use when looking up the value.

Returns

The value found or null if none.

VIEW SOURCE

Gets the value at the field indicated by the given tag.

GENERATED CODE USE ONLY. Basis of the get{Field} methods.

Parameters

`tag`	`number`
	The field's tag index.
`opt_index`	`number=`
	If the field is a repeated field, the index at which to get the value.

Returns

The value found or null for none.

VIEW SOURCE

Gets the value at the field indicated by the given tag or the default value if none.

GENERATED CODE USE ONLY. Basis of the get{Field} methods.

Parameters

`tag`	`number`
	The field's tag index.
`opt_index`	`number=`
	If the field is a repeated field, the index at which to get the value.

Returns

The value found or the default value if none set.

VIEW SOURCE

Returns the descriptor which describes the current message.

This only works if we assume people never subclass protobufs.

Parameters

None.

Returns

goog.proto2.Descriptor

The descriptor.

VIEW SOURCE

Returns the value stored at the field specified by the given field descriptor or the default value if none exists.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to get the value.
`opt_index`	`number=`
	If the field is repeated, the index to use when looking up the value.

Returns

The value found or the default if none.

VIEW SOURCE

Returns whether there is a value stored at the field specified by the given field descriptor.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to check if there is a value.

Returns

boolean

True if a value was found.

VIEW SOURCE

Returns the whether or not the field indicated by the given tag has a value.

GENERATED CODE USE ONLY. Basis of the has{Field} methods.

Parameters

`tag`	`number`
	The tag.

Returns

boolean

Whether the message has a value for the field.

VIEW SOURCE

Fills in the protocol buffer with default values. Any fields that are already set will not be overridden.

Parameters

`simpleFieldsToo`	`boolean`
	If true, all fields will be initialized; if false, only the nested messages and groups.

VIEW SOURCE

Initializes the message with a lazy deserializer and its associated data. This method should be called by internal methods ONLY.

Parameters

`deserializer`	`(goog.proto2.LazyDeserializer\|null)`
	The lazy deserializer to use to decode the data on the fly.
`data`	`?`
	The data to decode/deserialize.

VIEW SOURCE

Merges the given message into this message.

Singular fields will be overwritten, except for embedded messages which will be merged. Repeated fields will be concatenated.

Parameters

`message`	`goog.proto2.Message`
	The source message.

VIEW SOURCE

Stores the given value to the field specified by the given field descriptor. Note that the field must not be repeated.

Parameters

`field`	`(goog.proto2.FieldDescriptor\|null)`
	The field for which to set the value.
`value`	`*`
	The new value for the field.

VIEW SOURCE

Sets the value of the non-repeating field indicated by the given tag.

GENERATED CODE USE ONLY. Basis of the set{Field} methods.

Parameters

`tag`	`number`
	The field's tag index.
`value`	`*`
	The field's value.

VIEW SOURCE

Sets the value of an unknown field, by tag.

Parameters

`tag`	`number`
	The tag of an unknown field (must be >= 1).
`value`	`*`
	The value for that unknown field.

VIEW SOURCE

Static Functions

Creates the metadata descriptor representing the definition of this message.

Parameters

`messageType`	`function(new: goog.proto2.Message)`
	Constructor for the message type to which this metadata applies.
`metadataObj`	`Object`
	The object containing the metadata.

Returns

goog.proto2.Descriptor

The new descriptor.

VIEW SOURCE

Enumerations

Message.FieldType

goog.proto2.Message

new Message()

Instance Methods

`this.`add( `field`, `value` ) `→` `void`

`this.`add$Value( `tag`, `value` ) `→` `void`

`this.`array$Values( `tag` ) `→` `Array<?>`

`this.`arrayOf( `field` ) `→` `Array<?>`

`this.`clear( `field` ) `→` `void`

`this.`clear$Field( `tag` ) `→` `void`

`this.`clone() `→` `goog.proto2.Message`

`this.`copyFrom( `message` ) `→` `void`

`this.`count$Values( `tag` ) `→` `number`

`this.`countOf( `field` ) `→` `number`

`this.`equals( `other` ) `→` `boolean`

`this.`forEachUnknown`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`get( `field`, `opt_index` ) `→` `?`

`this.`get$Value( `tag`, `opt_index` ) `→` `?`

`this.`get$ValueOrDefault( `tag`, `opt_index` ) `→` `?`

`this.`getDescriptor() `→` `goog.proto2.Descriptor`

`this.`getOrDefault( `field`, `opt_index` ) `→` `?`

`this.`has( `field` ) `→` `boolean`

`this.`has$Value( `tag` ) `→` `boolean`

`this.`initDefaults( `simpleFieldsToo` ) `→` `void`

`this.`initializeForLazyDeserializer( `deserializer`, `data` ) `→` `void`

`this.`mergeFrom( `message` ) `→` `void`

`this.`set( `field`, `value` ) `→` `void`

`this.`set$Value( `tag`, `value` ) `→` `void`

`this.`setUnknown( `tag`, `value` ) `→` `void`

Static Functions

Message.createDescriptor( `messageType`, `metadataObj` ) `→` `goog.proto2.Descriptor`

Enumerations

goog.proto2.Message

new Message()

Instance Methods

this.add( field, value ) → void

this.add$Value( tag, value ) → void

this.array$Values( tag ) → Array<?>

this.arrayOf( field ) → Array<?>

this.clear( field ) → void

this.clear$Field( tag ) → void

this.clone() → goog.proto2.Message

this.copyFrom( message ) → void

this.count$Values( tag ) → number

this.countOf( field ) → number

this.equals( other ) → boolean

this.forEachUnknown<T>( callback, opt_scope ) → void

this.get( field, opt_index ) → ?

this.get$Value( tag, opt_index ) → ?

this.get$ValueOrDefault( tag, opt_index ) → ?

this.getDescriptor() → goog.proto2.Descriptor

this.getOrDefault( field, opt_index ) → ?

this.has( field ) → boolean

this.has$Value( tag ) → boolean

this.initDefaults( simpleFieldsToo ) → void

this.initializeForLazyDeserializer( deserializer, data ) → void

this.mergeFrom( message ) → void

this.set( field, value ) → void

this.set$Value( tag, value ) → void

this.setUnknown( tag, value ) → void

Static Functions

Message.createDescriptor( messageType, metadataObj ) → goog.proto2.Descriptor

Enumerations

`this.`add( `field`, `value` ) `→` `void`

`this.`add$Value( `tag`, `value` ) `→` `void`

`this.`array$Values( `tag` ) `→` `Array<?>`

`this.`arrayOf( `field` ) `→` `Array<?>`

`this.`clear( `field` ) `→` `void`

`this.`clear$Field( `tag` ) `→` `void`

`this.`clone() `→` `goog.proto2.Message`

`this.`copyFrom( `message` ) `→` `void`

`this.`count$Values( `tag` ) `→` `number`

`this.`countOf( `field` ) `→` `number`

`this.`equals( `other` ) `→` `boolean`

`this.`forEachUnknown`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`get( `field`, `opt_index` ) `→` `?`

`this.`get$Value( `tag`, `opt_index` ) `→` `?`

`this.`get$ValueOrDefault( `tag`, `opt_index` ) `→` `?`

`this.`getDescriptor() `→` `goog.proto2.Descriptor`

`this.`getOrDefault( `field`, `opt_index` ) `→` `?`

`this.`has( `field` ) `→` `boolean`

`this.`has$Value( `tag` ) `→` `boolean`

`this.`initDefaults( `simpleFieldsToo` ) `→` `void`

`this.`initializeForLazyDeserializer( `deserializer`, `data` ) `→` `void`

`this.`mergeFrom( `message` ) `→` `void`

`this.`set( `field`, `value` ) `→` `void`

`this.`set$Value( `tag`, `value` ) `→` `void`

`this.`setUnknown( `tag`, `value` ) `→` `void`

Message.createDescriptor( `messageType`, `metadataObj` ) `→` `goog.proto2.Descriptor`