Interface iUpdatePluginPayload

interface iUpdatePluginPayload {
    approvedUsers?: string[];
    inviteCode?: string;
    locale?: string;
    metadata?: {
        createdBy?: string;
        description: string;
        documentation?: string;
        image: string;
        name: string;
        parentApp?: string;
        sourceCode?: string;
        supportLink?: string;
    };
    pluginId: string;
    removeSelfFromApprovedUsers?: boolean;
    rotatePluginSecret?: boolean;
    toPublish?: boolean;
    versionCreate?: PluginVersionConfigPayload;
    versionUpdates?: {
        config: Partial<PluginVersionConfigPayload>;
        version: NumberType;
    }[];
}

Properties

approvedUsers? inviteCode? locale? metadata? pluginId removeSelfFromApprovedUsers? rotatePluginSecret? toPublish? versionCreate? versionUpdates?

Properties

OptionalapprovedUsers

approvedUsers?: string[]

The addresses that are allowed to use this plugin.

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.

Optionalmetadata

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

Type declaration

  • OptionalcreatedBy?: string

    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

OptionalremoveSelfFromApprovedUsers

removeSelfFromApprovedUsers?: boolean

Remove self from approved users?

OptionalrotatePluginSecret

rotatePluginSecret?: boolean

Rotate the plugin secret?

OptionaltoPublish

toPublish?: boolean

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

OptionalversionCreate

versionCreate?: PluginVersionConfigPayload

Create a new version

OptionalversionUpdates

versionUpdates?: {
    config: Partial<PluginVersionConfigPayload>;
    version: NumberType;
}[]

Update an existing version

Type declaration

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR