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

    Class PluginDoc<T>

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

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

    Methods

    clone convert equals getLatestVersion getNumberFieldNames hasNumberFields toJson toJsonString

    Constructors

    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;
    }
    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: PluginVersionConfig<T>[]

    Array of version-controlled plugin configurations

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods