WaitForConditions class

Constructors

WaitForConditions({required String inboxId, int? count, int? delayTimeout, required int timeout, bool? unreadOnly, WaitForConditionsCountTypeEnum? countType, List<MatchOption>? matches = const [], WaitForConditionsSortDirectionEnum? sortDirection, DateTime? since, DateTime? before})

Returns a new WaitForConditions instance.

Properties

before ↔ DateTime?

ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date

getter/setter pair

count ↔ int?

Number of results that should match conditions. Either exactly or at least this amount based on the countType. If count condition is not met and the timeout has not been reached the waitFor method will retry the operation.

getter/setter pair

countType ↔ WaitForConditionsCountTypeEnum?

How result size should be compared with the expected size. Exactly or at-least matching result?

getter/setter pair

delayTimeout ↔ int?

Max time in milliseconds to wait between retries if a timeout is specified.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

inboxId ↔ String

ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.

getter/setter pair

matches ↔ List<MatchOption>?

Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

since ↔ DateTime?

ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date

getter/setter pair

sortDirection ↔ WaitForConditionsSortDirectionEnum?

Direction to sort matching emails by created time

getter/setter pair

timeout ↔ int

Max time in milliseconds to retry the waitFor operation until conditions are met.

getter/setter pair

unreadOnly ↔ bool?

Apply conditions only to unread emails. All emails begin with read=false. An email is marked read=true when an EmailDto representation of it has been returned to the user at least once. For example you have called getEmail or waitForLatestEmail etc., or you have viewed the email in the dashboard.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → WaitForConditions?

Returns a new WaitForConditions instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<WaitForConditions>

mapFromJson(dynamic json) → Map<String, WaitForConditions>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<WaitForConditions>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.