User class

Represents a full User within the system.

Available extensions

• GeneratedMessageGenericExtensions

Constructors

User({String? entityUuid, EmployeeMetadata? metadata, ApprovalMetadata? approvalMetadata, STANDARD_LIFECYCLE_STATUS? status, Iterable<LogbookLogConciseSLC>? logs, USER_TYPE? userType, Int64? vaultFolderId, String? username, String? code, String? name, Int64? roleId, Int64? mobileRoleId, String? email, String? workEmail, String? phone, String? birthday, String? joiningDate, String? address, String? city, String? state, String? country, String? pinCode, String? bloodGroup, Int64? shiftGroupId, Int64? attendanceUomId, Int64? departmentId, Int64? payrollGroupId, Int64? payrollTaxGroupId, Int64? payrollCurrencyId, Int64? basicPayAmount, Int64? basicPayUomId, bool? mfaStatus, Iterable<FormFieldDatum>? formData})

factory

User.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])

factory

User.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])

factory

Properties

address ↔ String

@description Primary street details, building number, or geographic line matching residential or official mailing location records.

getter/setter pair

approvalMetadata ↔ ApprovalMetadata

@description Detailed approval workflow state (Approver ID, Role, and Timestamps).

getter/setter pair

attendanceUomId ↔ Int64

@description The internal Unit of Measure (UOM) tracking ID used to evaluate time structures, shifts, or active work hour configurations.

getter/setter pair

basicPayAmount ↔ Int64

@description The raw volume integer representing basic salary compensation. Critical: Value must be defined in the minor unit of the currency.

getter/setter pair

basicPayUomId ↔ Int64

@description The internal Unit of Measure (UOM) tracking ID applied to contextualize basic pay duration distributions (e.g., Per Month, Per Annum).

getter/setter pair

birthday ↔ String

@description The calendar date of birth of the user, primarily captured for verification workflows.

getter/setter pair

bloodGroup ↔ String

@description Medical identifier indicating the user's legal ABO blood group for emergency or corporate wellness logs.

getter/setter pair

city ↔ String

@description The explicit city name corresponding to the user's primary residence or workplace assignment.

getter/setter pair

code ↔ String

@description The unique internal enterprise code assigned to the individual, utilized for cross-referencing external platforms.

getter/setter pair

country ↔ String

@description The country code corresponding to the user's operational location.

getter/setter pair

departmentId ↔ Int64

@description The unique internal sequence identifier of the corporate Department or business unit to which the user is structurally assigned.

getter/setter pair

email ↔ String

@description The primary communication or routing email address where structural system notifications are dispatched.

getter/setter pair

entityUuid ↔ String

@description The organization's globally unique identifier.

getter/setter pair

formData → PbList<FormFieldDatum>

@description Collection of organization-specific dynamic data.

no setter

hashCode → int

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

no setter, inherited

info_ → BuilderInfo

no setter

isFrozen → bool

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

no setter, inherited

joiningDate ↔ String

@description The formal start or contract initialization date marking when the individual officially joins the team roster.

getter/setter pair

logs → PbList<LogbookLogConciseSLC>

@description Comprehensive audit trail of every operation performed on this record.

no setter

metadata ↔ EmployeeMetadata

@description Standard employee and record metadata including timestamps.

getter/setter pair

mfaStatus ↔ bool

@description Security flag determining whether Multi-Factor Authentication (MFA) has been explicitly provisioned and enabled for this user account.

getter/setter pair

mobileRoleId ↔ Int64

@description The unique internal identifier of a secondary security role tailored exclusively for mobile application endpoints.

getter/setter pair

name ↔ String

@description The official or full legal name of the user as recognized on statutory documentation.

getter/setter pair

payrollCurrencyId ↔ Int64

@description The internal identifier matching the currency context in which the user's base salary and line compensation amounts are denominated.

getter/setter pair

payrollGroupId ↔ Int64

@description The unique internal identifier of the designated payroll distribution group used for localized batch processing and compensation disbursement.

getter/setter pair

payrollTaxGroupId ↔ Int64

@description The unique internal identifier of the tax matrix or statutory configuration rule governing payroll deductions.

getter/setter pair

phone ↔ String

@description The primary telephone contact or mobile line number assigned to the account profile.

getter/setter pair

pinCode ↔ String

@description The standardized postal index number or geographic ZIP routing code.

getter/setter pair

roleId ↔ Int64

@description The unique internal identifier of the primary web application access or RBAC security role.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shiftGroupId ↔ Int64

@description The unique internal identifier of the operational work shift group mapped to this account profile for scheduling and timecard verification.

getter/setter pair

state ↔ String

@description The administrative territory, province, state, or regional zone of residence.

getter/setter pair

status ↔ STANDARD_LIFECYCLE_STATUS

@description The current lifecycle status (e.g., DRAFT, VERIFIED, STANDING).

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

username ↔ String

@description The unique system-level login alias used by the actor to authenticate against the platform.

getter/setter pair

userType ↔ USER_TYPE

@description The categorical classification of the user entity determining their system scope and behavioral rules.

getter/setter pair

vaultFolderId ↔ Int64

@description Link to the document storage folder.

getter/setter pair

workEmail ↔ String

@description A secondary, fallback, or corporate work email address for overlapping communication loops.

getter/setter pair

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

clearAddress() → void

clearApprovalMetadata() → void

clearAttendanceUomId() → void

clearBasicPayAmount() → void

clearBasicPayUomId() → void

clearBirthday() → void

clearBloodGroup() → void

clearCity() → void

clearCode() → void

clearCountry() → void

clearDepartmentId() → void

clearEmail() → void

clearEntityUuid() → 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

clearJoiningDate() → void

clearMetadata() → void

clearMfaStatus() → void

clearMobileRoleId() → void

clearName() → void

clearPayrollCurrencyId() → void

clearPayrollGroupId() → void

clearPayrollTaxGroupId() → void

clearPhone() → void

clearPinCode() → void

clearRoleId() → void

clearShiftGroupId() → void

clearState() → void

clearStatus() → void

clearUsername() → void

clearUserType() → void

clearVaultFolderId() → void

clearWorkEmail() → void

clone() → User

Creates a deep copy of the fields in this message.

copyWith(void updates(User)) → User

Apply updates to a copy of this message.

createEmptyInstance() → User

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.

ensureApprovalMetadata() → ApprovalMetadata

ensureMetadata() → EmployeeMetadata

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

hasAddress() → bool

hasApprovalMetadata() → bool

hasAttendanceUomId() → bool

hasBasicPayAmount() → bool

hasBasicPayUomId() → bool

hasBirthday() → bool

hasBloodGroup() → bool

hasCity() → bool

hasCode() → bool

hasCountry() → bool

hasDepartmentId() → bool

hasEmail() → bool

hasEntityUuid() → 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

hasJoiningDate() → bool

hasMetadata() → bool

hasMfaStatus() → bool

hasMobileRoleId() → bool

hasName() → bool

hasPayrollCurrencyId() → bool

hasPayrollGroupId() → bool

hasPayrollTaxGroupId() → bool

hasPhone() → bool

hasPinCode() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasRoleId() → bool

hasShiftGroupId() → bool

hasState() → bool

hasStatus() → bool

hasUsername() → bool

hasUserType() → bool

hasVaultFolderId() → bool

hasWorkEmail() → 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 a CodedBufferReader input.

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

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.

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 given CodedBufferWriter.

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() → User

getDefault() → User