LinkEventMetadata class

The metadata object for the onEvent callback

Constructors

LinkEventMetadata({required String? viewName, required String? exitStatus, required String? mfaType, required String? requestId, required String timestamp, required String linkSessionId, required String? institutionName, required String? institutionId, required String? institutionSearchQuery, required String? errorType, required String? errorCode, required String? errorMessage, required String? selection, required String? routingNumber, required String? matchReason, required String? accountNumberMask, required String? isUpdateMode})

LinkEventMetadata.fromJson(dynamic json)

factory

Properties

accountNumberMask → String?

The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, account_number_mask is empty. Emitted by SUBMIT_ACCOUNT_NUMBER

final

errorCode → String?

The error code that the user encountered. Emitted by: ERROR, EXIT.

final

errorMessage → String?

The error message that the user encountered. Emitted by: ERROR, EXIT.

final

errorType → String?

The error type that the user encountered. Emitted by: ERROR, EXIT.

final

exitStatus → String?

The status key indicates the point at which the user exited the Link flow. Emitted by: EXIT.

final

hashCode → int

The hash code for this object.

no setter, inherited

institutionId → String?

The ID of the selected institution. Emitted by: all events.

final

institutionName → String?

The name of the selected institution. Emitted by: all events.

final

institutionSearchQuery → String?

The query used to search for institutions. Emitted by: SEARCH_INSTITUTION.

final

isUpdateMode → String?

Indicates if the current Link session is an update mode session. Emitted by: OPEN.

final

linkSessionId → String

The link_session_id is a unique identifier for a single session of Link. It's always available and will stay constant throughout the flow. Emitted by: all events.

final

matchReason → String?

The reason this institution was matched, which will be either returning_user or routing_number. Emitted by: matchedSelectInstitution.

final

mfaType → String?

If set, the user has encountered one of the following MFA types: code, device, questions, selections. Emitted by: SUBMIT_MFA and TRANSITION_VIEW when view_name is MFA.

final

requestId → String?

The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events.

final

routingNumber → String?

The routing number submitted by user at the micro-deposits routing number pane. Emitted by SUBMIT_ROUTING_NUMBER.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selection → String?

Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are phoneotp or password; if selection is used to describe the selected Auth Type Select flow, then possible values are flow_type_manual or flow_type_instant. Emitted by: MATCHED_SELECT_VERIFY_METHOD and SELECT_AUTH_TYPE.

final

timestamp → String

An ISO 8601 representation of when the event occurred. For example 2017-09-14T14:42:19.350Z. Emitted by: all events.

final

viewName → String?

The name of the view that is being transitioned to. Emitted by: TRANSITION_VIEW.

final

Methods

description() → String

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited