bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface iCreatePluginPayload

    interface iCreatePluginPayload {
        approvedUsers?: string[];
        initialVersion: PluginVersionConfigPayload;
        inviteCode?: string;
        locale?: string;
        metadata: {
            createdBy: string;
            description: string;
            documentation?: string;
            image: string;
            name: string;
            parentApp?: string;
            sourceCode?: string;
            supportLink?: string;
        };
        pluginId: string;
        toPublish: boolean;
    }
    Index

    Properties

    approvedUsers? initialVersion inviteCode? locale? metadata pluginId toPublish

    Properties

    approvedUsers?: string[]

    The addresses that are allowed to use this plugin.

    initialVersion: PluginVersionConfigPayload

    The initial version configuration

    inviteCode?: string

    Invite code for the plugin

    locale?: string

    Locale that is supported by the plugin. By default, we assume 'en' is supported if not specified.

    metadata: {
        createdBy: string;
        description: string;
        documentation?: string;
        image: string;
        name: string;
        parentApp?: string;
        sourceCode?: string;
        supportLink?: string;
    }

    Type Declaration

    • createdBy: string

      The creator of the plugin

    • description: string

      Description of the plugin

    • Optionaldocumentation?: string

      Documentation for the plugin

    • image: string

      The image of the plugin

    • name: string

      The name of the plugin

    • OptionalparentApp?: string

      Parent app of the plugin. If blank, treated as its own app / entity.

    • OptionalsourceCode?: string

      Source code for the plugin

    • OptionalsupportLink?: string

      Support link for the plugin

    pluginId: string

    The unique plugin ID

    toPublish: boolean

    To publish in the directory. This will trigger the start of the review process.

    Settings

    Member Visibility

    On This Page

    Properties