WaitForSmsConditions class

Constructors

WaitForSmsConditions({required String phoneNumberId, int? limit, required int count, int? delayTimeout, required int timeout, bool? unreadOnly, WaitForSmsConditionsCountTypeEnum? countType, List<SmsMatchOption>? matches = const [], WaitForSmsConditionsSortDirectionEnum? sortDirection, DateTime? since, DateTime? before})
Returns a new WaitForSmsConditions instance.

Properties

before DateTime?
ISO Date Time latest time of SMS to consider. Filter for matching SMSs 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 WaitForSmsConditionsCountTypeEnum?
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 setteroverride
limit int?
Limit results
getter/setter pair
matches List<SmsMatchOption>?
Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for.
getter/setter pair
phoneNumberId String
ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
since DateTime?
ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date
getter/setter pair
sortDirection WaitForSmsConditionsSortDirectionEnum?
Direction to sort matching SMSs 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 SMS. All SMS messages begin with read=false. An SMS is marked read=true when an SMS has been returned to the user at least once. For example you have called getSms or waitForSms etc., or you have viewed the SMS 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) WaitForSmsConditions?
Returns a new WaitForSmsConditions instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) List<WaitForSmsConditions>
mapFromJson(dynamic json) Map<String, WaitForSmsConditions>
mapListFromJson(dynamic json, {bool growable = false}) Map<String, List<WaitForSmsConditions>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.