SearchParams

public struct SearchParams : Sendable

The search parameters.

  • The search query.

    Declaration

    Swift

    public var query: String

  • Specify whether to search for only specific type.

    Declaration

    Swift

    public var type: SearchType?

  • Attempt WebFinger lookup? Defaults to false.

    Declaration

    Swift

    public var resolve: Bool?

  • Only include accounts that the user is following? Defaults to false.

    Declaration

    Swift

    public var following: Bool?

  • If provided, will only return posts authored by this account.

    Declaration

    Swift

    public var accountId: Account.ID?

  • Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.

    Declaration

    Swift

    public var excludeUnreviewed: Bool?

  • The search parameters.

    Declaration

    Swift

    public init(
    query: String,
    type: SearchType? = nil,
    resolve: Bool? = nil,
    following: Bool? = nil,
    accountId: Account.ID? = nil,
    excludeUnreviewed: Bool? = nil
)

    Parameters

    query

    The search query.
    type

    Specify whether to search for only specific type.
    resolve

    Attempt WebFinger lookup? Defaults to false.
    following

    Only include accounts that the user is following? Defaults to false.
    accountId

    If provided, will only return posts authored by this account.
    excludeUnreviewed

    Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.

  • Undocumented

    See more

    Declaration

    Swift

    public enum SearchType : String, Sendable