Interface OnePlugin

interface OnePlugin {
    author?: string;
    defaultState: Record<string, any>;
    name: string;
    permissions: (PluginFilterEvent | SendType)[];
    uid: string;
    url?: string;
    version: string;
    destroy?(): void;
    filterComment?(comment, service, userData): Promise<false | Comment>;
    filterSpeech?(text, service, userData, config): Promise<string | false>;
    init?(api, initialData): void;
    request?(req): Promise<PluginResponse>;
    subscribe?(type, ...args): void;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

author? defaultState name permissions uid url? version

Methods

destroy? filterComment? filterSpeech? init? request? subscribe?

Properties

Optional author

author?: string

defaultState

defaultState: Record<string, any>

name

name: string

permissions

permissions: (PluginFilterEvent | SendType)[]

uid

uid: string

Optional url

url?: string

version

version: string

Methods

Optional destroy

  • destroy(): void

  • Returns void

Optional filterComment

Optional filterSpeech

  • filterSpeech(text, service, userData, config): Promise<string | false>

  • Parameters

    Returns Promise<string | false>

Optional init

Optional request

Optional subscribe

  • subscribe(type, ...args): void

  • Parameters

    Returns void

Settings

Theme

On This Page

authordefaultStatenamepermissionsuidurlversiondestroyfilterCommentfilterSpeechinitrequestsubscribe