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;
}

Properties

approvedUsers? initialVersion inviteCode? locale? metadata pluginId toPublish

Properties

OptionalapprovedUsers

approvedUsers?: string[]

The addresses that are allowed to use this plugin.

initialVersion

initialVersion: PluginVersionConfigPayload

The initial version configuration

OptionalinviteCode

inviteCode?: string

Invite code for the plugin

Optionallocale

locale?: string

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

metadata

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

pluginId: string

The unique plugin ID

toPublish

toPublish: boolean

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR