Struct mammut::registration::Registration

pub struct Registration { /* fields omitted */ }

Handles registering your mastodon app to your instance. It is recommended you cache your data struct to avoid registering on every run.

Methods

impl Registration

pub fn new<I: Into<String>>(base: I) -> Self

Construct a new registration process to the instance of the base url.

use mammut::registration::Registration;

let registration = Registration::new("https://mastodon.social");

pub fn register(&mut self, app_builder: AppBuilder) -> Result<()>

Register the application with the server from the base url.

use mammut::Registration;
use mammut::apps::{AppBuilder, Scopes};

let app = AppBuilder {
    client_name: "mammut_test",
    redirect_uris: "urn:ietf:wg:oauth:2.0:oob",
    scopes: Scopes::Read,
    website: None,
};

let mut registration = Registration::new("https://mastodon.social");
registration.register(app)?;
let url = registration.authorise()?;
// Here you now need to open the url in the browser
// And handle a the redirect url coming back with the code.
let code = String::from("RETURNED_FROM_BROWSER");
let mastodon = registration.create_access_token(code)?;

println!("{:?}", mastodon.get_home_timeline()?.initial_items);

pub fn authorise(&mut self) -> Result<String>

Returns the full url needed for authorisation. This needs to be opened in a browser.

pub fn create_access_token(self, code: String) -> Result<Mastodon>

Create an access token from the client id, client secret, and code provided by the authorisation url.