getSearch - Methods - Author API

Author API Methods


Gets the current search parameters used in the Item list view or Activity list view.

You would want to use this method so that you can build a custom search history feature in your application, for example.


var searchParameters = authorApp.getSearch();

// Example response:  { "sort": "desc", "sort_field": "updated", "limit": 20 }



Return value

Type object

Properties of the returned search parameters will vary depending on the current view. For instance, Item list view, Activity list view, Item picker view, Intro picker view, or the Outro picker view.

See Building Your Own Author API User Journey Using .navigate() for more information.

Type boolean

Returns false if not searching for an Item or Activity.

Related articles

  • The navigate method, which navigates the Author API to a specified location.
Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.