Skip to content

Commit 8749b3c

Browse files
docs: cleanup for nasty nate
1 parent 65da5ca commit 8749b3c

13 files changed

Lines changed: 173 additions & 150 deletions

streamerbot/3.api/1.sub-actions/twitch/chat/get-pinned-chat-message.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ title: Get Pinned Chat Message
44
description: Gets the current pinned chat message
55
version: 1.0.5
66
csharpmethods:
7-
- TwitchGetPinnedMessage
7+
- TwitchGetPinnedMessage
88
---
9+
10+
:wip

streamerbot/3.api/1.sub-actions/twitch/chat/pin-chat-message.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ parameters:
1010
description: |
1111
Enter the ID of the message to pin
1212
- name: Duration
13-
type: Text
13+
type: Number
1414
required: false
1515
description: |
16-
The duration to pin the chat message for.
17-
- `null` for the pin to last till the end of the stream
18-
- between `30` and `1800` - duration in seconds
16+
The duration to pin the chat message for.
17+
- `null` for the pin to last till the end of the stream
18+
- between `30` and `1800` - duration in seconds
1919
csharpmethods:
20-
- TwitchChatPinMessage
20+
- TwitchChatPinMessage
2121
---
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Update Pinned Chat Message Duration
3+
description: Modify the duration of the pinned message in Twitch chat
4+
version: 1.0.5
5+
- name: Message Id
6+
type: Text
7+
required: true
8+
description: |
9+
Enter the ID of the message to modify
10+
- name: Duration
11+
type: Number
12+
required: false
13+
description: |
14+
The duration to pin the chat message for.
15+
- `null` for the pin to last till the end of the stream
16+
- between `30` and `1800` - duration in seconds
17+
csharpmethods:
18+
- TwitchUpdatePinnedChatMessageDuration
19+
---
20+
21+
:wip

streamerbot/3.api/3.csharp/3.methods/twitch/chat/send-message.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ parameters:
1818
- `true`{lang=cs} - (If `bot` bool is set to `True`), this is the same behaviour as if you had Bot as your preferred account.
1919
- `false`{lang=cs} - (If `bot` bool is set to `True`), it will try to send using **only** the Bot account, and do **nothing** if it can't (i.e, not logged in).
2020
example: |
21-
using System;
22-
public class CPHInline
23-
{
24-
public bool Execute()
25-
{
26-
//Set message for chat
27-
string message = "This is a test message.";
21+
using System;
22+
public class CPHInline
23+
{
24+
public bool Execute()
25+
{
26+
//Set message for chat
27+
string message = "This is a test message.";
2828
29-
//Send message with bot account if bot account disconnect
30-
//will use broadcaster account
31-
CPH.SendMessage(message, true, true);
29+
//Send message with bot account if bot account disconnect
30+
//will use broadcaster account
31+
CPH.SendMessage(message, true, true);
3232
33-
return true;
34-
}
35-
}
33+
return true;
34+
}
35+
}
3636
---
Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
2-
name: SendWhisper
3-
title: SendWhisper
1+
---
2+
name: SendWhisper
3+
title: SendWhisper
44
description: |
55
Send a Twitch Whipser to another user.
66
@@ -21,25 +21,25 @@ parameters:
2121
- `true`{lang=cs} - Send the message using your **Twitch Bot** account
2222
- `false`{lang=cs} - Send the message using your **Twitch Broadcaster** account
2323
example: |
24-
using System;
25-
public class CPHInline
26-
{
27-
public bool Execute()
28-
{
29-
//Define user login you want to whisper
30-
string userName = "streamerdotbot";
31-
//Set message for chat
32-
string message = "This is a test message.";
24+
using System;
25+
public class CPHInline
26+
{
27+
public bool Execute()
28+
{
29+
//Define user login you want to whisper
30+
string userName = "streamerdotbot";
31+
//Set message for chat
32+
string message = "This is a test message.";
33+
34+
//Send message with bot account
35+
bool wasSend = CPH.SendWhisper(userName, message, true);
3336
34-
//Send message with bot account
35-
bool wasSend = CPH.SendWhisper(userName, message, true);
36-
37-
if(wasSend){
38-
//This does not mean that is was received by the user.
39-
//It may still be silently dropped by Twitch
40-
CPH.LogInfo("Whisper was send!");
41-
}
42-
return true;
43-
}
44-
}
37+
if(wasSend){
38+
//This does not mean that is was received by the user.
39+
//It may still be silently dropped by Twitch
40+
CPH.LogInfo("Whisper was send!");
41+
}
42+
return true;
43+
}
44+
}
4545
---
Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
2-
name: TwitchAnnounce
3-
title: TwitchAnnounce
1+
---
2+
name: TwitchAnnounce
3+
title: TwitchAnnounce
44
description: Sends a Twitch chat message using either Twitch Broadcaster or Twitch Bot account
55
parameters:
66
- name: message
@@ -14,11 +14,11 @@ parameters:
1414
- name: color
1515
default: "Default"
1616
description: |
17-
Select the color for the announcement. Valid values are:
18-
- `default` – Standard color
19-
- `blue`
20-
- `green`
21-
- `orange`
17+
Select the color for the announcement. Valid values are:
18+
- `default` – Standard color
19+
- `blue`
20+
- `green`
21+
- `orange`
2222
- `purple`
2323
- name: fallback
2424
version: 0.2.5
@@ -27,18 +27,18 @@ parameters:
2727
- `true`{lang=cs} - (If `bot` bool is set to `True`), this is the same behaviour as if you had Bot as your preferred account.
2828
- `false`{lang=cs} - (If `bot` bool is set to `True`), it will try to send using **only** the Bot account, and do **nothing** if it can't (i.e, not logged in).
2929
example: |
30-
using System;
31-
public class CPHInline
32-
{
33-
public bool Execute()
34-
{
35-
//Set message for chat
36-
string message = "This is an announcement";
30+
using System;
31+
public class CPHInline
32+
{
33+
public bool Execute()
34+
{
35+
//Set message for chat
36+
string message = "This is an announcement";
3737
38-
//Send announcement with bot account, or fallback to broadcaster
39-
CPH.TwitchAnnounce(message, true, color, true);
38+
//Send announcement with bot account, or fallback to broadcaster
39+
CPH.TwitchAnnounce(message, true, color, true);
4040
41-
return true;
42-
}
43-
}
41+
return true;
42+
}
43+
}
4444
---
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
2-
name: TwitchClearChatMessages
3-
title: TwitchClearChatMessages
1+
---
2+
name: TwitchClearChatMessages
3+
title: TwitchClearChatMessages
44
description: Clear Twitch Chat
55
parameters:
66
- name: bot
@@ -9,18 +9,18 @@ parameters:
99
- `true`{lang=cs} - Clear all messages with bot account
1010
- `false`{lang=cs} - Clear all messages with broadcaster account
1111
example: |
12-
using System;
13-
public class CPHInline
14-
{
15-
public bool Execute()
16-
{
17-
//Clear chat
18-
bool gotCleared = CPH.TwitchClearChatMessages(true);
19-
20-
if(gotCleared){
21-
CPH.SendMessage("Message got cleared successfully!");
22-
}
23-
return true;
24-
}
25-
}
12+
using System;
13+
public class CPHInline
14+
{
15+
public bool Execute()
16+
{
17+
//Clear chat
18+
bool gotCleared = CPH.TwitchClearChatMessages(true);
19+
20+
if(gotCleared){
21+
CPH.SendMessage("Message got cleared successfully!");
22+
}
23+
return true;
24+
}
25+
}
2626
---
Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
2-
name: TwitchDeleteChatMessage
3-
title: TwitchDeleteChatMessage
1+
---
2+
name: TwitchDeleteChatMessage
3+
title: TwitchDeleteChatMessage
44
description: Delete Twitch message via message id
55
parameters:
66
- name: messageId
@@ -12,21 +12,21 @@ parameters:
1212
- `true`{lang=cs} - Delete the message with bot account
1313
- `false`{lang=cs} - Delete the message with broadcaster account
1414
example: |
15-
using System;
16-
public class CPHInline
17-
{
18-
public bool Execute()
19-
{
20-
//Set message for chat
21-
CPH.TryGetArg("msgId",out string messageId);
15+
using System;
16+
public class CPHInline
17+
{
18+
public bool Execute()
19+
{
20+
//Set message for chat
21+
CPH.TryGetArg("msgId",out string messageId);
22+
23+
//Delete the message that was just send by a command/message
24+
bool gotDeleted = CPH.TwitchDeleteChatMessage(messageId, true);
2225
23-
//Delete the message that was just send by a command/message
24-
bool gotDeleted = CPH.TwitchDeleteChatMessage(messageId, true);
25-
26-
if(gotDeleted){
27-
CPH.SendMessage("Message got deleted successfully!");
28-
}
29-
return true;
30-
}
31-
}
26+
if(gotDeleted){
27+
CPH.SendMessage("Message got deleted successfully!");
28+
}
29+
return true;
30+
}
31+
}
3232
---

streamerbot/3.api/3.csharp/3.methods/twitch/chat/twitch-get-pinned-message.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ title: TwitchGetPinnedMessage
44
description: Gets the current pinned chat message
55
version: 1.0.5
66
example: |
7-
using System;
8-
public class CPHInline
9-
{
10-
public bool Execute()
11-
{
12-
// get the current pinned chat message
13-
var pinnedMessage = CPH.TwitchGetPinnedMessage();
7+
using System;
8+
public class CPHInline
9+
{
10+
public bool Execute()
11+
{
12+
// get the current pinned chat message
13+
var pinnedMessage = CPH.TwitchGetPinnedMessage();
1414
15-
return true;
16-
}
17-
}
15+
return true;
16+
}
17+
}
1818
---

streamerbot/3.api/3.csharp/3.methods/twitch/chat/twitch-pin-chat-message.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: TwitchChatPinChatMessage
3-
title: TwitchChatPinChatMessage
2+
name: TwitchPinChatMessage
3+
title: TwitchPinChatMessage
44
description: Pins a chat message in Twitch
55
version: 1.0.5
66
parameters:

0 commit comments

Comments
 (0)