trust
Trust level report generation module
- trust
- static
- .name :
String - .version :
String - .description :
String - .configuration :
Object - .enabled :
Boolean - .begin(browser, config)
- .onNotify(type, notification, topic, post, callback)
- .name :
- inner
- ~promotionTable :
Object - ~formatReport(user) ⇒
String - ~getReportBase(user) ⇒
String - ~promotionAnalysis(user) ⇒
String
- ~promotionTable :
trust.name : String
The name of the sockbot module
Kind: static property of trust
trust.version : String
The version of this sockbot module
Kind: static property of trust
trust.description : String
Description of the module, for help text
Kind: static property of trust
trust.configuration : Object
Configuration options
Kind: static property of trust
configuration.enabled : Boolean
Is the module enabled?
Kind: static property of configuration
trust.begin(browser, config)
Bootstrap the module
Kind: static method of trust
| Param | Type | Description |
|---|---|---|
| browser | string |
discourse. |
| config | object |
The configuration to use |
trust.onNotify(type, notification, topic, post, callback)
Runs on notification. Only responds to private_message, mention, or reply. This also only replies to requests for your own report unless you're TL4 or higher.
Kind: static method of trust
| Param | Type | Description |
|---|---|---|
| type | string |
The type of event. |
| notification | string |
The notification to respond to |
| topic | string |
Unused. |
| post | string |
The post the notification was for |
| callback | function |
The callback to notify when processing is complete. |
trust~promotionTable : Object
List of description text for a given promotion table
Kind: inner property of trust
trust~formatReport(user) ⇒ String
Format the report to send out.
Kind: inner method of trust
Returns: String - The report text, formatted pretty
| Param | Type | Description |
|---|---|---|
| user | Object |
The user whose report this is for |
trust~getReportBase(user) ⇒ String
Get the basic report information for the user
Kind: inner method of trust
Returns: String - The information about the user
| Param | Type | Description |
|---|---|---|
| user | Object |
Basic info about the user |
trust~promotionAnalysis(user) ⇒ String
Get information about the trust level for the user
Kind: inner method of trust
Returns: String - The promotion text for that user.
| Param | Type | Description |
|---|---|---|
| user | Object |
The user to get information about |