Skip to content

Commit 5473af8

Browse files
Adding initial Kick Docs (Subactions,Triggers, C# Methods)
* thiccccccums for the Kickkkkkkums * Update/Correct Descriptions * Present Viewer Description Update --------- Co-authored-by: pwnyy <hubertytom@hotmail.com>
1 parent 0464b48 commit 5473af8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1064
-6
lines changed

streamerbot/2.guide/20.platforms/2.trovo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ navigation.icon: null
55
icon: IconTrovo
66
logo: /img/icons/trovo.png
77
version: 0.2.3
8-
badge: New
98
---
109

1110
:api-reference-cards{path=trovo}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Kick
3+
description: Configure the Kick streaming platform with Streamer.bot
4+
navigation.icon: null
5+
icon: simple-icons:kick
6+
logo: /img/icons/kick.png
7+
version: 1.0.0
8+
badge: New
9+
---
10+
11+
:api-reference-cards{path=kick}
12+
13+
:wip
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Set Channel Category
3+
description: Update the current category of your Kick channel
4+
parameters:
5+
- name: Source
6+
type: Select
7+
default: String
8+
description: |
9+
Select a source type for the new game value
10+
11+
- `String`: Select this option to manually enter the game title or load it from a variable
12+
- `Specific Game`: Select this option to select a game from a dropdown
13+
- name: Title
14+
type: Text | Select
15+
description: |
16+
Select the new game category or enter the new game category by name
17+
variables:
18+
- name: category.success
19+
type: bool
20+
description: The status of the sub-action request
21+
value: True/False
22+
- name: category.id
23+
type: string
24+
description: The unique category identifier
25+
value: 5787
26+
- name: category.name
27+
description: The unique category name
28+
value: Cats & Soup
29+
- name: category.thumbnail
30+
type: string
31+
description: URL to the image for the selected category
32+
value: https://files.kick.com/images/subcategories/5787/banner/conversion/153f16f9-6a5a-4449-b7c2-0a8e14f18092-banner.webp
33+
csharpMethods:
34+
- KickSetCategory
35+
---
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Set Channel Title
3+
description: Update the current title of your Kick channel
4+
parameters:
5+
- name: Title
6+
type: Text
7+
description: Enter the new title for your stream
8+
variables:
9+
- name: titleSuccess
10+
type: bool
11+
description: The status of the sub-action request
12+
value: True/False
13+
csharpMethods:
14+
- KickSetTitle
15+
---
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Reply to Message
3+
description: Send a reply to a specific Kick chat message
4+
parameters:
5+
- name: Reply Id
6+
type: Text
7+
default: '%messageId%'
8+
required: true
9+
description: |
10+
Enter the unique ID of the message to reply to
11+
12+
::tip
13+
All triggers that contain the `Kick Chat` variables, will populate the `%messageId%`{lang=cs} variable
14+
::
15+
- name: Message
16+
type: Text
17+
required: true
18+
description: |
19+
Enter the message contents
20+
- name: Send using bot account
21+
type: Toggle
22+
default: false
23+
description: |
24+
- [x] Send the reply using your **Kick Bot** account
25+
- [ ] Send the reply using your **Kick Broadcaster** account
26+
- name: Fallback to Broadcaster
27+
type: Toggle
28+
default: false
29+
description: |
30+
- [x] If `Send using Bot account` is **checked**, it will attempt to send reply as Kick Bot account and, if unable, then send as Kick Broadcaster.
31+
- [ ] If `Send using Bot account` is **unchecked**, it will attempt to send reply as Kick Bot account and, if unable, then do **nothing** (i.e. the Kick Bot account is not logged in.
32+
variables: []
33+
csharpMethods:
34+
- KickReplyToMessage
35+
---
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Send Message
3+
description: Send a Kick chat message
4+
parameters:
5+
- name: Message
6+
type: Text
7+
required: true
8+
description: |
9+
Enter the message contents
10+
- name: Send using bot account
11+
type: Toggle
12+
default: Unchecked
13+
description: |
14+
- [x] Send the reply using your **Kick Bot** account
15+
- [ ] Send the reply using your **Kick Broadcaster** account
16+
- name: Fallback to Broadcaster
17+
type: Toggle
18+
default: Unchecked
19+
description: |
20+
- [x] If `Send using Bot account` is **checked**, it will attempt to send reply as Kick Bot account and, if unable, then send as Kick Broadcaster.
21+
- [ ] If `Send using Bot account` is **unchecked**, it will attempt to send reply as Kick Bot account and, if unable, then do **nothing** (i.e. the Kick Bot account is not logged in.
22+
variables: []
23+
csharpMethods:
24+
- SendKickMessage
25+
---
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Ban User
3+
description: Ban a Kick user
4+
parameters:
5+
- name: User Login
6+
type: String
7+
required: true
8+
description: can be a user name or a variable like `%userName%`
9+
- name: Reason
10+
type: String
11+
required: false
12+
description: ban reason
13+
variables:
14+
- name: bannedUser
15+
type: string
16+
description: display name of the banned user
17+
value: Amouranth
18+
- name: bannedUserName
19+
type: string
20+
description: login name of the banned user
21+
value: Amouranth
22+
- name: bannedUserId
23+
type: string
24+
description: ID of the banned user
25+
value: 12345678
26+
- name: bannedUserType
27+
type: string
28+
description: platform of the banned user
29+
value: kick
30+
- name: banResult
31+
type: bool
32+
description: indicator whether the ban has been successful or not
33+
value: True/False
34+
csharpMethods:
35+
- KickBanUser
36+
---
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Timeout User
3+
description: Timeout a Kick user
4+
parameters:
5+
- name: User Login
6+
type: String
7+
required: true
8+
description: Can be a user name or a variable like `%userName%`
9+
- name: Duration
10+
type: Int
11+
required: true
12+
description: Timeout duration in seconds. `0` is a permanent ban.
13+
variables:
14+
- name: timedOutUser
15+
type: string
16+
description: display name of the timed out user
17+
value: Amouranth
18+
- name: timedOutUserName
19+
type: string
20+
description: login name of the timed out user
21+
value: Amouranth
22+
- name: timedOutUserId
23+
type: string
24+
description: ID of the timed out user
25+
value: 12345678
26+
- name: timedOutUserType
27+
type: string
28+
description: platform of the timed out user
29+
value: kick
30+
- name: timeoutResult
31+
type: bool
32+
description: indicator whether the timeout has been successful or not
33+
value: True/False
34+
csharpMethods:
35+
- KickTimeoutUser
36+
---
37+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Unban User
3+
description: Unban a Kick user
4+
parameters:
5+
- name: User Login
6+
type: String
7+
required: true
8+
description: can be a user name or a variable like `%userName%`
9+
variables:
10+
- name: unbannedUser
11+
type: string
12+
description: display name of the unbanned user
13+
value: Amouranth
14+
- name: unbannedUserName
15+
type: string
16+
description: login name of the banned user
17+
value: Amouranth
18+
- name: unbannedUserId
19+
type: string
20+
description: ID of the banned user
21+
value: 12345678
22+
- name: unbannedUserType
23+
type: string
24+
description: platform of the banned user
25+
value: kick
26+
- name: unbanResult
27+
type: bool
28+
description: indicator whether the ban has been successful or not
29+
value: True/False
30+
csharpMethods:
31+
- KickUnbanUser
32+
---
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: UnTimeout User
3+
description: Untimeout a Kick user
4+
5+
parameters:
6+
- name: User Login
7+
type: String
8+
required: true
9+
description: can be a user name or a variable like `%userName%`
10+
variables:
11+
- name: unTimedOutUser
12+
type: string
13+
description: display name of the untimed-out user
14+
value: Amouranth
15+
- name: unTimedOutUserName
16+
type: string
17+
description: login name of the untimed-out user
18+
value: Amouranth
19+
- name: unTimedOutUserId
20+
type: string
21+
description: ID of the untimed-out user
22+
value: 12345678
23+
- name: unTimedOutUserType
24+
type: string
25+
description: platform of the untimed-out user
26+
value: kick
27+
- name: unTimedOutResult
28+
type: bool
29+
description: indicator whether the untimeout has been successful or not
30+
value: True/False
31+
csharpMethods: []
32+
---

0 commit comments

Comments
 (0)