nodebb

NodeBB provider module

Author: Accalia
License: MIT

• nodebb
  • ~Forum
    • new Forum(config, useragent)
    • instance
      • .config : object
      • .useragent : string
      • .url : string
      • .username
      • .user : User
      • .owner : User
      • .Commands : Commands
      • .login() ⇒ Promise.<Forum>
      • .connectWebsocket() ⇒ Promise.<Forum>
      • .addPlugin(fnPlugin, pluginConfig) ⇒ Promise
      • .activate() ⇒ Promise
      • .deactivate() ⇒ Promise
      • .supports(supportString) ⇒ boolean
      • .fetchObject(func, id, parser) ⇒ Promise.<T>
    • static
      • .compatibilities

nodebb~Forum

Forum connector

Connects to a NodeBB forum

Kind: inner class of nodebb

• ~Forum
  • new Forum(config, useragent)
  • instance
    • .config : object
    • .useragent : string
    • .url : string
    • .username
    • .user : User
    • .owner : User
    • .Commands : Commands
    • .login() ⇒ Promise.<Forum>
    • .connectWebsocket() ⇒ Promise.<Forum>
    • .addPlugin(fnPlugin, pluginConfig) ⇒ Promise
    • .activate() ⇒ Promise
    • .deactivate() ⇒ Promise
    • .supports(supportString) ⇒ boolean
    • .fetchObject(func, id, parser) ⇒ Promise.<T>
  • static
    • .compatibilities

new Forum(config, useragent)

Create a forum connector instance

Param	Type	Description
config	object	Bot configuration data
useragent	string	Useragent to use for all requests

forum.config : object

Bot instance configuration

Kind: instance property of Forum
Access: public

forum.useragent : string

Useragent used by the instance

Kind: instance property of Forum
Access: public

forum.url : string

Base URL for the forum

Kind: instance property of Forum
Access: public

forum.username

Username bot will log in as

Kind: instance property of Forum
Access: public
Type{string}:

forum.user : User

Logged in Bot Username

Kind: instance property of Forum
Access: public

forum.owner : User

Bot instance Owner user

Kind: instance property of Forum
Access: public

forum.Commands : Commands

Get Commands object bound to this instance

Kind: instance property of Forum
Access: public

forum.login() ⇒ Promise.<Forum>

Login to forum instance

Kind: instance method of Forum
Returns: Promise.<Forum> - Resolves to logged in forum
Promise:
Fulfill: Forum Logged in forum

forum.connectWebsocket() ⇒ Promise.<Forum>

Connect to remote websocket

Kind: instance method of Forum
Returns: Promise.<Forum> - Resolves to connected forum
Access: public
Promise:
Resolves: Forum Connected forum

forum.addPlugin(fnPlugin, pluginConfig) ⇒ Promise

Add a plugin to this forum instance

Kind: instance method of Forum
Returns: Promise - Resolves on completion
Access: public
Promise:
Fulfill: * Plugin addedd successfully
Reject: Error Generated plugin is invalid

Param	Type	Description
fnPlugin	PluginFn | PluginGenerator	Plugin Generator
pluginConfig	object	Plugin configuration

forum.activate() ⇒ Promise

Activate forum and plugins

Kind: instance method of Forum
Returns: Promise - Resolves when all plugins have been enabled

forum.deactivate() ⇒ Promise

Deactivate forum and plugins

Kind: instance method of Forum
Returns: Promise - Resolves when all plugins have been disabled

forum.supports(supportString) ⇒ boolean

Supports: does the provider support a given feature?

Kind: instance method of Forum
Returns: boolean - True if all levels of feature supplied are supported, false if not. In the case of an array, will only be true if all strings are supported

Param	Type	Description
supportString	string | Array.<strng>	The feature string. Feature strings consist of one or more features connected by dots. May also be an array of such strings

forum.fetchObject(func, id, parser) ⇒ Promise.<T>

Retrieve and parse an object

Kind: instance method of Forum
Returns: Promise.<T> - Resolves to retrieved and parsed object
Access: public
Promise:
Fullfil: T Retrieved and parsed object

Param	Type	Description
func	string	Websocket function to retrieve object from
id	*	Id parameter to websocket function
parser	ParserFunction.<T>	Parse function to apply to retrieved data

Forum.compatibilities

Get announced compatibilities string for the provider

Kind: static property of Forum