Package com.podio.search

Class SearchAPI

java.lang.Object

com.podio.BaseAPI

com.podio.search.SearchAPI

public class SearchAPI
extends BaseAPI

This API makes it possible to search across Podio.

Constructor Summary

Constructors

Constructor	Description
SearchAPI(ResourceFactory resourceFactory)

Method Summary

Modifier and Type	Method	Description
SearchInAppResponse	searchInApp(int appId, String query, Boolean counts, Boolean highlights, Integer limit, Integer offset, ReferenceTypeSearchInApp refType, String searchFields)	Searches in all items, files, and tasks in the application.

Methods inherited from class com.podio.BaseAPI

getResourceFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAPI

public SearchAPI(ResourceFactory resourceFactory)

Method Detail

searchInApp

public SearchInAppResponse searchInApp(int appId,
                                       String query,
                                       Boolean counts,
                                       Boolean highlights,
                                       Integer limit,
                                       Integer offset,
                                       ReferenceTypeSearchInApp refType,
                                       String searchFields)

Searches in all items, files, and tasks in the application. The objects will be returned sorted descending by the time the object had any update.

Parameters:

appId - The id of the app to be searched in

query - The text to search for

limit - The number of results to return; up to 20 results are returned in one call.

offset - The rank of the first search result to return (default=0)

refType - The type of objects to search for

counts - True if the total counts should be returned

highlights - True if the highlights for each result should be returned, false otherwise.

searchFields - The list of fields to search in. Can f.ex. be used to limit the search to the "title" field.

Returns:

All items