talkops
v2.16.0
Published
TalkOps SDK
Readme
TalkOps SDK: Node.js
This software development kit is made to create TalkOps extensions using Node.js.
Documentation
Table of Contents
- Attachment
- Extension
- Image
- Link
- Media
- Parameter
- Video
Attachment
Extends Link
Represents an attachment.
Parameters
urlfilename
setFilename
Parameters
filenameString The filename of the attachment.
- Throws TypeError If the filename is not valid.
Returns Attachment The updated attachment instance.
Extension
Represents an extension.
start
Returns Extension The starting extension instance.
on
Parameters
Returns Extension The updated extension instance.
isEnabled
Returns Boolean If the extension is enabled.
setDemo
Parameters
demoBoolean If the extension is a demonstration.
Returns Extension The updated extension instance.
setName
Parameters
nameString The name of the extension.
Returns Extension The updated extension instance.
setIcon
Parameters
iconString The icon url of the extension.
Returns Extension The updated extension instance.
setWebsite
Parameters
websiteString The website url of the extension.
Returns Extension The updated extension instance.
setCategory
Parameters
categoryString The category of the extension.
Returns Extension The updated extension instance.
setFeatures
Parameters
Returns Extension The updated extension instance.
setinstallationSteps
Parameters
Returns Extension The updated extension instance.
setParameters
Parameters
Returns Extension The updated extension instance.
setInstructions
Parameters
instructionsString The instructions of the extension.
Returns Extension The updated extension instance.
setFunctionSchemas
Parameters
Returns Extension The updated extension instance.
setFunctions
Parameters
Returns Extension The updated extension instance.
enableAlarm
Enables alarm.
sendMedias
Send one or more medias.
Parameters
sendMessage
Send a message.
Parameters
textString The text of the message.
sendNotification
Send a notification.
Parameters
textString The text of the notification.
Image
Extends Link
Represents an image.
Link
Extends Media
Represents a link.
Parameters
url
setUrl
Parameters
urlString The url of the link.
- Throws TypeError If the url is not a valid URL.
Returns Link The updated link instance.
Media
Represents a media.
Parameter
Represents a parameter.
Parameters
nameString The name of the parameter.
getName
Returns String The name of the parameter.
setOptional
Parameters
optionalBoolean If the parameter is optional.
Returns Parameter The updated parameter instance.
isOptional
Returns Boolean If the parameter is optional.
setDescription
Parameters
descriptionString The description of the parameter.
Returns Parameter The updated parameter instance.
setDefaultValue
Parameters
defaultValueString The default value of the parameter.
Returns Parameter The updated parameter instance.
setType
Parameters
typeString The type of the parameter.
Returns Parameter The updated parameter instance.
getValue
Returns String The value of the parameter.
setValue
Parameters
valueString The value of the parameter.
Returns Parameter The updated parameter instance.
hasValue
Returns Boolean If the parameter is not empty.
setAvailableValues
Parameters
Returns Parameter The updated parameter instance.
setPossibleValues
Parameters
Returns Parameter The updated parameter instance.
Video
Extends Link
Represents an video.
