jarvis-teamspeak-bot 0.9.1

jarvis-teamspeak-bot

0.9.1

Jarvis-Teamspeak-Bot ▸
- Static members
- .messageHandler
Jarvis ▸
- Static members
- .messageHandler
- .closeTS
- .closeSlack
- .connectToTS
- .connectToSlack
- .logToSlack
slackBot ▸
- Instance members
- #getConversations
fs
Plugin-cid ▸
- Static members
- .onMessage
Plugin-createClan ▸
- Static members
- .config
- .config
- .creatingUser
- .onMessage
- .constructChannels
- .setChannelPermissions
- .constructGroup
- .getGroupSortID
- .sanitation
- .terminateSession
- .terminateSession
- .run
- .run
- .targetUser
Plugin-help ▸
- Static members
- .onMessage
Plugin-joinMe ▸
- Static members
- .onMessage
- .getTargetsArray
- .selfMoveCheck
Plugin-purgeVerified ▸
- Static members
- .config
- .onMessage
- .purgeVerified

Jarvis-Teamspeak-Bot

Jarvis is an extensible Teamspeak 3 bot written in Javascript, which can be extended by building your own plugins or simply forking and hacking it to your own liking. The bot has been written using standard ES6 Javascript.

Jarvis-Teamspeak-Bot

Version: 0.9.1

Author: Jeremy Paton jeremy@jeremypaton.com

Static Members

▸ messageHandler

Jarvis core-generic message handler This function is called when Jarvis recieves a direct text message on Teamspeak

messageHandler

Version: 1.1

Parameters

data (function) Callback-function in which data is the direct text message

Jarvis

This is a thin wrapper around ts3-nodejs-library and slackbots, which handles conencting, closing and dispatching appropriately. Represents a Jarvis Bot Instance

new Jarvis(config: object, cid: number)

Type: class

Version: 1.1

Parameters

config (object) Config object passed from a configuration file

cid (number) The Bot's Default Channel passed as a ChannelID number

Properties

whoami (object) : Contains usefull information about the Bot's connection

enabled (boolean) : If the bot is enabled (not in use currently)

teamspeakReady (boolean) : If Teamspeak-intergration is ready to be used

slackReady (boolean) : If slack-intergration is ready to be used

cid (number) : The Bot's Default Channel

name (String) : The Bot's Name

config (object) : Config object

onMessage (function) : Callback function

Static Members

▸ messageHandler(callback)

Jarvis generic message handler This function requires a callback-function which will be used when Jarvis recieves a message

messageHandler(callback: function)

Version: 1.0

Parameters

callback (function) Callback-function

▸ closeTS()

Disconnects Jarvis from a Teamspeak 3 server

closeTS()

Version: 1.1

▸ closeSlack()

Disconnects Jarvis from slack

closeSlack()

Version: 1.1

▸ connectToTS()

Connects Jarvis to a Teamspeak 3 server

connectToTS()

Version: 1.0.1

▸ connectToSlack()

Connects Jarvis to a Slack Server

connectToSlack()

Version: 1.0

▸ logToSlack(channelID, message)

Jarvis external-log utility This function can be used to log an event messsage to a given slack channel TO DO: Return promise possibly for success and fail events for better error handling

logToSlack(channelID: any, message: any)

Version: 1.0

Parameters

channelID (any)

message (any)

Properties

channelID (string) : The ID of the channel the message will be sent to, can be private or public channel

message (string) : The message text to be sent

slackBot

This is a thin wrapper around slackbots, which extends the functionality with updated Slack API end-points

new slackBot(params: any)

Extends Bot

Version: 1.1

Parameters

params (any)

Properties

params (object) : Contains config settings for your slack bot API

Instance Members

▸ getConversations(params)

Get conversation list

getConversations(params: any): vow.Promise

Parameters

params (any)

Properties

params (object) : Object containing parameters such as types: public_channel

Returns

vow.Promise:

fs

A collection of utility functions which load all .js files exported functions, as well as managing initialisation (init) and active-plugin-worker scripts (run), finally provides a route to core plugin functions such as (onMessage).

Plugin-cid

Plugin used to return a message containing the 'cid' of the channel the invoker is in

Plugin-cid

Example

!cid

Static Members

▸ onMessage(msg, jarvis)

This function is called whenever Jarvis recieves a private message, Returns a message containing the 'cid' of the channel the invoker is in

onMessage(msg: String, jarvis: String)

Version: 1.0

Parameters

msg (String) Message string sent to Jarvis

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.

Plugin-createClan

Plugin used to create a group of channels for a clan and sets the permissions and properties of each channel

Plugin-createClan

Example

!createClan

Static Members

▸ config

Plugin configuration settings, please change to match your server

config

Version: 1.0

Properties

owners (array) : The IDs of ServerGroups which can use this plugin

ssgid (number) : The source ServerGroup ID (template group you need to setup in Teamspeak)

sortID_start (number) : Value used to calculate the Clan's ServerGroup's 'i_group_sort_id' for alphabetical sorting.

sortID_start (number) : Value used for increment of 'i_group_sort_id' E.g. 0-9 = +901s, a = 1000s, b = 1100s, c = 1200, etc

▸ config

Plugin configuration settings, please change to match your server

config

Version: 1.0

Properties

owners (array) : The IDs of ServerGroups which can use this plugin

▸ creatingUser(client)

Represents a user object which is making channels

creatingUser(client: object)

Type: object

Version: 1.1

Parameters

client (object) The Client which sent a textmessage

Properties

processid (number) : Keeps track of stage at which user is at in clan channel creation

client (object) : The Client which sent a textmessage

channels (object) : Contains all the TeamspeakChannel objects which this user has created

clanTag (string) : Stores the 2-4 character tag for the clan's server group

date (number) : Numeric value corresponding to when the user's session started

▸ onMessage(msg, jarvis)

This function is called whenever Jarvis recieves a private message Will create a group of channels for a clan and sets the permissions and properties of each channel

onMessage(msg: String, jarvis: String)

Version: 1.0.1

Parameters

msg (String) Message string sent to Jarvis

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.

▸ constructChannels(jarvis)

Will attempt to create all channels present in the channel array

constructChannels(jarvis: Function): Promise<String>

Version: 1.0.1 If parent-channel 'channelCreate()' fails, the function will terminate passing error in Promise If child-channel 'channelCreate()' fails, error is caught and next child will be attempted

Parameters

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

Returns

Promise<String>:

▸ setChannelPermissions(jarvis)

Will attempt to set permissions for all channels present in 'channels' array If 'channelSetPerm()' fails, error is caught and next permission will be attempted

setChannelPermissions(jarvis: Function): Promise<String>

Version: 1.0.1

Parameters

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

Returns

Promise<String>:

▸ constructGroup(jarvis, client, tag)

Will attempt to create a clan ServerGroup and add a sortID propery permission

constructGroup(jarvis: Function, client: object, tag: String)

Version: 1.1

Parameters

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

client (object) The Client which sent a textmessage

tag (String) String value containing a clan's tag name, e.g 'EPIC'

▸ getGroupSortID(tag)

Calculates and returns ServerGroup's 'i_group_sort_id' value for alphabetical sorting. Increments sortid based on clan tag, E.g. 0-9 = +901s, a = 1000s, b = 1100s, c = 1200, etc

getGroupSortID(tag: String): number

Version: 1.0

Parameters

tag (String) String value containing a clan's tag name, e.g 'EPIC'

Returns

number: Numerical value used for 'i_group_sort_id' (e.g 'EPIC' => 'E' => 5 * 100 => 901 + 500 => 1401)

▸ sanitation(message)

Checks for names which are too long and removes trailing or preceding spaces

sanitation(message: String): String

Version: 1.0

Parameters

message (String) Any string

Returns

String: A clean channel name

▸ terminateSession(client, jarvis)

Terminates user from currentlyCreating array, ending session and sends a log of the event to slack

terminateSession(client: object, jarvis: Function)

Version: 1.1

Parameters

client (object) The Client which sent a textmessage

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

▸ terminateSession(client, jarvis)

Terminates target user from currentlyMoving array, ending request session

terminateSession(client: object, jarvis: Function)

Version: 1.0

Parameters

client (object) The Target Client who is waiting to be moved

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

▸ run(helpers)

Active Worker: Which terminates users during creation process, if they've been inactive for a while.

run(helpers: object)

Version: 1.0

Parameters

helpers (object) Generic helper object for error messages

▸ run(helpers)

Active Worker: Which terminates users during creation process, if they've been inactive for a while.

run(helpers: object)

Version: 1.0

Parameters

helpers (object) Generic helper object for error messages

▸ targetUser(invoker, target)

Represents a user object which is making channels

targetUser(invoker: object, target: object)

Type: object

Version: 1.0

Parameters

invoker (object) The Teamspeak Client object who sent the request

target (object) The Teamspeak Client object who is the target of the request

Properties

invoker (object) : The Teamspeak Client object who sent the request

target (object) : The Teamspeak Client object who is the target of the request

date (number) : Numeric value corresponding to when the user's session started

Plugin-help

Plugin used to return a message containing the 'cid' of the channel the invoker is in

Plugin-help

Example

!help

Static Members

▸ onMessage(msg, jarvis)

This function is called whenever Jarvis recieves a private message Returns a message containing the all available help commands, given by each plugin

onMessage(msg: String, jarvis: String)

Version: 1.0

Parameters

msg (String) Message string sent to Jarvis

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.

Plugin-joinMe

Plugin used to ask a target user if they want to join the invoker user's channel

Plugin-joinMe

Example

!joinMe

Static Members

▸ onMessage(msg, jarvis)

This function is called whenever Jarvis recieves a private message Will ask target-user(s) if they want to join the invoker user's channel

onMessage(msg: String, jarvis: String)

Version: 1.0

Parameters

msg (String) Message string sent to Jarvis

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.

▸ getTargetsArray(targets, jarvis, invoker)

Gets the teamspeak 3 client objects from their respective client nickname and returns a Promise containing Also checks: if target is online, if target is already in channel, target already requested

getTargetsArray(targets: array, jarvis: Function, invoker: Object): Promise<TeamSpeakClient>

Version: 1.0

Parameters

targets (array) Array of target user Teamspeak 3 nicknames

jarvis (Function) Middleware Function: Provides access to Jarvis functions.

invoker (Object) The Teamspeak Client object which amde the request

Returns

Promise<TeamSpeakClient>:

▸ selfMoveCheck(targets, invoker_name)

Checks requestor is not try to join their own channel

selfMoveCheck(targets: array, invoker_name: String)

Version: 1.0

Parameters

targets (array) Array of target user Teamspeak 3 nicknames

invoker_name (String) String containing the requestor's Teamspeak nickname

Plugin-purgeVerified

Plugin used to remove any user in a Server Group which is not also in a Verified Database File

Plugin-purgeVerified

Example

!purgeVerified

Static Members

▸ config

Plugin configuration settings, please change to match your server (MOVED TO CONFIG.JS) and populated 'on.message'

config

Version: 1.0

Properties

owners (array) : The IDs of ServerGroups which can use this plugin

group_id (number) : The ID of ServerGroup to be purged

database_file (String) : Path to the Verified Database File

▸ onMessage(msg, jarvis)

This function is called whenever Jarvis recieves a private message Will create a group of channels for a clan and sets the permissions and properties of each channel

onMessage(msg: String, jarvis: String)

Version: 1.1

Parameters

msg (String) Message string sent to Jarvis

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.

▸ purgeVerified(invoker, jarvis)

This function will attempt to remove any user in a Server Group which is not also in a Verified Database File

purgeVerified(invoker: Object, jarvis: String)

Version: 1.1

Parameters

invoker (Object) The Teamspeak Client object which made the request

jarvis (String) Middleware Function: Provides access to certain Jarvis functions.