@vicinae/api
    Preparing search index...

    Interface Options

    The options for creating a new OAuth.PKCEClient.

    interface Options {
        description?: string;
        providerIcon?: Image.ImageLike;
        providerId?: string;
        providerName: string;
        redirectMethod: OauthRedirectMethod;
    }
    Index

    Properties

    description? providerIcon? providerId? providerName redirectMethod

    Properties

    description?: string

    An optional description, shown in the OAuth overlay. You can use this to customize the message for the end user, for example for handling scope changes or other migrations. Raycast shows a default message if this is not configured.

    providerIcon?: Image.ImageLike

    An icon displayed in the OAuth overlay. Make sure to provide at least a size of 64x64 pixels.

    providerId?: string

    An optional ID for associating the client with a provider. Only set this if you use multiple different clients in your extension.

    providerName: string

    The name of the provider, displayed in the OAuth overlay.

    redirectMethod: OauthRedirectMethod

    The redirect method for the OAuth flow. Make sure to set this to the correct method for the provider, see OAuth.RedirectMethod for more information.

    Settings

    Member Visibility

    On This Page

    Properties