Package com.algorand.algosdk.v2.client.indexer

Class SearchForApplicationBoxes

java.lang.Object

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

com.algorand.algosdk.v2.client.indexer.SearchForApplicationBoxes

public class SearchForApplicationBoxes
extends Query

Given an application ID, returns the box names of that application sorted lexicographically. /v2/applications/{application-id}/boxes

Field Summary

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

qd

Constructor Summary

Constructors

Constructor	Description
SearchForApplicationBoxes(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()
SearchForApplicationBoxes	limit(Long limit)	Maximum number of results to return.
SearchForApplicationBoxes	next(String next)	The next page of results.

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

SearchForApplicationBoxes

public SearchForApplicationBoxes(Client client,
                                 Long applicationId)

Parameters:

applicationId -

Method Detail

limit

public SearchForApplicationBoxes limit(Long limit)

Maximum number of results to return. There could be additional pages even if the limit is not reached.

next

public SearchForApplicationBoxes next(String next)

The next page of results. Use the next token provided by the previous results.

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