GeneratedMessage class abstract

The base class for all protobuf message types.

The protoc plugin generates subclasses providing type-specific properties and methods.

Public properties and methods added here should also be added to GeneratedMessage_reservedNames and should be unlikely to be used in a proto file.

Implementers

• Access
• AccessFull
• AccessLimited
• Address
• AppMinVersionRequest
• AppMinVersionResponse
• ApproveDeviceRequest
• ArticleBasketOnTicketPb
• ArticleBasketPb
• ArticleId
• ArticlePhotoMongo
• ArticlePhotoPb
• ArticleRetailOnTicketPb
• ArticleRetailPb
• ArticleRights
• ArticleUncountableOnTicketPb
• ArticleUncountablePb
• BillingRights
• BoolRights
• BoutiqueIds
• BoutiqueIndexAndDeviceIndex
• BoutiqueMongo
• BoutiquePb
• BoutiqueRequest
• BoutiqueResponse
• BoutiqueRights
• CalibreMongo
• CalibrePb
• CalibreRequest
• CalibresIdsResponse
• CalibresRequest
• CalibresResponse
• CategoriesResponse
• CategoryMongo
• CategoryPb
• CategoryRequest
• Chain
• ChainIdAndboutiqueId
• ChainIds
• ChainRequest
• ChainRights
• Chains
• CodeForPairingDevice
• ContactMongo
• ContactPb
• ContactRequest
• ContactRights
• ContactsIdsResponse
• ContactsRequest
• ContactsResponse
• Counterfoil
• Country
• CreateDeviceResponse
• CreateFirmRequest
• CreateFirmResponse
• Credentials
• DeleteDeviceRequest
• Device
• DeviceCredentials
• Devices
• Empty
• FindCategoryRequest
• FindPhotoRequest
• FindTicketRequest
• Firm
• FirmRights
• HardwareInfo
• HealthCheckResponse
• HealthCheckWeebiResponse
• IsADeviceInChainResponse
• ItemCartPb
• MailAndEncyptedPassword
• PasswordResetConfirmRequest
• PasswordResetRequest
• PasswordUpdateRequest
• PendingDeviceRequest
• PendingUserRequest
• PendingUserResponse
• Phone
• PhotoRequest
• PhotosRequest
• PhotosResponse
• ProxyArticlePb
• ProxyArticleWorthPb
• ReadAllBoutiquesResponse
• ReadAllChainsResponse
• ReadAllContactsRequest
• ReadAllRequest
• ReadAllTicketsRequest
• ReadCalibreRequest
• ReadCategoriesRequest
• ReadContactRequest
• ReadContactsIdsRequest
• ReadDeviceBtqRequest
• ReadDevicesRequest
• ReadIdsRequest
• ReadOneUserResponse
• ReadPhotosRequest
• RefreshToken
• ServiceVersions
• SignUpRequest
• SignUpResponse
• StatusResponse
• TaxPb
• TicketMongo
• TicketPb
• TicketRequest
• TicketRights
• TicketsRequest
• TicketsResponse
• Timestamp
• Tokens
• UpdateDevicePasswordRequest
• UserId
• UserManagementRights
• UserPermissions
• UserPrivate
• UserPublic
• UsersPublic

Available extensions

• GeneratedMessageGenericExtensions

Constructors

GeneratedMessage()

Properties

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, override

info_ → BuilderInfo

no setter

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

unknownFields → UnknownFieldSet

no setter

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

check() → void

Throws a StateError if the message has required fields without a value.

clear() → void

Clears all data that was set in this message.

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

clearField(int tagNumber) → void

Clears the contents of a given field.

clone() → GeneratedMessage

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

copyWith(void updates(GeneratedMessage)) → GeneratedMessage

Apply updates to a copy of this message.

createEmptyInstance() → GeneratedMessage

Creates an empty instance of the same message type as this.

deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.

extensionsAreInitialized() → bool

freeze() → GeneratedMessage

Make this message read-only.

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

getExtension(Extension extension) → dynamic

Returns the value of extension.

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

getTagNumber(String fieldName) → int?

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

hasRequiredFields() → bool

Whether the message has required fields.

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Same as mergeFromBuffer, but takes a CodedBufferReader input.

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

toDebugString() → String

Returns a String representation of this message.

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

toString() → String

Returns a String representation of this message.

override

writeToBuffer() → Uint8List

Serialize the message as the protobuf binary format.

writeToCodedBufferWriter(CodedBufferWriter output) → void

Same as writeToBuffer, but serializes to the given CodedBufferWriter.

writeToJson() → String

Returns a JSON string that encodes this message.

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

Operators

operator ==(Object other) → bool

The equality operator.

override