ozone/app.bsky.feed/SearchPostsQueryParams

SearchPostsQueryParams

@Serializable
data class SearchPostsQueryParams(val q: String, val sort: SearchPostsSort? = SearchPostsSort.LATEST, val since: String? = null, val until: String? = null, val mentions: AtIdentifier? = null, val author: AtIdentifier? = null, val lang: Language? = null, val domain: String? = null, val url: Uri? = null, val tag: ReadOnlyList<String> = persistentListOf(), val limit: Long? = 25, val cursor: String? = null)

Constructors

Link copied to clipboard
constructor(q: String, sort: SearchPostsSort? = SearchPostsSort.LATEST, since: String? = null, until: String? = null, mentions: AtIdentifier? = null, author: AtIdentifier? = null, lang: Language? = null, domain: String? = null, url: Uri? = null, tag: ReadOnlyList<String> = persistentListOf(), limit: Long? = 25, cursor: String? = null)

Properties

Link copied to clipboard
val author: AtIdentifier? = null

Filter to posts by the given account. Handles are resolved to DID before query-time.

Link copied to clipboard
val cursor: String? = null

Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

Link copied to clipboard
val domain: String? = null

Filter to posts with URLs (facet links or embeds) linking to the given domain (hostname). Server may apply hostname normalization.

Link copied to clipboard
val lang: Language? = null

Filter to posts in the given language. Expected to be based on post language field, though server may override language detection.

Link copied to clipboard
val limit: Long? = 25
Link copied to clipboard
val mentions: AtIdentifier? = null

Filter to posts which mention the given account. Handles are resolved to DID before query-time. Only matches rich-text facet mentions.

Link copied to clipboard
val q: String

Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

Link copied to clipboard
val since: String? = null

Filter results for posts after the indicated datetime (inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYYY-MM-DD).

Link copied to clipboard
val sort: SearchPostsSort?

Specifies the ranking order of results.

Link copied to clipboard
val tag: ReadOnlyList<String>

Filter to posts with the given tag (hashtag), based on rich-text facet or tag field. Do not include the hash (#) prefix. Multiple tags can be specified, with 'AND' matching.

Link copied to clipboard
val until: String? = null

Filter results for posts before the indicated datetime (not inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYY-MM-DD).

Link copied to clipboard
val url: Uri? = null

Filter to posts with links (facet links or embeds) pointing to this URL. Server may apply URL normalization or fuzzy matching.

Functions

Link copied to clipboard