Relation class
Relation describe the human-interpreted relation type. It may be something like "Date of creation, format=date" or "Assignee, format=objectId, objectType=person"
- Available extensions
Constructors
-
Relation({String? key, RelationFormat? format, String? name, Value? defaultValue, Relation_DataSource? dataSource, bool? readOnly, bool? multi, Iterable<
String> ? objectTypes, Iterable<Relation_Option> ? selectDict, int? maxCount, String? description, bool? readOnlyRelation, Relation_Scope? scope, String? creator, Int64? revision, bool? includeTime, String? id}) -
factory
-
Relation.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- Relation.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- creator ↔ String
-
getter/setter pair
- dataSource ↔ Relation_DataSource
-
getter/setter pair
- defaultValue ↔ Value
-
getter/setter pair
- description ↔ String
-
getter/setter pair
- format ↔ RelationFormat
-
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
-
getter/setter pair
- id ↔ String
-
getter/setter pair
- includeTime ↔ bool
-
getter/setter pair
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - key ↔ String
-
Key under which the value is stored in the map. Must be unique for the object type.
It usually auto-generated bsonid, but also may be something human-readable in case of prebuilt types.
getter/setter pair
- maxCount ↔ int
-
getter/setter pair
- multi ↔ bool
-
getter/setter pair
- name ↔ String
-
getter/setter pair
-
objectTypes
→ PbList<
String> -
no setter
- readOnly ↔ bool
-
getter/setter pair
- readOnlyRelation ↔ bool
-
getter/setter pair
- revision ↔ Int64
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scope ↔ Relation_Scope
-
on-store fields, injected only locally
getter/setter pair
-
selectDict
→ PbList<
Relation_Option> -
index 10, 11 was used in internal-only builds. Can be reused, but may break some test accounts
no setter
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearCreator(
) → void -
clearDataSource(
) → void -
clearDefaultValue(
) → void -
clearDescription(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearFormat(
) → void -
clearHidden(
) → void -
clearId(
) → void -
clearIncludeTime(
) → void -
clearKey(
) → void -
clearMaxCount(
) → void -
clearMulti(
) → void -
clearName(
) → void -
clearReadOnly(
) → void -
clearReadOnlyRelation(
) → void -
clearRevision(
) → void -
clearScope(
) → void -
clone(
) → Relation - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(Relation)) → Relation -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → Relation - 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. -
ensureDefaultValue(
) → Value -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasCreator(
) → bool -
hasDataSource(
) → bool -
hasDefaultValue(
) → bool -
hasDescription(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasFormat(
) → bool -
hasHidden(
) → bool -
hasId(
) → bool -
hasIncludeTime(
) → bool -
hasKey(
) → bool -
hasMaxCount(
) → bool -
hasMulti(
) → bool -
hasName(
) → bool -
hasReadOnly(
) → bool -
hasReadOnlyRelation(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRevision(
) → bool -
hasScope(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
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.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
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
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Relation -
getDefault(
) → Relation