penicillin/blue.starry.penicillin.endpoints/SavedSearches

SavedSearches

class SavedSearches(val client: ApiClient) : Endpoint
Content copied to clipboard

Collection of api endpoints related to saved searches.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun SavedSearches(client: ApiClient)
Content copied to clipboard

Creates new SavedSearches endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient
Content copied to clipboard

Extensions

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

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>
Content copied to clipboard

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
val SavedSearches.list: JsonArrayApiAction<SavedSearch>
Content copied to clipboard

Shorthand property to SavedSearches.list.

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

Returns the authenticated user's saved search queries.

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

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.