Interface TwitchKraken
Kraken is already deprecated, so we only offer methods which haven't been added to the new helix api yet. Please use the helix api if available.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final URI
Deprecated.The default baseUrl to pass touploadVideoPart(URI, String, String, int, byte[])
andcompleteVideoUpload(URI, String, String)
-
Method Summary
Modifier and TypeMethodDescriptioncom.netflix.hystrix.HystrixCommand<Object>
Deprecated.com.netflix.hystrix.HystrixCommand<KrakenCollectionItem>
addItemToCollection
(String token, String collectionId, String videoId) Deprecated.Add Item to Collectioncom.netflix.hystrix.HystrixCommand<Void>
approveAutomodMessage
(String authToken, String msgId) Deprecated.in favor of TwitchHelix#manageAutoModHeldMessagecom.netflix.hystrix.HystrixCommand<KrakenBlockTransaction>
Deprecated.Block Userdefault com.netflix.hystrix.HystrixCommand<Void>
completeVideoUpload
(String videoId, String uploadToken) Deprecated.Complete Video Uploadcom.netflix.hystrix.HystrixCommand<Void>
completeVideoUpload
(URI baseUrl, String videoId, String uploadToken) Deprecated.com.netflix.hystrix.HystrixCommand<KrakenCollectionMetadata>
createCollection
(String token, String channelId, String title) Deprecated.Create Collectioncom.netflix.hystrix.HystrixCommand<Void>
createCollectionThumbnail
(String token, String collectionId, String itemId) Deprecated.Create Collection Thumbnailcom.netflix.hystrix.HystrixCommand<KrakenCreatedVideo>
createVideo
(String authToken, String channelId, String title, String description, String game, String language, List<String> tags, String viewable, Instant viewableAt) Deprecated.Create Videocom.netflix.hystrix.HystrixCommand<Void>
deleteCollection
(String token, String collectionId) Deprecated.Delete Collectioncom.netflix.hystrix.HystrixCommand<Void>
deleteItemFromCollection
(String token, String collectionId, String itemId) Deprecated.Delete Item from Collectioncom.netflix.hystrix.HystrixCommand<Void>
deleteVideo
(String authToken, String videoId) Deprecated.Delete Videocom.netflix.hystrix.HystrixCommand<Void>
denyAutomodMessage
(String authToken, String msgId) Deprecated.in favor of TwitchHelix#manageAutoModHeldMessagecom.netflix.hystrix.HystrixCommand<EmoticonList>
Deprecated.Gets all chat emoticons (including their images).com.netflix.hystrix.HystrixCommand<KrakenTeamList>
getAllTeams
(Integer limit, Integer offset) Deprecated.Get All Teamscom.netflix.hystrix.HystrixCommand<KrakenUserList>
getChannelEditors
(String authToken, String channelId) Deprecated.Get Channel Editorscom.netflix.hystrix.HystrixCommand<KrakenFollowList>
getChannelFollowers
(String channelId, Integer limit, Integer offset, String cursor, String direction) Deprecated.Get Channel Followerscom.netflix.hystrix.HystrixCommand<KrakenSubscriptionList>
getChannelSubscribers
(String authToken, String channelId, Integer limit, Integer offset, String direction) Deprecated.Get Channel Subscriberscom.netflix.hystrix.HystrixCommand<KrakenTeamList>
getChannelTeams
(String channelId) Deprecated.in favor of TwitchHelix#getChannelTeamscom.netflix.hystrix.HystrixCommand<ChatBadges>
getChatBadgesByChannel
(String channelId) Deprecated.Gets a list of badges that can be used in chat for a specified channel.com.netflix.hystrix.HystrixCommand<SimpleEmoticonList>
Deprecated.Gets all chat emoticons (not including their images).com.netflix.hystrix.HystrixCommand<EmoticonSetList>
getChatEmoticonsBySet
(Collection<Integer> emoteSets) Deprecated.Gets all chat emoticons (not including their images) in one or more specified sets.com.netflix.hystrix.HystrixCommand<KrakenClip>
Deprecated.Get Clipcom.netflix.hystrix.HystrixCommand<KrakenCollection>
getCollection
(String collectionId) Deprecated.Get Collectioncom.netflix.hystrix.HystrixCommand<KrakenCollectionMetadata>
getCollectionMetadata
(String collectionId) Deprecated.Get Collection Metadatacom.netflix.hystrix.HystrixCommand<KrakenCollectionList>
getCollectionsByChannel
(String channelId, Integer limit, String cursor, String videoId) Deprecated.Get Collections by Channelcom.netflix.hystrix.HystrixCommand<KrakenHostList>
getHostsOf
(String channelId) Deprecated.Decommissioned by Twitch.com.netflix.hystrix.HystrixCommand<KrakenIngestList>
Deprecated.Get Ingest Server Listcom.netflix.hystrix.HystrixCommand<KrakenTeam>
getTeamByName
(String name) Deprecated.in favor of TwitchHelix#getTeamscom.netflix.hystrix.HystrixCommand<KrakenUser>
Deprecated.Gets a user object based on the OAuth token provided.com.netflix.hystrix.HystrixCommand<KrakenBlockList>
getUserBlockList
(String authToken, String userId, Integer limit, Integer offset) Deprecated.Get User Block Listcom.netflix.hystrix.HystrixCommand<KrakenUser>
getUserById
(String userId) Deprecated.Gets a specified user object.com.netflix.hystrix.HystrixCommand<KrakenEmoticonSetList>
getUserEmotes
(String authToken, String userId) Deprecated.Get User Emotescom.netflix.hystrix.HystrixCommand<KrakenUserList>
getUsersByLogin
(List<String> logins) Deprecated.Get Userscom.netflix.hystrix.HystrixCommand<Void>
moveItemWithinCollection
(String token, String collectionId, String itemId, Integer position) Deprecated.Move Item within Collectioncom.netflix.hystrix.HystrixCommand<KrakenChannel>
resetChannelStreamKey
(String authToken, String channelId) Deprecated.Reset Channel Stream Keycom.netflix.hystrix.HystrixCommand<Void>
unblockUser
(String authToken, String sourceUserId, String targetUserId) Deprecated.Unblock Usercom.netflix.hystrix.HystrixCommand<Void>
updateCollection
(String token, String collectionId, String title) Deprecated.Update Collectioncom.netflix.hystrix.HystrixCommand<Object>
updateTitle
(String authToken, String channelId, String title) Deprecated.in favor of TwitchHelix#updateChannelInformationcom.netflix.hystrix.HystrixCommand<KrakenVideo>
updateVideo
(String authToken, String videoId, String description, String game, String language, List<String> tags, String title) Deprecated.Update Videodefault com.netflix.hystrix.HystrixCommand<Void>
uploadVideoPart
(String videoId, String uploadToken, int partIndex, byte[] videoPart) Deprecated.Upload Video Partcom.netflix.hystrix.HystrixCommand<Void>
uploadVideoPart
(URI baseUrl, String videoId, String uploadToken, int partIndex, byte[] videoPart) Deprecated.
-
Field Details
-
UPLOADS_BASE_URL
Deprecated.The default baseUrl to pass touploadVideoPart(URI, String, String, int, byte[])
andcompleteVideoUpload(URI, String, String)
-
-
Method Details
-
getChannelEditors
com.netflix.hystrix.HystrixCommand<KrakenUserList> getChannelEditors(String authToken, String channelId) Deprecated.Get Channel EditorsGets a list of users who are editors for a specified channel.
- Parameters:
authToken
- User Access Token (scope: channel_read)channelId
- The ID of the channel to retrieve editors from- Returns:
KrakenUserList
-
getChannelFollowers
com.netflix.hystrix.HystrixCommand<KrakenFollowList> getChannelFollowers(String channelId, Integer limit, Integer offset, String cursor, String direction) Deprecated.Get Channel FollowersGets a list of users who follow a specified channel, sorted by the date when they started following the channel (newest first, unless specified otherwise).
- Parameters:
channelId
- Channel Idlimit
- Maximum number of objects to return. Default: 25. Maximum: 100.offset
- Object offset for pagination of results. Default: 0.cursor
- Tells the server where to start fetching the next set of results, in a multi-page response.direction
- Direction of sorting. Valid values: asc, desc (newest first). Default: desc.- Returns:
KrakenFollowList
-
resetChannelStreamKey
com.netflix.hystrix.HystrixCommand<KrakenChannel> resetChannelStreamKey(String authToken, String channelId) Deprecated.Reset Channel Stream KeyDeletes the stream key for a specified channel. Once it is deleted, the stream key is automatically reset.
- Parameters:
authToken
- User Access Token (scope: channel_stream)channelId
- Channel Id- Returns:
KrakenChannel
-
getChannelSubscribers
com.netflix.hystrix.HystrixCommand<KrakenSubscriptionList> getChannelSubscribers(String authToken, String channelId, Integer limit, Integer offset, String direction) Deprecated.Get Channel SubscribersGets a list of users subscribed to a specified channel, sorted by the date when they subscribed.
- Parameters:
authToken
- Auth TokenchannelId
- Channel Idlimit
- Maximum number of objects to return. Default: 25. Maximum: 100.offset
- Object offset for pagination of results. Default: 0.direction
- Sorting direction. Valid values: asc, desc. Default: asc (oldest first).- Returns:
- Object
-
getChatBadgesByChannel
Deprecated.Gets a list of badges that can be used in chat for a specified channel.- Parameters:
channelId
- The ID for the specific channel.- Returns:
- ChatBadges
-
getChatEmoticons
com.netflix.hystrix.HystrixCommand<SimpleEmoticonList> getChatEmoticons()Deprecated.Gets all chat emoticons (not including their images).Caution: this endpoint returns a large amount of data.
- Returns:
- SimpleEmoticonList
-
getChatEmoticonsBySet
com.netflix.hystrix.HystrixCommand<EmoticonSetList> getChatEmoticonsBySet(Collection<Integer> emoteSets) Deprecated.Gets all chat emoticons (not including their images) in one or more specified sets.- Parameters:
emoteSets
- Specifies the set(s) of emoticons to retrieve.- Returns:
- EmoticonSetList
-
getAllChatEmoticons
com.netflix.hystrix.HystrixCommand<EmoticonList> getAllChatEmoticons()Deprecated.Gets all chat emoticons (including their images).Caution: This endpoint returns a large amount of data.
- Returns:
- EmoticonList
-
approveAutomodMessage
@Unofficial @Deprecated com.netflix.hystrix.HystrixCommand<Void> approveAutomodMessage(String authToken, String msgId) Deprecated.in favor of TwitchHelix#manageAutoModHeldMessageApprove AutomodApprove a message that was flagged by Automod
- Parameters:
authToken
- Auth TokenmsgId
- unique id for the message- Returns:
- no content for a successful call
-
denyAutomodMessage
@Unofficial @Deprecated com.netflix.hystrix.HystrixCommand<Void> denyAutomodMessage(String authToken, String msgId) Deprecated.in favor of TwitchHelix#manageAutoModHeldMessageDeny AutomodDeny a message that was flagged by Automod
- Parameters:
authToken
- Auth TokenmsgId
- unique id for the message- Returns:
- no content for a successful call
-
getClip
Deprecated.Get ClipGets details about a specified clip.
- Parameters:
slug
- The globally unique string to reference the clip- Returns:
KrakenClip
-
getCollectionMetadata
com.netflix.hystrix.HystrixCommand<KrakenCollectionMetadata> getCollectionMetadata(String collectionId) Deprecated.Get Collection MetadataGets summary information about a specified collection.
- Parameters:
collectionId
- The ID of the collection. (Required)- Returns:
KrakenCollectionMetadata
-
getCollection
Deprecated.Get CollectionGets all items (videos) in a specified collection.
- Parameters:
collectionId
- The ID of the collection. (Required)- Returns:
KrakenCollection
-
getCollectionsByChannel
com.netflix.hystrix.HystrixCommand<KrakenCollectionList> getCollectionsByChannel(String channelId, Integer limit, String cursor, String videoId) Deprecated.Get Collections by ChannelGets all collections owned by a specified channel.
- Parameters:
channelId
- The ID of the channel. (Required)limit
- Maximum number of most-recent objects to return. (Optional)cursor
- Tells the server where to start fetching the next set of results in a multi-page response. (Optional)videoId
- Returns only collections containing the specified video. Example: "video:89917098". (Optional)- Returns:
KrakenCollectionList
-
createCollection
com.netflix.hystrix.HystrixCommand<KrakenCollectionMetadata> createCollection(String token, String channelId, String title) Deprecated.Create CollectionCreates a new collection owned by a specified channel.
- Parameters:
token
- User Access Token for the broadcaster or channel editor with the collections_edit scope. (Required)channelId
- The ID of the channel. (Required)title
- The title of the collection. (Required)- Returns:
KrakenCollectionMetadata
-
getHostsOf
@Unofficial @Deprecated com.netflix.hystrix.HystrixCommand<KrakenHostList> getHostsOf(String channelId) Deprecated.Decommissioned by Twitch.Get Hosts of a Target ChannelThis endpoint returns a "host" record for each channel hosting the channel with the provided targetId.
- Parameters:
channelId
- The user ID of the channel for which to get host information.- Returns:
- KrakenHostList
-
updateCollection
com.netflix.hystrix.HystrixCommand<Void> updateCollection(String token, String collectionId, String title) Deprecated.Update CollectionUpdates the title of a specified collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)title
- The new title of the collection. (Required)- Returns:
- 204 No Content upon a successful request
-
createCollectionThumbnail
com.netflix.hystrix.HystrixCommand<Void> createCollectionThumbnail(String token, String collectionId, String itemId) Deprecated.Create Collection ThumbnailAdds the thumbnail of a specified collection item as the thumbnail for the specified collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)itemId
- The id of a video which must already be in the collection. (Required)- Returns:
- 204 No Content upon a successful request
-
deleteCollection
Deprecated.Delete CollectionDeletes a specified collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)- Returns:
- 204 No Content upon a successful request
-
addItemToCollection
com.netflix.hystrix.HystrixCommand<KrakenCollectionItem> addItemToCollection(String token, String collectionId, String videoId) Deprecated.Add Item to CollectionAdds a specified video to a specified collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)videoId
- The id of a video. (Required)- Returns:
KrakenCollectionItem
-
deleteItemFromCollection
com.netflix.hystrix.HystrixCommand<Void> deleteItemFromCollection(String token, String collectionId, String itemId) Deprecated.Delete Item from CollectionDeletes a specified collection item from a specified collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)itemId
- The id of a collection item. (Required)- Returns:
- 204 No Content upon a successful request
-
moveItemWithinCollection
com.netflix.hystrix.HystrixCommand<Void> moveItemWithinCollection(String token, String collectionId, String itemId, Integer position) Deprecated.Move Item within CollectionMoves a specified collection item to a different position within a collection.
- Parameters:
token
- User Access Token with the collections_edit scope. (Required)collectionId
- The id of tne collection. (Required)itemId
- The id of a collection item. (Required)position
- The new position of the item. (Required)- Returns:
- 204 No Content upon a successful request
-
getUserBlockList
com.netflix.hystrix.HystrixCommand<KrakenBlockList> getUserBlockList(String authToken, String userId, Integer limit, Integer offset) Deprecated.Get User Block ListGets a specified user’s block list. List sorted by recency, newest first.
- Parameters:
authToken
- User Access Token (scope: user_blocks_read)userId
- The user ID associated with the tokenlimit
- Maximum number of objects in array. Default: 25. Maximum: 100.offset
- Object offset for pagination. Default: 0.- Returns:
KrakenBlockList
-
blockUser
com.netflix.hystrix.HystrixCommand<KrakenBlockTransaction> blockUser(String authToken, String sourceUserId, String targetUserId) Deprecated.Block UserBlocks a user; that is, adds a specified target user to the blocks list of a specified source user.
- Parameters:
authToken
- User Access Token (scope: user_blocks_edit)sourceUserId
- The ID of the user that is doing the blocking.targetUserId
- The ID of the user that is getting blocked by the source.- Returns:
KrakenBlockTransaction
-
unblockUser
com.netflix.hystrix.HystrixCommand<Void> unblockUser(String authToken, String sourceUserId, String targetUserId) Deprecated.Unblock UserUnblocks a user; that is, deletes a specified target user from the blocks list of a specified source user.
- Parameters:
authToken
- User Access Token (scope: user_blocks_edit)sourceUserId
- The ID of the user that is doing the unblocking.targetUserId
- The ID of the user that is getting unblocked by the source.- Returns:
- 204 No Content upon a successful request
-
getUserEmotes
com.netflix.hystrix.HystrixCommand<KrakenEmoticonSetList> getUserEmotes(String authToken, String userId) Deprecated.Get User EmotesGets a list of the emojis and emoticons that the specified user can use in chat. These are both the globally available ones and the channel-specific ones (which can be accessed by any user subscribed to the channel).
- Parameters:
authToken
- User Access Token (scope: user_subscriptions)userId
- The user ID associated with the token- Returns:
KrakenEmoticonSetList
-
addFollow
@Deprecated com.netflix.hystrix.HystrixCommand<Object> addFollow(String authToken, String userId, String targetUserId) Deprecated.Follow ChannelAdds a specified user to the followers of a specified channel.
- Parameters:
authToken
- Auth TokenuserId
- User IdtargetUserId
- Target User Id (the Channel the user will follow)- Returns:
- Object
-
getIngestServers
com.netflix.hystrix.HystrixCommand<KrakenIngestList> getIngestServers()Deprecated.Get Ingest Server ListThe Twitch ingesting system is the first stop for a broadcast stream. An ingest server receives your stream, and the ingesting system authorizes and registers streams, then prepares them for viewers.
- Returns:
- KrakenIngestList
-
getChannelTeams
Deprecated.in favor of TwitchHelix#getChannelTeamsGets a list of teams to which a specified channel belongs.- Parameters:
channelId
- Channel Id (Required)- Returns:
- KrakenTeamList
-
getAllTeams
Deprecated.Get All TeamsGets all active teams.
- Parameters:
limit
- Maximum number of objects to return, sorted by creation date. Default: 25. Maximum: 100.offset
- Object offset for pagination of results. Default: 0.- Returns:
- KrakenTeamList
-
getTeamByName
Deprecated.in favor of TwitchHelix#getTeamsGet TeamGets a specified team object.
- Parameters:
name
- team name- Returns:
- KrakenTeam
-
getUser
Deprecated.Gets a user object based on the OAuth token provided.Get User returns more data than Get User by ID, because Get User is privileged.
- Parameters:
authToken
- User access token with scope user_read (Required)- Returns:
- KrakenUser
-
getUserById
Deprecated.Gets a specified user object.- Parameters:
userId
- The id of the user being queried- Returns:
- KrakenUser
-
getUsersByLogin
Deprecated.Get UsersGets a list of specified user objects.
- Parameters:
logins
- User login name (lower case channelname/username). Multiple login names can be specified. Limit: 100.- Returns:
- KrakenUser
-
updateTitle
@Deprecated com.netflix.hystrix.HystrixCommand<Object> updateTitle(String authToken, String channelId, String title) Deprecated.in favor of TwitchHelix#updateChannelInformationUpdate titleUpdates the title of a specified channel.
- Parameters:
authToken
- Auth TokenchannelId
- Channel Idtitle
- New stream title- Returns:
- Object
-
createVideo
com.netflix.hystrix.HystrixCommand<KrakenCreatedVideo> createVideo(String authToken, String channelId, String title, String description, String game, String language, List<String> tags, String viewable, Instant viewableAt) Deprecated.Create VideoCreates a new video in a specified channel. Videos with the following formats can be uploaded:
- MP4, MOV, AVI and FLV file formats
- AAC audio
- h264 codec
- Up to 10Mbps bitrate
- Up to 1080p/60FPS
- Parameters:
authToken
- Auth Token (scope: channel_editor)channelId
- Channel Id (Required)title
- Title of the video. Maximum 100 characters. (Required)description
- Short description of the video. (Optional)game
- Name of the game in the video. (Optional)language
- Language of the video (for example, en). (Optional)tags
- Tags describing the video. Maximum: 100 characters per tag, 500 characters for the entire list. (Optional)viewable
- Specifies who can view the video. Valid values: public (the video is viewable by everyone) or private (the video is viewable only by the owner and channel editors). Default: public. (Optional)viewableAt
- Date when the video will become public. This takes effect only if viewable=private. (Optional)- Returns:
KrakenCreatedVideo
-
uploadVideoPart
com.netflix.hystrix.HystrixCommand<Void> uploadVideoPart(URI baseUrl, String videoId, String uploadToken, int partIndex, byte[] videoPart) Deprecated. -
uploadVideoPart
default com.netflix.hystrix.HystrixCommand<Void> uploadVideoPart(String videoId, String uploadToken, int partIndex, byte[] videoPart) Deprecated.Upload Video PartUploads part of a video. Each part of a video is uploaded with a separate request.
- Parameters:
videoId
- The video id returned bycreateVideo(String, String, String, String, String, String, List, String, Instant)
. (Required)uploadToken
- The upload token returned bycreateVideo(String, String, String, String, String, String, List, String, Instant)
. (Required)partIndex
- The location of the video part in the complete video. The value of this is 1-based. (Required)videoPart
- The body of the request is a byte[] that contains the video data. (Required)- Returns:
- 200 OK upon a successful part upload
-
completeVideoUpload
com.netflix.hystrix.HystrixCommand<Void> completeVideoUpload(URI baseUrl, String videoId, String uploadToken) Deprecated. -
completeVideoUpload
default com.netflix.hystrix.HystrixCommand<Void> completeVideoUpload(String videoId, String uploadToken) Deprecated.Complete Video UploadAfter you upload all the parts of a video, you complete the upload process with this endpoint.
- Parameters:
videoId
- The video id returned bycreateVideo(String, String, String, String, String, String, List, String, Instant)
. (Required)uploadToken
- The upload token returned bycreateVideo(String, String, String, String, String, String, List, String, Instant)
. (Required)- Returns:
- 200 OK upon a successful POST
-
updateVideo
com.netflix.hystrix.HystrixCommand<KrakenVideo> updateVideo(String authToken, String videoId, String description, String game, String language, List<String> tags, String title) Deprecated.Update VideoUpdates information about a specified video that was already created.
- Parameters:
authToken
- Auth Token. (scope: channel_editor)videoId
- Video ID. (Required)description
- Short description of the video. (Optional)game
- Name of the game in the video.language
- Language of the video (for example, en).tags
- Tags describing the video. Maximum: 100 characters per tag, 500 characters for the entire list.title
- tags describing the video (for example, “airplanes,scary”). Maximum: 100 characters per tag, 500 characters for the entire list.- Returns:
KrakenVideo
, the updated video
-
deleteVideo
Deprecated.Delete VideoDeletes a specified video (can be a VOD, highlight, or upload).
- Parameters:
authToken
- Auth Token. (scope: channel_editor)videoId
- Video ID. (Required)- Returns:
- 200 OK upon a successful call
-