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

Class GetApplicationBoxes

  • public class GetApplicationBoxes
extends Query
    Given an application ID, return boxes in lexographical order by name. If the results must be truncated, a next-token is supplied to continue the request. /v2/applications/{application-id}/boxes

    • Constructor Detail

      • GetApplicationBoxes

        public GetApplicationBoxes​(Client client,
                           Long applicationId)
        Parameters:
        applicationId - An application identifier

    • Method Detail

      • max

        public GetApplicationBoxes max​(Long max)
        Maximum number of boxes to return. Server may impose a lower limit.

      • next

        public GetApplicationBoxes next​(String next)
        A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.

      • prefix

        public GetApplicationBoxes prefix​(String prefix)
        A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

      • 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