Class PageableObject

PageableObject

Inheritance
object
PageableObject
Implements
System.ComponentModel.DataAnnotations.IValidatableObject
Inherited Members
object.Equals(object, object)
object.MemberwiseClone()
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "PageableObject")]
public class PageableObject : IEquatable<PageableObject>, IValidatableObject

Constructors

View Source

PageableObject(int, int, bool, bool, long, SortObject)

Initializes a new instance of the PageableObject class.

Declaration
public PageableObject(int pageNumber = 0, int pageSize = 0, bool unpaged = false, bool paged = false, long offset = 0, SortObject sort = null)
Parameters
Type Name Description
int pageNumber

pageNumber.
int pageSize

pageSize.
bool unpaged

unpaged.
bool paged

paged.
long offset

offset.
SortObject sort

sort.

Properties

View Source

Offset

Gets or Sets Offset

Declaration
[DataMember(Name = "offset", EmitDefaultValue = false)]
public long Offset { get; set; }
Property Value
Type Description
long
View Source

Paged

Gets or Sets Paged

Declaration
[DataMember(Name = "paged", EmitDefaultValue = true)]
public bool Paged { get; set; }
Property Value
Type Description
bool
View Source

PageNumber

Gets or Sets PageNumber

Declaration
[DataMember(Name = "pageNumber", EmitDefaultValue = false)]
public int PageNumber { get; set; }
Property Value
Type Description
int
View Source

PageSize

Gets or Sets PageSize

Declaration
[DataMember(Name = "pageSize", EmitDefaultValue = false)]
public int PageSize { get; set; }
Property Value
Type Description
int
View Source

Sort

Gets or Sets Sort

Declaration
[DataMember(Name = "sort", EmitDefaultValue = false)]
public SortObject Sort { get; set; }
Property Value
Type Description
SortObject
View Source

Unpaged

Gets or Sets Unpaged

Declaration
[DataMember(Name = "unpaged", EmitDefaultValue = true)]
public bool Unpaged { get; set; }
Property Value
Type Description
bool

Methods

View Source

Equals(PageableObject)

Returns true if PageableObject instances are equal

Declaration
public bool Equals(PageableObject input)
Parameters
Type Name Description
PageableObject input

Instance of PageableObject to be compared
Returns
Type Description
bool

Boolean
View Source

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 Source

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
Type Description
int

Hash code
Overrides
View Source

ToJson()

Returns the JSON string presentation of the object

Declaration
public virtual string ToJson()
Returns
Type Description
string

JSON string presentation of the object
View Source

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()
View Source

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

Implements

System.ComponentModel.DataAnnotations.IValidatableObject