penicillin/blue.starry.penicillin.endpoints/Search

Search

class Search(val client: ApiClient) : Endpoint

Collection of api endpoints related to Search API.

Parameters

client

Current ApiClient instance.

Constructors

fun Search(client: ApiClient)

Creates new Search endpoint instance.

Properties

client

open override val client: ApiClient

Extensions

fun Search.search( query: String, geocode: String? = null, lang: String? = null, locale: String? = null, resultType: SearchResultType = SearchResultType.Default, count: Int? = null, until: LocalDate? = null, sinceId: Long? = null, maxId: Long? = null, includeEntities: Boolean? = null, tweetMode: TweetMode = TweetMode.Default, vararg options: Option): JsonObjectApiAction<SearchModel>

Returns a collection of relevant Tweets matching a specified query. Please note that Twitter's search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface. To learn how to use Twitter Search effectively, please see the Standard search operators page for a list of available filter operators. Also, see the Working with Timelines page to learn best practices for navigating results by since_id and max_id.

typeahead

fun Search.typeahead( query: String, tweetMode: TweetMode = TweetMode.Default, vararg options: Option): JsonObjectApiAction<SearchTypeahead>

Undocumented endpoint.

universal

fun Search.universal( query: String, modules: String? = null, resultType: SearchResultType = SearchResultType.Default, tweetMode: TweetMode = TweetMode.Default, vararg options: Option): JsonObjectApiAction<SearchUniversal>