[][src]Module twitchchat::commands

Provides Encodable commands.

These can be used with an encoder, or with the Encodable trait directly to write typed messages.

The functions in this module produce borrowed types in the types module. You can store the types for multiple encodings.

Some provided encoders:

Modules

types

Concrete types produced by the functions in the commands module.

Structs

Channel

A channel wrapper that when .to_string() is called will ensure a leading # is added.

Functions

ban

Permanently prevent a user from chatting.

clear

Clear chat history for all users on channel.

color

Change your username color.

command

Sends the command to the channel (e.g. /color #FFFFFF)

commercial

Triggers a commercial.

disconnect

Reconnects to chat.

emote_only

Enables emote-only mode (only emoticons may be used in chat).

emote_only_off

Disables emote-only mode.

followers

Enables followers-only mode (only users who have followed for duration may chat).

followers_off

Disables followers-only mode.

give_mod

Grant moderator status to a user.

help

Lists the commands available to you in this room.

host

Host another channel.

join

Join a channel. This handles prepending a leading '#' for you if you omit it.

jtv_command

Sends the data as a command to the 'jtv' channel (e.g. /color #FFFFFF)

marker

Adds a stream marker (with an optional comment, max 140 characters) at the current timestamp.

me

Sends an "emote" message in the third person to the channel

mods

Lists the moderators of this channel.

part

Leave a channel. This handles prepending a leading '#' for you if you omit it.

ping

Request a servver response with the provided token

pong

Respond to a server request (normally a PING) with the provided token

privmsg

Send a normal message to a channel

r9k_beta

Enables r9k mode.

r9k_beta_off

Disables r9k mode.

raid

Raid another channel.

raw

Send a raw IRC-style message. This appends a \r\n for you.

register

Write the User Registration to the connection.

reply

Reply to a specific message (using an UUID) on a channel

slow

Enables slow mode (limit how often users may send messages).

slow_off

Disables slow mode.

subscribers

Enables subscribers-only mode (only subscribers may chat in this channel).

subscribers_off

Disables subscribers-only mode.

timeout

Temporarily prevent a user from chatting.

unban

Removes a ban on a user.

unhost

Stop hosting another channel.

unmod

Revoke moderator status from a user.

unraid

Cancel the raid.

untimeout

Removes a timeout on a user.

unvip

Revoke VIP status from a user.

vip

Grant VIP status to a user.

vips

Lists the VIPs of this channel.

whisper

Whispers a message to the username.