|
| Videos (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http) |
|
Task< DeleteVideosResponse > | DeleteVideosAsync (List< string > videoIds, string accessToken=null) |
| Deletes one or more videos. Videos are past broadcasts, Highlights, or uploads. More...
|
|
Task< GetVideosResponse > | GetVideosAsync (List< string > videoIds=null, string userId=null, string gameId=null, string after=null, string before=null, int first=20, string language=null, Period period=Period.All, VideoSort sort=VideoSort.Time, VideoType type=VideoType.All, string accessToken=null) |
| Gets video information by one or more video IDs, user ID, or game ID. More...
|
|
| ApiBase (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http) |
|
async ValueTask< string > | GetAccessTokenAsync (string accessToken=null) |
|
|
async Task< string > | TwitchGetAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchGetGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchPatchGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< string > | TwitchPatchAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< KeyValuePair< int, string > > | TwitchDeleteAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchPostGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchPostGenericModelAsync< T > (string resource, ApiVersion api, RequestModel model, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchDeleteGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< T > | TwitchPutGenericAsync< T > (string resource, ApiVersion api, string payload=null, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< string > | TwitchPutAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
async Task< KeyValuePair< int, string > > | TwitchPostAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null) |
|
Task | PutBytesAsync (string url, byte[] payload) |
|
async Task< T > | GetGenericAsync< T > (string url, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, ApiVersion api=ApiVersion.Helix, string clientId=null) |
|
readonly IApiSettings | Settings |
|
Task< DeleteVideosResponse > TwitchLib.Api.Helix.Videos.DeleteVideosAsync |
( |
List< string > |
videoIds, |
|
|
string |
accessToken = null |
|
) |
| |
Deletes one or more videos. Videos are past broadcasts, Highlights, or uploads.
Invalid Video IDs will be ignored (i.e. IDs provided that do not have a video associated with it).
If the OAuth user token does not have permission to delete even one of the valid Video IDs, no videos will be deleted and the response will return a 401.
Required scope: channel:manage:videos
- Parameters
-
videoIds | ID of the video(s) to be deleted. Maximum: 5 |
accessToken | optional access token to override the use of the stored one in the TwitchAPI instance |
- Returns
- Exceptions
-
Task< GetVideosResponse > TwitchLib.Api.Helix.Videos.GetVideosAsync |
( |
List< string > |
videoIds = null , |
|
|
string |
userId = null , |
|
|
string |
gameId = null , |
|
|
string |
after = null , |
|
|
string |
before = null , |
|
|
int |
first = 20 , |
|
|
string |
language = null , |
|
|
Period |
period = Period.All , |
|
|
VideoSort |
sort = VideoSort.Time , |
|
|
VideoType |
type = VideoType.All , |
|
|
string |
accessToken = null |
|
) |
| |
Gets video information by one or more video IDs, user ID, or game ID.
For lookup by user or game, several filters are available that can be specified as query parameters.
Each request must specify one or more videoIds, one userId, or one gameId.
- Parameters
-
videoIds | IDs of the videos to query. Maximum: 100. |
userId | ID of the user who owns the video. |
gameId | ID of the game the video is of. |
after | Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. |
before | Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. |
first | Number of values to be returned when getting videos by user or game ID. Maximum: 100. Default: 20. |
language | Language of the video being queried. A language value must be either the ISO 639-1 two-letter code for a supported stream language or “other”. |
period | Period during which the video was created. |
sort | Sort order of the videos. |
type | Type of video. |
accessToken | optional access token to override the use of the stored one in the TwitchAPI instance |
- Returns
- Exceptions
-
BadParameterException | |
ArgumentOutOfRangeException | |