Package blue.starry.penicillin.endpoints.savedsearches

Functions

Link copied to clipboard
fun SavedSearches.create(query: String, vararg options: Option): JsonObjectApiAction<SavedSearch>

Create a new saved search for the authenticated user. A user may only have 25 saved searches.

Link copied to clipboard
fun SavedSearches.delete(id: Long, vararg options: Option): JsonObjectApiAction<SavedSearch>

Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed.

Link copied to clipboard
fun SavedSearches.list(vararg options: Option): JsonArrayApiAction<SavedSearch>

Returns the authenticated user's saved search queries.

Link copied to clipboard
fun SavedSearches.show(id: Long, vararg options: Option): JsonObjectApiAction<SavedSearch>

Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested.

Properties

Link copied to clipboard
val SavedSearches.list: JsonArrayApiAction<SavedSearch>

Shorthand property to SavedSearches.list.