host.anzo.eossdk.eos.sdk.common

Class EOS_PageQuery

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.common.EOS_PageQuery

Direct Known Subclasses:

EOS_PageQuery.ByReference, EOS_PageQuery.ByValue

@Structure.FieldOrder(value={"ApiVersion","StartIndex","MaxCount"})
public class EOS_PageQuery
extends com.sun.jna.Structure

A page query is part of query options. It is used to allow pagination of query results.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_PageQuery.ByReference
static class	EOS_PageQuery.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_PAGEQUERY_API_LATEST.
static int	EOS_PAGEQUERY_API_LATEST API Version: Set this to EOS_PAGEQUERY_API_LATEST.
static int	EOS_PAGEQUERY_MAXCOUNT_DEFAULT The default MaxCount used for a EOS_PageQuery when the API allows the EOS_PageQuery to be omitted.
static int	EOS_PAGEQUERY_MAXCOUNT_MAXIMUM The maximum MaxCount used for a EOS_PageQuery.
int	MaxCount The maximum number of results to have in the page.
int	StartIndex The index into the ordered query results to start the page at.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_PageQuery()
EOS_PageQuery(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_PAGEQUERY_API_LATEST

public static int EOS_PAGEQUERY_API_LATEST

API Version: Set this to EOS_PAGEQUERY_API_LATEST.

EOS_PAGEQUERY_MAXCOUNT_DEFAULT

public static int EOS_PAGEQUERY_MAXCOUNT_DEFAULT

The default MaxCount used for a EOS_PageQuery when the API allows the EOS_PageQuery to be omitted.

EOS_PAGEQUERY_MAXCOUNT_MAXIMUM

public static int EOS_PAGEQUERY_MAXCOUNT_MAXIMUM

The maximum MaxCount used for a EOS_PageQuery.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_PAGEQUERY_API_LATEST.

StartIndex

public int StartIndex

The index into the ordered query results to start the page at.

MaxCount

public int MaxCount

The maximum number of results to have in the page.

Constructor Detail

EOS_PageQuery

public EOS_PageQuery()

EOS_PageQuery

public EOS_PageQuery(com.sun.jna.Pointer peer)