Struct ManifestParams 

#[non_exhaustive]
pub struct ManifestParams {
    pub name: String,
    pub url: String,
    pub webhook_url: String,
    pub redirect_url: String,
    pub callback_urls: Vec<String>,
    pub setup_url: Option<String>,
    pub description: Option<String>,
}

Inputs to the manifest.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

App name, unique on GitHub (e.g. acme-vgi-bridge).

url: String

Homepage shown on the App’s page.

webhook_url: String

Where GitHub delivers webhooks (the bridge).

redirect_url: String

Where GitHub sends the admin after registration, with code.

callback_urls: Vec<String>

OAuth callback URLs (device flow needs none, but GitHub wants one).

setup_url: Option<String>

Where GitHub sends the admin after an install, with installation_id and the bind state (§4.1 step 3).

description: Option<String>

Optional description.

Implementations

impl ManifestParams

pub fn new( name: impl Into<String>, url: impl Into<String>, webhook_url: impl Into<String>, redirect_url: impl Into<String>, ) -> Self

Parameters with one callback URL and no setup URL or description.

pub fn with_setup_url(self, url: impl Into<String>) -> Self

Set the post-install setup URL.

Trait Implementations

impl Clone for ManifestParams

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ManifestParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.