Package com.algorand.algosdk.v2.client.algod

Class GetApplicationBoxes

java.lang.Object

com.algorand.algosdk.v2.client.common.Query

com.algorand.algosdk.v2.client.algod.GetApplicationBoxes

public class GetApplicationBoxes
extends Query

Given an application ID, return all box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all box names. Pagination mode is enabled when any of the following parameters are provided: limit, next, prefix, include, or round. In pagination mode box values can be requested and results are returned in sorted order. To paginate: use the next-token from a previous response as the next parameter in the following request. Pin the round parameter to the round value from the first page's response to ensure consistent results across pages. The server enforces a per-response byte limit, so fewer results than limit may be returned even when more exist; the presence of next-token is the only reliable signal that more data is available. /v2/applications/{application-id}/boxes

Field Summary

Fields inherited from class com.algorand.algosdk.v2.client.common.Query

qd

Constructor Summary

Constructors

Constructor	Description
GetApplicationBoxes(Client client, Long applicationId)

Method Summary

Modifier and Type	Method	Description
Response<BoxesResponse>	execute()	Execute the query.
Response<BoxesResponse>	execute(String[] headers, String[] values)	Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.
protected QueryData	getRequestString()
GetApplicationBoxes	include(List<Enums.Include> include)	Include additional items in the response.
GetApplicationBoxes	limit(Long limit)	Maximum number of boxes to return per page.
GetApplicationBoxes	max(Long max)	Max number of box names to return.
GetApplicationBoxes	next(String next)	A box name, in the goal app call arg form 'encoding:value', representing the earliest box name to include in results.
GetApplicationBoxes	prefix(String prefix)	A box name prefix, in the goal app call arg form 'encoding:value', to filter results by.
GetApplicationBoxes	round(BigInteger round)	Return box data from the given round.

Methods inherited from class com.algorand.algosdk.v2.client.common.Query

addPathSegment, addQuery, addToBody, addToBody, baseExecute, baseExecute, getRequestMethod, getRequestUrl, getRequestUrl, resetPathSegment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetApplicationBoxes

public GetApplicationBoxes(Client client,
                           Long applicationId)

Parameters:

applicationId - An application identifier.

Method Detail

include

public GetApplicationBoxes include(List<Enums.Include> include)

Include additional items in the response. Use `values` to include box values. Multiple values can be comma-separated.

limit

public GetApplicationBoxes limit(Long limit)

Maximum number of boxes to return per page.

max

public GetApplicationBoxes max(Long max)

Max number of box names to return. If max is not set, or max == 0, returns all box-names.

next

public GetApplicationBoxes next(String next)

A box name, in the goal app call arg form 'encoding:value', representing the earliest box name to include in results. Use the next-token from a previous response.

prefix

public GetApplicationBoxes prefix(String prefix)

A box name prefix, in the goal app call arg form 'encoding:value', to filter results by. Only boxes whose names start with this prefix will be returned.

round

public GetApplicationBoxes round(BigInteger round)

Return box data from the given round. The round must be within the node's available range.

execute

public Response<BoxesResponse> execute()
                                throws Exception

Execute the query.

Specified by:

execute in class Query

Returns:

the query response object.

Throws:

Exception

execute

public Response<BoxesResponse> execute(String[] headers,
                                       String[] values)
                                throws Exception

Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.

Specified by:

execute in class Query

Parameters:

headers - an array of header keys

values - an array of header values

Returns:

the query response object.

Throws:

Exception

getRequestString

protected QueryData getRequestString()

Specified by:

getRequestString in class Query