Options
All
  • Public
  • Public/Protected
  • All
Menu

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest { Foo some_parameter = 1; PageRequest pagination = 2; }

Hierarchy

  • PageRequest

Index

Properties

countTotal: boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

limit: string

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

offset: string

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

reverse: boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Generated using TypeDoc