46 lines
1.0 KiB
Elixir
46 lines
1.0 KiB
Elixir
defmodule Hunter.Result do
|
|
@moduledoc """
|
|
Result entity
|
|
|
|
## Fields
|
|
|
|
* `accounts` - list of matched `Hunter.Account`
|
|
* `statuses` - list of matched `Hunter.Status`
|
|
* `hashtags` - list of matched hashtags, as strings
|
|
|
|
"""
|
|
alias Hunter.Config
|
|
|
|
@type t :: %__MODULE__{
|
|
accounts: [Hunter.Account.t()],
|
|
statuses: [Hunter.Status.t()],
|
|
hashtags: [String.t()]
|
|
}
|
|
|
|
@derive [Poison.Encoder]
|
|
defstruct accounts: [],
|
|
statuses: [],
|
|
hashtags: []
|
|
|
|
@doc """
|
|
Search for content
|
|
|
|
## Parameters
|
|
|
|
* `conn` - Connection credentials
|
|
* `q` - the search query, if `q` is a URL Mastodon will attempt to fetch
|
|
the provided account or status, it will do a local account and hashtag
|
|
search
|
|
* `options` - option list
|
|
|
|
## Options
|
|
|
|
* `resolve` - Whether to resolve non-local accounts
|
|
|
|
"""
|
|
@spec search(Hunter.Client.t(), String.t(), Keyword.t()) :: Hunter.Result.t()
|
|
def search(conn, query, options \\ []) do
|
|
Config.hunter_api().search(conn, query, options)
|
|
end
|
|
end
|