add docs for quote sub-actions

streamerbot/2.guide/08.settings/quotes.md

@@ -3,6 +3,11 @@ title: Quotes
 description: Streamer.bot has a built in quote system. It allows to add, display and delete quotes. Adding a quote automatically assigns an ID and saves a timestamp, the quoting user, the platform as well as the current category (like "Just Chatting").
 ---
 
+::warning{to=examples/quotes-commands}
+This page documents the old quote system prior to Streamer.bot 1.0.0<br/>
+:icon{name=i-mdi-navigation} See `Quotes Commands for v1.0.0+` for guidance on using the new quote sub-actions
+::
+
 ## Setup
 In order to use the built in quote system, navigate to `Settings -> Quotes` and check `Enabled`.
 

streamerbot/3.api/1.sub-actions/core/quotes/add-quote.md

@@ -0,0 +1,54 @@
+---
+title: Add Quote
+description: Add a quote which can be retrieved by the `Get Quote` Sub-Action
+parameters:
+  - name: Variable
+    type: Text
+    required: true
+    description: The text of the quote to add.
+variables:
+  - name: success
+    type: bool
+    description: Whether the quote was added successfully
+    value: true
+  - name: quoteTime
+    type: string
+    description: The time that the quote was made
+    value: 10/17/2025
+  - name: quoteId
+    type: string
+    description: The numeric id of the quote which was just added
+    value: '4219'
+  - name: quoteUserId
+    type: string
+    description: The user id from the account that added the quote
+    value: '12345678'
+  - name: quoteUser
+    type: string
+    description: The user's display name from the account that added the quote
+    value: StreamerBot
+  - name: quotePlatform
+    type: string
+    description: The platform from the account that added the quote
+    value: twitch
+  - name: quoteGame
+    type: string
+    description: The category set on the channel when the quote was added
+    value: Beat Saber
+  - name: quote
+    type: string
+    description: The quote itself
+    value: This is a quote!
+csharpMethods:
+  - AddQuoteForTwitch
+  - AddQuoteForYouTube
+  - AddQuoteForKick
+  - AddQuoteForTrovo
+---
+
+::tip
+This Sub-Action will set the quote user to the user who called the action<br/>
+Setting the quote user to a different user than the caller is only supported via the C# Method
+::
+
+:read-more{to=examples/quotes-commands}

streamerbot/3.api/1.sub-actions/core/quotes/delete-quote.md

@@ -0,0 +1,31 @@
+---
+title: Delete Quote
+description: Delete the selected Quote
+parameters:
+  - name: Quote Id
+    type: Number
+    required: true
+    description: The Quote ID to delete.
+variables:
+  - name: success
+    type: bool
+    description: Whether the quote was deleted successfully
+    value: true
+  - name: quoteId
+    type: string
+    description: If `success` is true, contains the numeric id of the quote which was just deleted
+    value: '4219'
+  - name: error
+    type: string
+    description: If `success` is false, contains the reason that deleting the quote failed
+    value: Unable to delete quote 4219, it does not exist
+csharpMethods:
+  - DeleteQuote
+---
+
+::tip
+Deleting a quote does not change the Quote ID of following quotes<br/>
+You can Re-Index quotes manually under `Services > Quotes` by right-clicking and choosing `Re-index` from the context menu.  **This operation can not be undone**
+::
+
+:read-more{to=examples/quotes-commands}

streamerbot/3.api/1.sub-actions/core/quotes/get-quote-count.md

@@ -0,0 +1,17 @@
+---
+title: Get Quote Count
+description: Get the total number of quotes
+variables:
+  - name: quoteCount
+    type: number
+    description: The total number of quotes which have been added.
+    value: 250
+csharpMethods:
+  - GetQuoteCount
+---
+
+::tip
+The Count returned by this Sub-Action is not necessarily the same as the last Quote ID, on account of deleted quotes.
+::
+
+:read-more{to=examples/quotes-commands}

streamerbot/3.api/1.sub-actions/core/quotes/get-quote.md

@@ -16,18 +16,22 @@ parameters:
     required: false
     description: The specific quote ID to fetch, only used if `Type` is set to `Specific`
 variables:
+  - name: quoteTimestamp
+    type: string
+    description: The date and time that the quote was made
+    value: 1/29/2022 12:00:00 AM
   - name: quoteTime
     type: string
-    description: The time that the quote was made
-    value: 2024-01-01T12:00:00Z
+    description: The date that the quote was made
+    value: 10/17/2025
   - name: quoteId
     type: string
     description: The numeric id of the quote
     value: '4219'
   - name: quoteUserId
     type: string
     description: The user id from the account that made the quote
-    value: 'streamerbot'
+    value: '12345678'
   - name: quoteUser
     type: string
     description: The user's display name from the account that made the quote
@@ -36,10 +40,6 @@ variables:
     type: string
     description: The platform from the account that made the quote
     value: twitch
-  - name: quoteGameId
-    type: string
-    description: The game id from the quote
-    value: '123942'
   - name: quoteGame
     type: string
     description: The game name from the quote
@@ -48,4 +48,8 @@ variables:
     type: string
     description: The quote itself
     value: This is a quote!
+csharpMethods:
+  - GetQuote
 ---
+
+:read-more{to=examples/quotes-commands}