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. /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	max(Long max)	Max number of box names to return.

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

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.

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