hunter

v0.4.1

hunter v0.4.1 Hunter.Application

Application entity

This module defines a Hunter.Application struct and the main functions for working with Applications.

Fields

  • id - identifier
  • client_id - client id
  • client_secret - client secret

Summary

Types

t()

Functions

create_app(name, redirect_uri \\ "urn:ietf:wg:oauth:2.0:oob", scopes \\ ["read"], website \\ nil, options \\ [])

Register a new OAuth client app on the target instance

load_credentials(name)

Load persisted application’s credentials

Types

t() 
t() :: %Hunter.Application{client_id: String.t, client_secret: String.t, id: non_neg_integer}

Functions

create_app(name, redirect_uri \\ "urn:ietf:wg:oauth:2.0:oob", scopes \\ ["read"], website \\ nil, options \\ []) 
create_app(String.t, URI.t, [String.t], String.t, Keyword.t) :: Hunter.Application.t

Register a new OAuth client app on the target instance

Parameters

  • name - name of your application
  • redirect_uri - where the user should be redirected after authorization, default: urn:ietf:wg:oauth:2.0:oob (no redirect)
  • scopes - scope list, see the scope section for more details, default: read
  • website - URL to the homepage of your app, default: nil
  • options - option list

Scopes

  • read - read data
  • write - post statuses and upload media for statuses
  • follow - follow, unfollow, block, unblock

Multiple scopes can be requested during the authorization phase with the scope query param

Options

  • save? - persists your application information to a file, so, you can use them later. default: false
  • api_base_url - specifies if you want to register an application on a different instance. default: https://mastodon.social
load_credentials(name) 
load_credentials(String.t) :: Hunter.Application.t

Load persisted application’s credentials

Parameters

  • name - application name