Class PaginationProperties<T>

Namespace

NetCord.Rest

Assembly

NetCord.dll

public record PaginationProperties<T> : IEquatable<PaginationProperties<T>> where T : struct

Type Parameters

T

Inheritance

object

PaginationProperties<T>

Implements

IEquatable<PaginationProperties<T>>

Derived

EntitlementsPaginationProperties

GuildAuditLogPaginationProperties

GuildMessagesSearchPaginationProperties

GuildUsersSearchPaginationProperties

GuildsPaginationProperties

MessageReactionsPaginationProperties

OptionalGuildUsersPaginationProperties

SubscriptionPaginationProperties

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PaginationProperties()

public PaginationProperties()

PaginationProperties(PaginationProperties<T>)

protected PaginationProperties(PaginationProperties<T> original)

Parameters

original PaginationProperties<T>

Properties

BatchSize

The maximum number of items to retrieve in a single request.

public int? BatchSize { get; set; }

Property Value

int?

Direction

The direction of pagination.

public PaginationDirection? Direction { get; set; }

Property Value

PaginationDirection?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

From

The starting point for pagination.

public T? From { get; set; }

Property Value

T?

Methods

Equals(PaginationProperties<T>?)

public virtual bool Equals(PaginationProperties<T>? other)

Parameters

other PaginationProperties<T>

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

WithBatchSize(int?)

The maximum number of items to retrieve in a single request.

public PaginationProperties<T> WithBatchSize(int? batchSize)

Parameters

batchSize int?

Returns

PaginationProperties<T>

WithDirection(PaginationDirection?)

The direction of pagination.

public PaginationProperties<T> WithDirection(PaginationDirection? direction)

Parameters

direction PaginationDirection?

Returns

PaginationProperties<T>

WithFrom(T?)

The starting point for pagination.

public PaginationProperties<T> WithFrom(T? from)

Parameters

from T?

Returns

PaginationProperties<T>

Operators

operator ==(PaginationProperties<T>?, PaginationProperties<T>?)

public static bool operator ==(PaginationProperties<T>? left, PaginationProperties<T>? right)

Parameters

left PaginationProperties<T>

right PaginationProperties<T>

Returns

bool

operator !=(PaginationProperties<T>?, PaginationProperties<T>?)

public static bool operator !=(PaginationProperties<T>? left, PaginationProperties<T>? right)

Parameters

left PaginationProperties<T>

right PaginationProperties<T>

Returns

bool