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

    Interface iPluginDoc<T>

    interface iPluginDoc<T extends NumberType> {
        _docId: string;
        _id?: string;
        approvedUsers: string[];
        createdAt: T;
        createdBy: string;
        deletedAt?: T;
        inviteCode?: string;
        lastUpdated: T;
        locale?: string;
        managedBy: string;
        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 Summary)

    Implemented by

    Index

    Properties

    _docId _id? approvedUsers createdAt createdBy deletedAt? inviteCode? lastUpdated locale? managedBy 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: string[]
    createdAt: T
    createdBy: string

    The BitBadges address who created the plugin doc

    deletedAt?: T
    inviteCode?: string

    Invite code for the plugin

    lastUpdated: T
    locale?: string

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

    managedBy: string

    The BitBadges address of the user who is currently managing this

    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: string

    The unique plugin ID

    pluginSecret?: string

    The secret of the plugin. Used to verify BitBadges as origin of request.

    reviewCompleted: boolean

    Review process completed

    toPublish: boolean

    To publish to directory?

    versions: iPluginVersionConfig<T>[]

    Array of version-controlled plugin configurations

    Settings

    Member Visibility

    On This Page

    Properties