LinkEventMetadata class

The metadata object for the onEvent callback

Constructors

LinkEventMetadata({String viewName, String exitStatus, String mfaType, String requestId, String timestamp, String linkSessionId, String institutionName, String institutionId, String institutionSearchQuery, String errorType, String errorCode, String errorMesssage})

Properties

errorCode → String
The error code that the user encountered. Emitted by: ERROR, EXIT.
final
errorMesssage → 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. [...]
read-only, 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
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
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
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
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 non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited