teams - YoYoGames/GMEXT-Twitch GitHub Wiki
These are the functions of this module:
Twitch Endpoint: Get Channel Teams
This function gets the list of Twitch teams that the broadcaster is a member of.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.
Syntax:
twitch_teams_get_channel_teams(broadcaster_id, callback_success, callback_failed)
Argument | Type | Description |
---|---|---|
broadcaster_id | String | The ID of the broadcaster whose teams you want to get. |
callback_success | Function | Triggered if the request succeeded |
callback_failed | Function | Triggered if the request failed |
Returns:
N/A
Triggers:
These members are returned in the success callback:
Member | Type | Description |
---|---|---|
data | Array | The list of teams that the broadcaster is a member of. Returns an empty array if the broadcaster is not a member of a team. |
├── broadcaster_id | String | An ID that identifies the broadcaster. |
├── broadcaster_login | String | The broadcaster's login name. |
├── broadcaster_name | String | The broadcaster's display name. |
├── background_image_url | String | A URL to the team's background image. |
├── banner | String | A URL to the team's banner. |
├── created_at | String | The UTC date and time (in RFC3339 format) of when the team was created. |
├── updated_at | String | The UTC date and time (in RFC3339 format) of the last time the team was updated. |
├── info | String | The team's description. The description may contain formatting such as Markdown, HTML, newline (\n) characters, etc. |
├── thumbnail_url | String | A URL to a thumbnail image of the team's logo. |
├── team_name | String | The team's name. |
├── team_display_name | String | The team's display name. |
└── id | String | An ID that identifies the team. |
This method is triggered on failure.
Twitch Endpoint: Get Teams
This function gets information about the specified Twitch team. Read More
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.
Syntax:
twitch_teams_get_teams(name, id, callback_success, callback_failed)
Argument | Type | Description |
---|---|---|
name | String | The name of the team to get. This parameter and the id parameter are mutually exclusive; you must specify the team's name or ID but not both. |
id | String | The ID of the team to get. This parameter and the name parameter are mutually exclusive; you must specify the team's name or ID but not both. |
callback_success | Function | Triggered if the request succeeded |
callback_failed | Function | Triggered if the request failed |
Returns:
N/A
Triggers:
These members are returned in the success callback:
Member | Type | Description |
---|---|---|
data | Array | A list that contains the single team that you requested. |
├── users | Array | The list of team members. |
├── user_id | String | An ID that identifies the team member. |
├── user_login | String | The team member's login name. |
└── user_name | String | The team member's display name. |
├── background_image_url | String | A URL to the team's background image. |
├── banner | String | A URL to the team's banner. |
├── created_at | String | The UTC date and time (in RFC3339 format) of when the team was created. |
├── updated_at | String | The UTC date and time (in RFC3339 format) of the last time the team was updated. |
├── info | String | The team's description. The description may contain formatting such as Markdown, HTML, newline (\n) characters, etc. |
├── thumbnail_url | String | A URL to a thumbnail image of the team's logo. |
├── team_name | String | The team's name. |
├── team_display_name | String | The team's display name. |
└── id | String | An ID that identifies the team. |
This method is triggered on failure.