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

Class SearchForApplications

java.lang.Object

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

com.algorand.algosdk.v2.client.indexer.SearchForApplications

public class SearchForApplications
extends Query

Search for applications /v2/applications

Field Summary

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

qd

Constructor Summary

Constructors

Constructor	Description
SearchForApplications(Client client)

Method Summary

Modifier and Type	Method	Description
SearchForApplications	applicationId(Long applicationId)	Application ID
SearchForApplications	creator(String creator)	Filter just applications with the given creator address.
Response<ApplicationsResponse>	execute()	Execute the query.
Response<ApplicationsResponse>	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()
SearchForApplications	includeAll(Boolean includeAll)	Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
SearchForApplications	limit(Long limit)	Maximum number of results to return.
SearchForApplications	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

SearchForApplications

public SearchForApplications(Client client)

Method Detail

applicationId

public SearchForApplications applicationId(Long applicationId)

Application ID

creator

public SearchForApplications creator(String creator)

Filter just applications with the given creator address.

includeAll

public SearchForApplications includeAll(Boolean includeAll)

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limit

public SearchForApplications limit(Long limit)

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

next

public SearchForApplications next(String next)

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

execute

public Response<ApplicationsResponse> execute()
                                       throws Exception

Execute the query.

Specified by:

execute in class Query

Returns:

the query response object.

Throws:

Exception

execute

public Response<ApplicationsResponse> 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