-
-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cf03c6b
commit 916a50e
Showing
9 changed files
with
80 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 68 additions & 49 deletions
117
streamerbot/3.api/1.sub-actions/twitch/user/get-user-info-for-target.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,72 @@ | ||
| # Get User Info for Target | ||
| Get various data from a Twitch user and populate a set of variables. | ||
| --- | ||
| title: Get User Info for Target | ||
| description: Fetch Twitch user data and populate a set of variables | ||
| commonVariables: | ||
| - TwitchUser | ||
| variables: | ||
| - name: targetUser | ||
| description: Display name of the target user | ||
| - name: targetUserName | ||
| description: User name of the target user | ||
| - name: targetUserId | ||
| description: User Id of the target user | ||
| - name: targetDescription | ||
| description: The user's channel description | ||
| - name: targetDescriptionEscaped | ||
| description: The user's channel description but URL encoded | ||
| - name: targetUserProfileImageUrl | ||
| description: link to the 300x300px PNG version of a user's twitch profile image | ||
| - name: targetUserProfileImageUrlEscaped | ||
| description: The url to the user's profile image URL encoded | ||
| - name: targetUserType | ||
| description: The type of user, `affiliate`, `partner` or empty for regular user | ||
| - name: targetIsAffiliate | ||
| description: A boolean value indicating if the user is an affiliate | ||
| - name: targetIsPartner | ||
| description: A boolean value indicating if the user is a partner | ||
| - name: targetLastActive | ||
| description: When the user was last active | ||
| - name: targetPreviousActive | ||
| description: When the user was previously active | ||
| - name: targetIsSubscribed | ||
| description: A boolean value indicating if the user is currently subscribed | ||
| - name: targetSubscriptionTier | ||
| description: '`1000`, `2000`, `3000` - Numeric value indicating tier' | ||
| - name: targetIsModerator | ||
| description: A boolean value indicating if the user is a moderator | ||
| - name: targetIsVip | ||
| description: A boolean value indicating if the user is a VIP | ||
| - name: targetChannelTitle | ||
| description: The stream title of the user | ||
| - name: game | ||
| description: The user's current game category | ||
| - name: gameId | ||
| description: The numeric id of the game category | ||
| - name: createdAt | ||
| description: Datetime of when the account was created | ||
| - name: accountAge | ||
| description: Age of the account in seconds | ||
| - name: tagCount | ||
| description: A count of the tags that channel set most recently | ||
| - name: tag# | ||
| description: Consecutive arguments populated with one tag value each | ||
| - name: tags | ||
| description: All tags in a `list` format | ||
| - name: tagsDelimited | ||
| description: A comma separated list of all tags | ||
| --- | ||
|
|
||
| :image-preview | ||
|
|
||
| ## Parameters | ||
| ## Configuration | ||
| ### `Source Type` | ||
| Name | Description | ||
| ----:|:------------ | ||
| `Broadcaster` | The currently logged in broadcaster account | ||
| `User` | User that invoked the action e.g. a raid leader, subscriber, point redeemer etc. | ||
| `From Input` | This will take the next word proceeding the trigger as the username to lookup. This user does not have to be present in the channel | ||
| `Variable` | Use the content of an existing variable as the target | ||
|
|
||
| ### `Variable` | ||
| If you selected `Variable` as your `Source Type`, enter the name of the variable you would like to read in. | ||
|
|
||
| ## Variables | ||
| :variables-description{empty} | ||
|
|
||
| Name | Description | ||
| ----:|:------------ | ||
| `targetUser` | Display name of the target user | ||
| `targetUserName` | User name of the target user | ||
| `targetUserId` | User Id of the target user | ||
| `targetDescription` | The user's channel description | ||
| `targetDescriptionEscaped` | The user's channel description but URL encoded | ||
| `targetUserProfileImageUrl` | link to the 300x300 px PNG version of a user's twitch profile image | ||
| `targetUserProfileImageUrlEscaped` | The url to the user's profile image URL encoded | ||
| `targetUserType` | The type of user, `affiliate`, `partner` or empty for regular user | ||
| `targetIsAffiliate` | A boolean value indicating if the user is an affiliate | ||
| `targetIsPartner` | A boolean value indicating if the user is a partner | ||
| `targetLastActive` | When the user was last active | ||
| `targetPreviousActive` | When the user was previously active | ||
| `targetIsSubscribed` | A boolean value indicating if the user is currently subscribed | ||
| `targetSubscriptionTier` | `1000`, `2000`, `3000` - Numeric value indicating tier | ||
| `targetIsModerator` | A boolean value indicating if the user is a moderator | ||
| `targetIsVip` | A boolean value indicating if the user is a VIP | ||
| `targetChannelTitle` | The stream title of the user | ||
| `game` | The user's current game category | ||
| `gameId` | The numeric id of the game category | ||
| `createdAt` | Datetime of when the account was created | ||
| `accountAge` | Age of the account in seconds | ||
| `tagCount` | A count of the tags that channel set most recently | ||
| `tag#` | Consecutive arguments populated with one tag value each | ||
| `tags` | All tags in a `list` format | ||
| `tagsDelimited` | A comma separated list of all tags | ||
|
|
||
| :variables{name=TwitchUser disclosure} | ||
|
|
||
| ## C# Usage | ||
| :csharp-method | ||
| ::field-group | ||
| ::field{name="Source Type" type=Select} | ||
| - `Broadcaster` - The currently logged in broadcaster account | ||
| - `User` - User that invoked the action e.g. a raid leader, subscriber, point redeemer etc. | ||
| - `From Input` - This will take the next word proceeding the trigger as the username to lookup. This user does not have to be present in the channel | ||
| - `Variable` - Use the current value of an existing variable as the target | ||
| :: | ||
| ::field{name="Variable" type=Text} | ||
| If you selected `Variable` as your `Source Type`, enter the name of the variable you would like to read in | ||
| :: | ||
| :: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters