DateTime class

Represents civil time (or occasionally physical time).

This type can represent a civil time in one of a few possible ways:

When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time.

The date is relative to the Proleptic Gregorian Calendar.

If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values.

This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field.

This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

Inheritance

Object
GeneratedMessage
DateTime

Constructors

DateTime.new({int? year, int? month, int? day, int? hours, int? minutes, int? seconds, int? nanos, Duration? utcOffset, TimeZone? timeZone}): factory
DateTime.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]): factory
DateTime.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]): factory

Properties

day ↔ int: Required. Day of month. Must be from 1 to 31 and valid for the year and month.
getter/setter pair
eventPlugin → EventPlugin?: Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
hours ↔ int: Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
getter/setter pair
info_ → BuilderInfo: no setteroverride
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
minutes ↔ int: Required. Minutes of hour of day. Must be from 0 to 59.
getter/setter pair
month ↔ int: Required. Month of year. Must be from 1 to 12.
getter/setter pair
nanos ↔ int: Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
seconds ↔ int: Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
getter/setter pair
timeZone ↔ TimeZone: Time zone.
getter/setter pair
unknownFields → UnknownFieldSet: no setterinherited
utcOffset ↔ Duration: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
getter/setter pair
year ↔ int: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void: Adds an extension field value to a repeated field.
inherited
check() → void: inherited
clear() → void: Clears all data that was set in this message.
inherited
clearDay() → 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
clearHours() → void
clearMinutes() → void
clearMonth() → void
clearNanos() → void
clearSeconds() → void
clearTimeOffset() → void
clearTimeZone() → void
clearUtcOffset() → void
clearYear() → void
clone() → DateTime: Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(DateTime)) → DateTime: Apply updates to a copy of this message.
override
createEmptyInstance() → DateTime: Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>: Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>: Creates List implementing a mutable repeated field.
inherited
ensureTimeZone() → TimeZone
ensureUtcOffset() → Duration
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
hasDay() → bool
hasExtension(Extension extension) → bool: Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool: Whether this message has a field associated with tagNumber.
inherited
hasHours() → bool
hasMinutes() → bool
hasMonth() → bool
hasNanos() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasSeconds() → bool
hasTimeZone() → bool
hasUtcOffset() → bool
hasYear() → 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: inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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 other into 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
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
whichTimeOffset() → DateTime_TimeOffset
writeToBuffer() → Uint8List: inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void: 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() → DateTime
createRepeated() → PbList<DateTime>
getDefault() → DateTime