Class: MessageOptions

MessageOptions(opt_dataopt)

new MessageOptions(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:

(static, non-null) extensions :Object.<number, jspb.ExtensionFieldInfo>

The extensions registered with this message class. This is a map of extension field number to fieldInfo object. For example: { 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, ctor: proto.example.MyMessage} } fieldName contains the JsCompiler renamed field name property so that it works in OPTIMIZED mode.
Type:
  • Object.<number, jspb.ExtensionFieldInfo>
Source:

(static, non-null) extensionsBinary :Object.<number, jspb.ExtensionFieldBinaryInfo>

The extensions registered with this message class. This is a map of extension field number to fieldInfo object. For example: { 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, ctor: proto.example.MyMessage} } fieldName contains the JsCompiler renamed field name property so that it works in OPTIMIZED mode.
Type:
  • Object.<number, jspb.ExtensionFieldBinaryInfo>
Source:

Methods

addUninterpretedOption(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:
Name Type Attributes Description
opt_value proto.google.protobuf.UninterpretedOption <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.google.protobuf.UninterpretedOption

clearDeprecated() → (non-null) {proto.google.protobuf.MessageOptions}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

clearMapEntry() → (non-null) {proto.google.protobuf.MessageOptions}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

clearMessageSetWireFormat() → (non-null) {proto.google.protobuf.MessageOptions}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

clearNoStandardDescriptorAccessor() → (non-null) {proto.google.protobuf.MessageOptions}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

clearUninterpretedOptionList() → (non-null) {proto.google.protobuf.MessageOptions}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

getDeprecated() → {boolean}

optional bool deprecated = 3;
Source:
Returns:
Type
boolean

getMapEntry() → {boolean}

optional bool map_entry = 7;
Source:
Returns:
Type
boolean

getMessageSetWireFormat() → {boolean}

optional bool message_set_wire_format = 1;
Source:
Returns:
Type
boolean

getNoStandardDescriptorAccessor() → {boolean}

optional bool no_standard_descriptor_accessor = 2;
Source:
Returns:
Type
boolean

getUninterpretedOptionList() → (non-null) {Array.<!proto.google.protobuf.UninterpretedOption>}

repeated UninterpretedOption uninterpreted_option = 999;
Source:
Returns:
Type
Array.<!proto.google.protobuf.UninterpretedOption>

hasDeprecated() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasMapEntry() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasMessageSetWireFormat() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasNoStandardDescriptorAccessor() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

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

setDeprecated(value) → (non-null) {proto.google.protobuf.MessageOptions}

Parameters:
Name Type Description
value boolean
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

setMapEntry(value) → (non-null) {proto.google.protobuf.MessageOptions}

Parameters:
Name Type Description
value boolean
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

setMessageSetWireFormat(value) → (non-null) {proto.google.protobuf.MessageOptions}

Parameters:
Name Type Description
value boolean
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

setNoStandardDescriptorAccessor(value) → (non-null) {proto.google.protobuf.MessageOptions}

Parameters:
Name Type Description
value boolean
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

setUninterpretedOptionList(valuenon-null) → (non-null) {proto.google.protobuf.MessageOptions}

Parameters:
Name Type Description
value Array.<!proto.google.protobuf.UninterpretedOption>
Source:
Returns:
returns this
Type
proto.google.protobuf.MessageOptions

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

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

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

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

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

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