new TwitchPoster(client, options)
Parameters:
Name | Type | Description |
---|---|---|
client |
Discord.Client
|
A Discord Bot Client, make sure it's ready otherwise you might face some sort of bugs |
options |
options
|
Options for the YoutubePoster |
Methods
(async) deleteAllChannels(DiscordGuildID) → {Array}
Delete all Channels in a GUild
Parameters:
Name | Type | Description |
---|---|---|
DiscordGuildID |
string
|
Discord Guild id |
Returns:
- Type:
-
Array
(async) deleteChannel(DiscordGuildID, username) → {StreamerObject}
Delete a specific twitch username in a Guild
Parameters:
Name | Type | Description |
---|---|---|
DiscordGuildID |
string
|
Discord Guild id |
username |
string
|
Returns:
- Type:
-
StreamerObject
(async) editChannel(username, DiscordChannel, Notification) → {StreamerObject}
Edit a specific twitch username in a Guild ID
Parameters:
Name | Type | Description |
---|---|---|
username |
string
|
twitch streamer |
DiscordChannel |
OBJECT
|
DiscordChannel
|
DiscordChannel with ID && guild parameters |
Notification |
string
|
Notification Message | OPTIONAL | DEFAULT: uses the options |
Returns:
- Type:
-
StreamerObject
(async) getAllChannels(DiscordGuildID) → {Array.<StreamerObject>}
Gets all Channels of a Guild
Parameters:
Name | Type | Description |
---|---|---|
DiscordGuildID |
string
|
Discord Guild id |
Returns:
- Type:
-
Array.<StreamerObject>
(async) getChannel(DiscordGuildID, username) → {StreamerObject}
Get twitch username for LINK
Parameters:
Name | Type | Description |
---|---|---|
DiscordGuildID |
string
|
Discord Guild id |
username |
string
|
twitch username |
Returns:
- Type:
-
StreamerObject
(async) getChannelInfo(username) → {StreamerObject}
Get Channel Information about a LINK
Parameters:
Name | Type | Description |
---|---|---|
username |
string
|
twitch username |
Returns:
- Type:
-
StreamerObject
(async) setChannel(username, DiscordChannel, Notification, preventDuplicates) → {StreamerObject}
Set a new twitch username to a Guild ID
Parameters:
Name | Type | Default | Description |
---|---|---|---|
username |
string
|
Twitch username |
|
DiscordChannel |
OBJECT
|
DiscordChannel
|
DiscordChannel with ID && guild parameters |
|
Notification |
string
|
Notification Message | OPTIONAL | DEFAULT: uses the options |
|
preventDuplicates |
Boolean
|
true |
Default: True |
Returns:
- Type:
-
StreamerObject