Interface iPluginDoc<T>

interface iPluginDoc<T> {
    _docId: string;
    _id?: string;
    approvedUsers: string[];
    createdAt: T;
    createdBy: string;
    deletedAt?: T;
    inviteCode?: string;
    lastUpdated: T;
    metadata: {
        createdBy: string;
        description: string;
        documentation?: string;
        image: string;
        name: string;
        parentApp?: string;
        sourceCode?: string;
        supportLink?: string;
    };
    pluginId: string;
    pluginSecret?: string;
    reviewCompleted: boolean;
    toPublish: boolean;
    versions: iPluginVersionConfig<T>[];
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_docId _id? approvedUsers createdAt createdBy deletedAt? inviteCode? lastUpdated metadata pluginId pluginSecret? reviewCompleted toPublish versions

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

approvedUsers

approvedUsers: string[]

createdAt

createdAt: T

createdBy

createdBy: string

The BitBadges address who created the plugin doc

OptionaldeletedAt

deletedAt?: T

OptionalinviteCode

inviteCode?: string

Invite code for the plugin

lastUpdated

lastUpdated: T

metadata

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

Type declaration

  • createdBy: 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

OptionalpluginSecret

pluginSecret?: string

The secret of the plugin

reviewCompleted

reviewCompleted: boolean

Review process completed

toPublish

toPublish: boolean

To publish to directory?

versions

versions: iPluginVersionConfig<T>[]

Array of version-controlled plugin configurations

Settings

Member Visibility

On This Page

Properties