Class ExportOptions
Options for exporting user data
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "ExportOptions")]
public class ExportOptions : IEquatable<ExportOptions>, IValidatableObject
Constructors
View SourceExportOptions()
Initializes a new instance of the ExportOptions class.
Declaration
[JsonConstructor]
protected ExportOptions()
ExportOptions(OutputFormatEnum, bool?, DateTime?, DateTime?, string, string)
Initializes a new instance of the ExportOptions class.
Declaration
public ExportOptions(ExportOptions.OutputFormatEnum outputFormat = (ExportOptions.OutputFormatEnum)0, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, string filter = null, string listSeparatorToken = null)
Parameters
Type | Name | Description |
---|---|---|
ExportOptions.OutputFormatEnum | outputFormat | outputFormat (required). |
bool? | excludePreviouslyExported | excludePreviouslyExported. |
DateTime? | createdEarliestTime | createdEarliestTime. |
DateTime? | createdOldestTime | createdOldestTime. |
string | filter | filter. |
string | listSeparatorToken | listSeparatorToken. |
Properties
View SourceCreatedEarliestTime
Gets or Sets CreatedEarliestTime
Declaration
[DataMember(Name = "createdEarliestTime", EmitDefaultValue = true)]
public DateTime? CreatedEarliestTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime? |
CreatedOldestTime
Gets or Sets CreatedOldestTime
Declaration
[DataMember(Name = "createdOldestTime", EmitDefaultValue = true)]
public DateTime? CreatedOldestTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime? |
ExcludePreviouslyExported
Gets or Sets ExcludePreviouslyExported
Declaration
[DataMember(Name = "excludePreviouslyExported", EmitDefaultValue = true)]
public bool? ExcludePreviouslyExported { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Filter
Gets or Sets Filter
Declaration
[DataMember(Name = "filter", EmitDefaultValue = true)]
public string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
ListSeparatorToken
Gets or Sets ListSeparatorToken
Declaration
[DataMember(Name = "listSeparatorToken", EmitDefaultValue = true)]
public string ListSeparatorToken { get; set; }
Property Value
Type | Description |
---|---|
string |
OutputFormat
Gets or Sets OutputFormat
Declaration
[DataMember(Name = "outputFormat", IsRequired = true, EmitDefaultValue = true)]
public ExportOptions.OutputFormatEnum OutputFormat { get; set; }
Property Value
Type | Description |
---|---|
ExportOptions.OutputFormatEnum |
Methods
View SourceEquals(ExportOptions)
Returns true if ExportOptions instances are equal
Declaration
public bool Equals(ExportOptions input)
Parameters
Type | Name | Description |
---|---|---|
ExportOptions | input | Instance of ExportOptions to be compared |
Returns
Type | Description |
---|---|
bool | Boolean |
Equals(object)
Returns true if objects are equal
Declaration
public override bool Equals(object input)
Parameters
Type | Name | Description |
---|---|---|
object | input | Object to be compared |
Returns
Type | Description |
---|---|
bool | Boolean |
Overrides
View SourceGetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | Hash code |
Overrides
View SourceToJson()
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
Validate(ValidationContext)
To validate all properties of the instance
Declaration
public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
Parameters
Type | Name | Description |
---|---|---|
ValidationContext | validationContext | Validation context |
Returns
Type | Description |
---|---|
IEnumerable<ValidationResult> | Validation Result |