RandomImageResponder - Documentation

Constructor

new RandomImageResponder(options)

Create a bot random image responder.

Source:

responder/random-image.js, line 44

Parameters:

Name Type Description

options

Object

The responder options.

Name	Type	Attributes	Description
`images`	`Array.<String>` \| `Array.<Object>`		The images to respond with, one will be randomly picked each time.
`label`	`String`	<optional>	Default text to show alongside images.
`color`	`String`	<optional>	Default color of the image attachment, a hex code including the preceeding "#".
`alias`	`String` \| `Alias`	<optional>	The alias to respond with. This must be either an Alias or the name of one registered the bot.

Examples

Create a random image responder

new Bot.Responder.RandomImage({
    images: [
        'https://i.imgur.com/ydM3Wb4.gif',
        'https://media.giphy.com/media/XdACBmg3lx6RG/giphy.gif'
    ]
});

Create a random image responder with additional configurations

new Bot.Responder.RandomImage({
    images: [
        {
            image: 'https://i.imgur.com/ydM3Wb4.gif',
            label: 'Some cute goats'
        },
        {
            image: 'https://media.giphy.com/media/XdACBmg3lx6RG/giphy.gif',
            label: 'A goat with ice-skating skills'
        }
    ]
});

Create a random image responder with a default label/color

new Bot.Responder.RandomImage({
    label: 'Have a goat',
    color: '#ffced8',
    images: [
        'https://i.imgur.com/ydM3Wb4.gif',
        'https://media.giphy.com/media/XdACBmg3lx6RG/giphy.gif'
    ]
});