hunter

v0.5.1

hunter v0.5.1 Hunter.Client View Source

Defines a Hunter client

Link to this section Summary

Types

t()

Functions

log_in(app, username, password, base_url \\ "https://mastodon.social")

Retrieve access token

new(options \\ [])

Initializes a client

user_agent()

User agent of the client

Link to this section Types

Link to this type

t() View Source 
t() :: %Hunter.Client{base_url: String.t(), bearer_token: String.t()}

Link to this section Functions

Link to this function

log_in(app, username, password, base_url \\ "https://mastodon.social") View Source 
log_in(Hunter.Application.t(), String.t(), String.t(), String.t()) ::
  Hunter.Client.t()

Retrieve access token

Parameters

  • app - application details, see: Hunter.Application.create_app/5 for more details.
  • username - your account's email
  • password - your password
  • base_url - API base url, default: https://mastodon.social
Link to this function

new(options \\ []) View Source 
new(Keyword.t()) :: Hunter.Client.t()

Initializes a client

Options

  • base_url - URL of the instance you want to connect to
  • bearer_token - [String] OAuth access token for your authenticated user
Link to this function

user_agent() View Source 
user_agent() :: String.t()

User agent of the client