getTableItemsMetadata

open suspend override fun getTableItemsMetadata(filter: TableMetadataFilter, sortOrder: List<TableMetadataSortOrder>?, page: PaginationArgs?, minimumLedgerVersion: Long?): Result<GetTableItemsMetadataQuery.Data?, AptosIndexerError>

Queries for the metadata of table items, allowing for filtering and pagination.

Usage

// First, get a table handle from a known resource
val resourceResult = aptos.getAccountResource<SupplyWrapper>(...)
val handle = resourceResult.value.data.supply.vec.first().aggregator.vec.first().handle

// Then, query for the table's metadata
val filter = tableMetadatasFilter { this.handle = stringFilter { eq = handle } }
val resolution = aptos.getTableItemsMetadata(filter = filter)

when (resolution) {
is Result.Ok -> {
val data = resolution.value
println("Successfully retrieved table metadata: $data")
}
is Result.Err -> {
println("Error retrieving table metadata: ${resolution.error.message}")
}
}

Return

A Result which is either Result.Ok containing the query data, or Result.Err containing an AptosIndexerError.

Parameters

filter

Conditions to filter the response.

sortOrder

An optional list of sorting options for the results.

page

Optional pagination arguments (limit and offset).

minimumLedgerVersion

An optional ledger version. The function will wait for the indexer to be at or beyond this version before querying.