Interface AppRepository

interface AppRepository {
    create(
        params: CreateAppParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<mastodon.v1.Client>;
    verifyCredentials(
        meta?: HttpMetaParams<"none">,
    ): Promise<mastodon.v1.Client>;
}

Index

Methods

create verifyCredentials

Methods

create

create(
params: CreateAppParams,
meta?: HttpMetaParams<"json">,
): Promise<mastodon.v1.Client>
Create a new application to obtain OAuth2 credentials.
Parameters
- params: CreateAppParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<mastodon.v1.Client>
Returns App with client_id and client_secret

See
https://docs.joinmastodon.org/methods/apps/
- Defined in src/mastodon/rest/v1/app-repository.ts:26

verifyCredentials

verifyCredentials(meta?: HttpMetaParams<"none">): Promise<mastodon.v1.Client>
Confirm that the app's OAuth2 credentials work.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<mastodon.v1.Client>
Application

See
https://docs.joinmastodon.org/methods/apps/
- Defined in src/mastodon/rest/v1/app-repository.ts:36