penicillin/blue.starry.penicillin.endpoints.search

Package blue.starry.penicillin.endpoints.search

Types

SearchBucket

enum SearchBucket : Enum<SearchBucket> , EnumRequestParameter

Specifies timeframe to acquire count data.

SearchProduct

enum SearchProduct : Enum<SearchProduct> , EnumRequestParameter

Indicates the search endpoint you are making requests.

SearchResultType

enum SearchResultType : Enum<SearchResultType> , EnumRequestParameter

Specifies what type of search results you would prefer to receive. The current default is "mixed." Valid values include.

Functions

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>

Undocumented endpoint.