Class WaitForSmsConditions

Conditions to apply to emails that you are waiting for

Inheritance

object

WaitForSmsConditions

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "WaitForSmsConditions")]
public class WaitForSmsConditions : IValidatableObject

Constructors

WaitForSmsConditions()

Initializes a new instance of the WaitForSmsConditions class.

Declaration

[JsonConstructor]
protected WaitForSmsConditions()

WaitForSmsConditions(Guid, int?, long, long?, long, bool?, CountTypeEnum?, List<SmsMatchOption>, SortDirectionEnum?, DateTime?, DateTime?)

Initializes a new instance of the WaitForSmsConditions class.

Declaration

public WaitForSmsConditions(Guid phoneNumberId = default, int? limit = null, long count = 0, long? delayTimeout = null, long timeout = 0, bool? unreadOnly = null, WaitForSmsConditions.CountTypeEnum? countType = null, List<SmsMatchOption> matches = null, WaitForSmsConditions.SortDirectionEnum? sortDirection = null, DateTime? since = null, DateTime? before = null)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count. (required).
int?	limit	Limit results.
long	count	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. (required).
long?	delayTimeout	Max time in milliseconds to wait between retries if a timeout is specified..
long	timeout	Max time in milliseconds to retry the waitFor operation until conditions are met. (required).
bool?	unreadOnly	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 you have viewed the SMS in the dashboard..
WaitForSmsConditions.CountTypeEnum?	countType	How result size should be compared with the expected size. Exactly or at-least matching result?.
List<SmsMatchOption>	matches	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..
WaitForSmsConditions.SortDirectionEnum?	sortDirection	Direction to sort matching SMSs by created time.
DateTime?	since	ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date.
DateTime?	before	ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date.

Properties

Before

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

Declaration

[DataMember(Name = "before", EmitDefaultValue = true)]
public DateTime? Before { get; set; }

Property Value

Type	Description
DateTime?	ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date

Count

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.

Declaration

[DataMember(Name = "count", IsRequired = true, EmitDefaultValue = true)]
public long Count { get; set; }

Property Value

Type	Description
long	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.

CountType

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

Declaration

[DataMember(Name = "countType", EmitDefaultValue = true)]
public WaitForSmsConditions.CountTypeEnum? CountType { get; set; }

Property Value

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

DelayTimeout

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

Declaration

[DataMember(Name = "delayTimeout", EmitDefaultValue = true)]
public long? DelayTimeout { get; set; }

Property Value

Type	Description
long?	Max time in milliseconds to wait between retries if a timeout is specified.

Limit

Limit results

Declaration

[DataMember(Name = "limit", EmitDefaultValue = true)]
public int? Limit { get; set; }

Property Value

Type	Description
int?	Limit results

Matches

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.

Declaration

[DataMember(Name = "matches", EmitDefaultValue = true)]
public List<SmsMatchOption> Matches { get; set; }

Property Value

Type	Description
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.

PhoneNumberId

ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.

Declaration

[DataMember(Name = "phoneNumberId", IsRequired = true, EmitDefaultValue = true)]
public Guid PhoneNumberId { get; set; }

Property Value

Type	Description
Guid	ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.

Since

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

Declaration

[DataMember(Name = "since", EmitDefaultValue = true)]
public DateTime? Since { get; set; }

Property Value

Type	Description
DateTime?	ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date

SortDirection

Direction to sort matching SMSs by created time

Declaration

[DataMember(Name = "sortDirection", EmitDefaultValue = true)]
public WaitForSmsConditions.SortDirectionEnum? SortDirection { get; set; }

Property Value

Type	Description
WaitForSmsConditions.SortDirectionEnum?	Direction to sort matching SMSs by created time

Timeout

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

Declaration

[DataMember(Name = "timeout", IsRequired = true, EmitDefaultValue = true)]
public long Timeout { get; set; }

Property Value

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

UnreadOnly

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 you have viewed the SMS in the dashboard.

Declaration

[DataMember(Name = "unreadOnly", EmitDefaultValue = true)]
public bool? UnreadOnly { get; set; }

Property Value

Type	Description
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 you have viewed the SMS in the dashboard.

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject