Package com.github.twitch4j.helix

Interface TwitchHelix

public interface TwitchHelix
Twitch - Helix API

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.net.URI INGESTS_BASE_URL
    The default baseUrl to pass to getIngestServers(URI).

  • Method Summary

    Modifier and Type Method Description
    com.netflix.hystrix.HystrixCommand<java.lang.Void> blockUser​(java.lang.String authToken, java.lang.String targetUserId, java.lang.String sourceContext, java.lang.String reason)
    Blocks the specified user on behalf of the authenticated user.
    com.netflix.hystrix.HystrixCommand<AutomodEnforceStatusList> checkAutomodStatus​(java.lang.String authToken, java.lang.String broadcasterId, AutomodEnforceCheckList messages)
    Determines whether a string message meets the channel’s AutoMod requirements.
    com.netflix.hystrix.HystrixCommand<SubscriptionList> checkUserSubscription​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String userId)
    Checks if a specific user (user_id) is subscribed to a specific channel (broadcaster_id).
    com.netflix.hystrix.HystrixCommand<CreateClipList> createClip​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Boolean hasDelay)
    Creates a clip programmatically.
    com.netflix.hystrix.HystrixCommand<CustomRewardList> createCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, CustomReward newReward)
    Creates a Custom Reward on a channel.
    com.netflix.hystrix.HystrixCommand<UploadEntitlementUrlList> createEntitlementUploadUrl​(java.lang.String authToken, java.lang.String manifestId, java.lang.String type)
    Creates a URL where you can upload a manifest file and notify users that they have an entitlement
    com.netflix.hystrix.HystrixCommand<EventSubSubscriptionList> createEventSubSubscription​(java.lang.String authToken, com.github.twitch4j.eventsub.EventSubSubscription subscription)
    Creates an EventSub subscription.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> createFollow​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId, boolean allowNotifications)
    Adds a specified user to the followers of a specified channel
    com.netflix.hystrix.HystrixCommand<PollsList> createPoll​(java.lang.String authToken, Poll poll)
    Create a poll for a specific Twitch channel.
    com.netflix.hystrix.HystrixCommand<PredictionsList> createPrediction​(java.lang.String authToken, Prediction prediction)
    Create a Channel Points Prediction for a specific Twitch channel.
    com.netflix.hystrix.HystrixCommand<StreamMarker> createStreamMarker​(java.lang.String authToken, Highlight highlight)
    Creates a marker at the current time during a live stream.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId)
    Deletes a Custom Reward on a channel.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteEventSubSubscription​(java.lang.String authToken, java.lang.String subscriptionId)
    Delete an EventSub subscription.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteFollow​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId)
    Deletes a specified user from the followers of a specified channel
    com.netflix.hystrix.HystrixCommand<DeletedVideoList> deleteVideos​(java.lang.String authToken, java.util.List<java.lang.String> ids)
    Deletes one or more videos.
    com.netflix.hystrix.HystrixCommand<PollsList> endPoll​(java.lang.String authToken, Poll poll)
    End a poll that is currently active.
    com.netflix.hystrix.HystrixCommand<PredictionsList> endPrediction​(java.lang.String authToken, Prediction prediction)
    Lock, resolve, or cancel a Channel Points Prediction.
    com.netflix.hystrix.HystrixCommand<StreamTagList> getAllStreamTags​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.util.List<java.util.UUID> tagIds)
    Gets available Twitch stream tags.
    com.netflix.hystrix.HystrixCommand<BannedEventList> getBannedEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.Integer limit)
    Returns all user bans and un-bans in a channel.
    default com.netflix.hystrix.HystrixCommand<BannedUserList> getBannedUsers​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.String before)
    Deprecated.
    in favor of getBannedUsers(String, String, List, String, String, Integer) where the last param is the number of objects to retrieve.
    com.netflix.hystrix.HystrixCommand<BannedUserList> getBannedUsers​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.String before, java.lang.Integer limit)
    Returns all banned and timed-out users in a channel.
    com.netflix.hystrix.HystrixCommand<BitsLeaderboard> getBitsLeaderboard​(java.lang.String authToken, java.lang.Integer count, java.lang.String period, java.lang.String startedAt, java.lang.String userId)
    Gets a ranked list of Bits leaderboard information for an authorized broadcaster.
    default com.netflix.hystrix.HystrixCommand<BitsLeaderboard> getBitsLeaderboard​(java.lang.String authToken, java.lang.String count, java.lang.String period, java.lang.String startedAt, java.lang.String userId)
    Deprecated.
    utilize getBitsLeaderboard where count is an Integer
    com.netflix.hystrix.HystrixCommand<ChatBadgeSetList> getChannelChatBadges​(java.lang.String authToken, java.lang.String broadcasterId)
    Gets a list of custom chat badges that can be used in chat for the specified channel.
    com.netflix.hystrix.HystrixCommand<ChannelEditorList> getChannelEditors​(java.lang.String authToken, java.lang.String broadcasterId)
    Gets a list of users who have editor permissions for a specific channel.
    com.netflix.hystrix.HystrixCommand<ChannelInformationList> getChannelInformation​(java.lang.String authToken, java.util.List<java.lang.String> broadcasterIds)
    Gets channel information for users
    com.netflix.hystrix.HystrixCommand<TeamMembershipList> getChannelTeams​(java.lang.String authToken, java.lang.String broadcasterId)
    Retrieves a list of Twitch Teams of which the specified channel/broadcaster is a member.
    com.netflix.hystrix.HystrixCommand<CheermoteList> getCheermotes​(java.lang.String authToken, java.lang.String broadcasterId)
    Retrieves the list of available Cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat
    com.netflix.hystrix.HystrixCommand<ClipList> getClips​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String gameId, java.lang.String id, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.time.Instant startedAt, java.time.Instant endedAt)
    Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).
    com.netflix.hystrix.HystrixCommand<CodeStatusList> getCodeStatus​(java.lang.String authToken, java.util.List<java.lang.String> code, java.lang.Integer userId)
    Gets the status of one or more provided codes.
    com.netflix.hystrix.HystrixCommand<CustomRewardRedemptionList> getCustomRewardRedemption​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, java.util.Collection<java.lang.String> redemptionIds, com.github.twitch4j.eventsub.domain.RedemptionStatus status, java.lang.String sort, java.lang.String after, java.lang.Integer limit)
    Returns Custom Reward Redemption objects for a Custom Reward on a channel that was created by the same client_id.
    com.netflix.hystrix.HystrixCommand<CustomRewardList> getCustomRewards​(java.lang.String authToken, java.lang.String broadcasterId, java.util.Collection<java.lang.String> rewardIds, java.lang.Boolean onlyManageableRewards)
    Returns a list of Custom Reward objects for the Custom Rewards on a channel.
    com.netflix.hystrix.HystrixCommand<DropsEntitlementList> getDropsEntitlements​(java.lang.String authToken, java.lang.String id, java.lang.String userId, java.lang.String gameId, java.lang.String after, java.lang.Integer limit)
    Gets a list of entitlements for a given organization that have been granted to a game, user, or both.
    com.netflix.hystrix.HystrixCommand<EventSubSubscriptionList> getEventSubSubscriptions​(java.lang.String authToken, com.github.twitch4j.eventsub.EventSubSubscriptionStatus status, java.lang.String after, java.lang.Integer limit)
    Get a list of your EventSub subscriptions.
    com.netflix.hystrix.HystrixCommand<ExtensionAnalyticsList> getExtensionAnalyticUrl​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.lang.String extensionId, java.lang.String type, java.lang.String startedAt, java.lang.String endedAt)
    Gets a URL that extension developers can use to download analytics reports (CSV files) for their extensions.
    com.netflix.hystrix.HystrixCommand<ExtensionTransactionList> getExtensionTransactions​(java.lang.String authToken, java.lang.String extensionId, java.util.List<java.lang.String> transactionIds, java.lang.String after, java.lang.Integer limit)
    Get Extension Transactions allows extension back end servers to fetch a list of transactions that have occurred for their extension across all of Twitch.
    com.netflix.hystrix.HystrixCommand<StreamList> getFollowedStreams​(java.lang.String authToken, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
    Gets information about active streams belonging to channels that the authenticated user follows.
    com.netflix.hystrix.HystrixCommand<FollowList> getFollowers​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId, java.lang.String after, java.lang.Integer limit)
    Get Followers
    com.netflix.hystrix.HystrixCommand<GameAnalyticsList> getGameAnalyticUrl​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.lang.String gameId, java.lang.String type, java.lang.String startedAt, java.lang.String endedAt)
    Gets a URL that game developers can use to download analytics reports (CSV files) for their games.
    com.netflix.hystrix.HystrixCommand<GameList> getGames​(java.lang.String authToken, java.util.List<java.lang.String> id, java.util.List<java.lang.String> name)
    Gets game information by game ID or name.
    com.netflix.hystrix.HystrixCommand<ChatBadgeSetList> getGlobalChatBadges​(java.lang.String authToken)
    Gets a list of chat badges that can be used in chat for any channel.
    com.netflix.hystrix.HystrixCommand<HypeTrainEventList> getHypeTrainEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Integer limit, java.lang.String id, java.lang.String after)
    Gets the information of the most recent Hype Train of the given channel ID.
    default com.netflix.hystrix.HystrixCommand<IngestServerList> getIngestServers()
    Get Ingest Servers returns a list of endpoints for ingesting live video into Twitch.
    com.netflix.hystrix.HystrixCommand<IngestServerList> getIngestServers​(java.net.URI baseUrl)  
    default com.netflix.hystrix.HystrixCommand<ModeratorEventList> getModeratorEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after)
    Deprecated.
    in favor of getModeratorEvents(String, String, List, String, Integer) where the last param is the number of objects to retrieve.
    com.netflix.hystrix.HystrixCommand<ModeratorEventList> getModeratorEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after, java.lang.Integer limit)
    Returns a list of moderators or users added and removed as moderators from a channel.
    default com.netflix.hystrix.HystrixCommand<ModeratorList> getModerators​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after)
    Deprecated.
    in favor of getModerators(String, String, List, String, Integer) where the last param is the number of objects to retrieve.
    com.netflix.hystrix.HystrixCommand<ModeratorList> getModerators​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after, java.lang.Integer limit)
    Returns all moderators in a channel.
    com.netflix.hystrix.HystrixCommand<PollsList> getPolls​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> pollIds, java.lang.String after, java.lang.Integer limit)
    Get information about all polls or specific polls for a Twitch channel.
    com.netflix.hystrix.HystrixCommand<PredictionsList> getPredictions​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> predictionId, java.lang.String after, java.lang.Integer limit)
    Get information about all Channel Points Predictions or specific Channel Points Predictions for a Twitch channel.
    com.netflix.hystrix.HystrixCommand<StreamKeyList> getStreamKey​(java.lang.String authToken, java.lang.String broadcasterId)
    Gets the channel stream key for a user
    com.netflix.hystrix.HystrixCommand<StreamMarkersList> getStreamMarkers​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.lang.String userId, java.lang.String videoId)
    Gets a list of markers for either a specified user’s most recent stream or a specified VOD/video (stream), ordered by recency.
    com.netflix.hystrix.HystrixCommand<StreamList> getStreams​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.util.List<java.lang.String> gameIds, java.util.List<java.lang.String> language, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userLogins)
    Gets information about active streams.
    default com.netflix.hystrix.HystrixCommand<StreamList> getStreams​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.util.List<java.util.UUID> communityId, java.util.List<java.lang.String> gameIds, java.lang.String language, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userLogins)
    Deprecated.
    in favor of getStreams(String, String, String, Integer, List, List, List, List); simply remove the argument for communityId to migrate
    com.netflix.hystrix.HystrixCommand<StreamTagList> getStreamTags​(java.lang.String authToken, java.lang.String broadcasterId)
    Gets stream tags which are active on the specified stream.
    com.netflix.hystrix.HystrixCommand<SubscriptionEventList> getSubscriptionEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String id, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
    Returns all subscription events for the past five days.
    com.netflix.hystrix.HystrixCommand<SubscriptionList> getSubscriptions​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String after, java.lang.String before, java.lang.Integer limit)
    Get all subscribers of a channel
    com.netflix.hystrix.HystrixCommand<SubscriptionList> getSubscriptionsByUser​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds)
    Check subscription status of provided user IDs (one or more) for a given channel
    com.netflix.hystrix.HystrixCommand<TeamList> getTeams​(java.lang.String authToken, java.lang.String name, java.lang.String id)
    Gets information for a specific Twitch Team.
    com.netflix.hystrix.HystrixCommand<GameTopList> getTopGames​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.String first)
    Gets games sorted by number of current viewers on Twitch, most popular first.
    com.netflix.hystrix.HystrixCommand<ExtensionActiveList> getUserActiveExtensions​(java.lang.String authToken, java.lang.String userId)
    Get User Active Extensions
    com.netflix.hystrix.HystrixCommand<BlockedUserList> getUserBlockList​(java.lang.String authToken, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
    Gets a specified user’s block list.
    com.netflix.hystrix.HystrixCommand<ExtensionList> getUserExtensions​(java.lang.String authToken)
    Get User Extensions
    com.netflix.hystrix.HystrixCommand<UserList> getUsers​(java.lang.String authToken, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userNames)
    Get Users
    com.netflix.hystrix.HystrixCommand<VideoList> getVideos​(java.lang.String authToken, java.lang.String id, java.lang.String userId, java.lang.String gameId, java.lang.String language, java.lang.String period, java.lang.String sort, java.lang.String type, java.lang.String after, java.lang.String before, java.lang.Integer limit)
    Get Videos
    com.netflix.hystrix.HystrixCommand<WebhookSubscriptionList> getWebhookSubscriptions​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit)
    Get Webhook Subscriptions
    com.netflix.hystrix.HystrixCommand<java.lang.Void> manageAutoModHeldMessage​(java.lang.String authToken, java.lang.String moderatorId, java.lang.String messageId, AutoModHeldMessageAction action)
    Allow or deny a message that was held for review by AutoMod.
    com.netflix.hystrix.HystrixCommand<CodeStatusList> redeemCode​(java.lang.String authToken, java.util.List<java.lang.String> code, java.lang.Integer userId)
    Redeems one or more provided codes to the authenticated Twitch user.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> replaceStreamTags​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.util.UUID> tagIds)
    Replaces the active stream tags on the specified stream with the specified tags (or clears all tags, if no new tags are specified).
    com.netflix.hystrix.HystrixCommand<feign.Response> requestWebhookSubscription​(WebhookRequest request, java.lang.String authToken)
    Subscribe to or unsubscribe from events for a specified topic.
    com.netflix.hystrix.HystrixCommand<CategorySearchList> searchCategories​(java.lang.String authToken, java.lang.String query, java.lang.Integer limit, java.lang.String after)
    Returns a list of games or categories that match the query via name either entirely or partially
    com.netflix.hystrix.HystrixCommand<ChannelSearchList> searchChannels​(java.lang.String authToken, java.lang.String query, java.lang.Integer limit, java.lang.String after, java.lang.Boolean liveOnly)
    Returns a list of channels (those that have streamed within the past 6 months) that match the query either entirely or partially
    com.netflix.hystrix.HystrixCommand<CommercialList> startCommercial​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Integer length)
    Starts a commercial on a specified channel
    com.netflix.hystrix.HystrixCommand<java.lang.Void> unblockUser​(java.lang.String authToken, java.lang.String targetUserId)
    Unblocks the specified user on behalf of the authenticated user.
    com.netflix.hystrix.HystrixCommand<java.lang.Void> updateChannelInformation​(java.lang.String authToken, java.lang.String broadcasterId, ChannelInformation channelInformation)
    Modifies channel information for users
    com.netflix.hystrix.HystrixCommand<CustomRewardList> updateCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, CustomReward updatedReward)
    Updates a Custom Reward created on a channel.
    com.netflix.hystrix.HystrixCommand<CustomRewardRedemptionList> updateRedemptionStatus​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, java.util.Collection<java.lang.String> redemptionIds, com.github.twitch4j.eventsub.domain.RedemptionStatus newStatus)
    Updates the status of Custom Reward Redemption objects on a channel that are in the UNFULFILLED status.
    com.netflix.hystrix.HystrixCommand<UserList> updateUser​(java.lang.String authToken, java.lang.String description)
    Update User
    com.netflix.hystrix.HystrixCommand<ExtensionActiveList> updateUserExtensions​(java.lang.String authToken, ExtensionActiveList extensions)
    Updates the activation state, extension ID, and/or version number of installed extensions for a specified user, identified by a Bearer token.

  • Field Details

    • INGESTS_BASE_URL

      static final java.net.URI INGESTS_BASE_URL
      The default baseUrl to pass to getIngestServers(URI).

  • Method Details

    • getExtensionAnalyticUrl

      com.netflix.hystrix.HystrixCommand<ExtensionAnalyticsList> getExtensionAnalyticUrl​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.lang.String extensionId, java.lang.String type, java.lang.String startedAt, java.lang.String endedAt)
      Gets a URL that extension developers can use to download analytics reports (CSV files) for their extensions. The URL is valid for 5 minutes.

      For detail about analytics and the fields returned, see the Insights and Analytics guide.

      Parameters:
      authToken - Auth Token
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      extensionId - Client ID value assigned to the extension when it is created. If this is specified, the returned URL points to an analytics report for just the specified extension.
      type - Type of analytics report that is returned. If this is specified, the response includes one URL, for the specified report type. If this is not specified, the response includes multiple URLs (paginated), one for each report type available for the authenticated user’s Extensions. Limit: 1. Valid values: "overview_v1", "overview_v2".
      startedAt - Starting date/time for returned reports, in RFC3339 format with the hours, minutes, and seconds zeroed out and the UTC timezone: YYYY-MM-DDT00:00:00Z.
      endedAt - Ending date/time for returned reports, in RFC3339 format with the hours, minutes, and seconds zeroed out and the UTC timezone: YYYY-MM-DDT00:00:00Z.
      Returns:
      ExtensionAnalyticsList

    • getGameAnalyticUrl

      com.netflix.hystrix.HystrixCommand<GameAnalyticsList> getGameAnalyticUrl​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.lang.String gameId, java.lang.String type, java.lang.String startedAt, java.lang.String endedAt)
      Gets a URL that game developers can use to download analytics reports (CSV files) for their games. The URL is valid for 5 minutes.

      For detail about analytics and the fields returned, see the Insights and Analytics guide.

      Parameters:
      authToken - Auth Token
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      gameId - Game ID. If this is specified, the returned URL points to an analytics report for just the specified game.
      type - Type of analytics report that is returned. If this is specified, the response includes one URL, for the specified report type. If this is not specified, the response includes multiple URLs (paginated), one for each report type available for the authenticated user’s Extensions. Limit: 1. Valid values: "overview_v1", "overview_v2".
      startedAt - Starting date/time for returned reports, in RFC3339 format with the hours, minutes, and seconds zeroed out and the UTC timezone: YYYY-MM-DDT00:00:00Z.
      endedAt - Ending date/time for returned reports, in RFC3339 format with the hours, minutes, and seconds zeroed out and the UTC timezone: YYYY-MM-DDT00:00:00Z.
      Returns:
      GameAnalyticsList

    • getCheermotes

      com.netflix.hystrix.HystrixCommand<CheermoteList> getCheermotes​(java.lang.String authToken, java.lang.String broadcasterId)
      Retrieves the list of available Cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat
      Parameters:
      authToken - Auth Token
      broadcasterId - ID for the broadcaster who might own specialized Cheermotes (optional)
      Returns:
      CheermoteList

    • getBitsLeaderboard

      com.netflix.hystrix.HystrixCommand<BitsLeaderboard> getBitsLeaderboard​(java.lang.String authToken, java.lang.Integer count, java.lang.String period, java.lang.String startedAt, java.lang.String userId)
      Gets a ranked list of Bits leaderboard information for an authorized broadcaster.
      Parameters:
      authToken - Auth Token
      count - Number of results to be returned. Maximum: 100. Default: 10.
      period - Time period over which data is aggregated (PST time zone). This parameter interacts with started_at. Valid values are given below. Default: "all".
      startedAt - Timestamp for the period over which the returned data is aggregated. Must be in RFC 3339 format. If this is not provided, data is aggregated over the current period; e.g., the current day/week/month/year. This value is ignored if period is "all".
      userId - ID of the user whose results are returned; i.e., the person who paid for the Bits.
      Returns:
      BitsLeaderboard

    • getBitsLeaderboard

      @Deprecated default com.netflix.hystrix.HystrixCommand<BitsLeaderboard> getBitsLeaderboard​(java.lang.String authToken, java.lang.String count, java.lang.String period, java.lang.String startedAt, java.lang.String userId)
      Deprecated.
      utilize getBitsLeaderboard where count is an Integer
      Gets a ranked list of Bits leaderboard information for an authorized broadcaster.
      Parameters:
      authToken - Auth Token
      count - Number of results to be returned. Maximum: 100. Default: 10.
      period - Time period over which data is aggregated (PST time zone). This parameter interacts with started_at. Valid values are given below. Default: "all".
      startedAt - Timestamp for the period over which the returned data is aggregated. Must be in RFC 3339 format. If this is not provided, data is aggregated over the current period; e.g., the current day/week/month/year. This value is ignored if period is "all".
      userId - ID of the user whose results are returned; i.e., the person who paid for the Bits.
      Returns:
      BitsLeaderboard

    • createCustomReward

      com.netflix.hystrix.HystrixCommand<CustomRewardList> createCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, CustomReward newReward)
      Creates a Custom Reward on a channel.

      Query parameter broadcaster_id must match the user_id in the User-Access token.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - The id of the target channel, which must match the token user id.
      newReward - The Custom Reward to be created.
      Returns:
      CustomRewardList

    • deleteCustomReward

      com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId)
      Deletes a Custom Reward on a channel.

      Only rewards created programmatically by the same client_id can be deleted. Any UNFULFILLED Custom Reward Redemptions of the deleted Custom Reward will be updated to the FULFILLED status.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - The id of the target channel, which must match the token user id.
      rewardId - ID of the Custom Reward to delete, must match a Custom Reward on broadcaster_id’s channel.
      Returns:
      204 No Content upon a successful deletion

    • getCustomRewards

      com.netflix.hystrix.HystrixCommand<CustomRewardList> getCustomRewards​(java.lang.String authToken, java.lang.String broadcasterId, java.util.Collection<java.lang.String> rewardIds, java.lang.Boolean onlyManageableRewards)
      Returns a list of Custom Reward objects for the Custom Rewards on a channel.

      Developers only have access to update and delete rewards that were created programmatically by the same/calling client_id.

      There is a limit of 50 Custom Rewards on a channel at a time. This includes both enabled and disabled Custom Rewards.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - Required: The id of the target channel, which must match the token user id.
      rewardIds - Optional: Filters the results to only returns reward objects for the Custom Rewards with matching ID. Maximum: 50.
      onlyManageableRewards - Optional: When set to true, only returns custom rewards that the calling client_id can manage. Default: false.
      Returns:
      CustomRewardList

    • getCustomRewardRedemption

      com.netflix.hystrix.HystrixCommand<CustomRewardRedemptionList> getCustomRewardRedemption​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, java.util.Collection<java.lang.String> redemptionIds, com.github.twitch4j.eventsub.domain.RedemptionStatus status, java.lang.String sort, java.lang.String after, java.lang.Integer limit)
      Returns Custom Reward Redemption objects for a Custom Reward on a channel that was created by the same client_id.

      Developers only have access to get and update redemptions for the rewards created programmatically by the same client_id.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - The id of the target channel, which must match the token user id.
      rewardId - When ID is not provided, this parameter returns paginated Custom Reward Redemption objects for redemptions of the Custom Reward with ID reward_id.
      redemptionIds - When used, this param filters the results and only returns Custom Reward Redemption objects for the redemptions with matching ID. Maximum: 50.
      status - When id is not provided, this param is required and filters the paginated Custom Reward Redemption objects for redemptions with the matching status.
      sort - Sort order of redemptions returned when getting the paginated Custom Reward Redemption objects for a reward. One of: OLDEST, NEWEST. Default: OLDEST.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries without ID.
      limit - Number of results to be returned when getting the paginated Custom Reward Redemption objects for a reward. Maximum: 50. Default: 20.
      Returns:
      CustomRewardRedemptionList

    • updateCustomReward

      com.netflix.hystrix.HystrixCommand<CustomRewardList> updateCustomReward​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, CustomReward updatedReward)
      Updates a Custom Reward created on a channel.

      Only rewards created programmatically by the same client_id can be updated.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - The id of the target channel, which must match the token user id.
      rewardId - ID of the Custom Reward to delete, must match a Custom Reward on broadcaster_id’s channel.
      updatedReward - A CustomReward object with specific field(s) updated.
      Returns:
      CustomRewardList

    • updateRedemptionStatus

      com.netflix.hystrix.HystrixCommand<CustomRewardRedemptionList> updateRedemptionStatus​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String rewardId, java.util.Collection<java.lang.String> redemptionIds, com.github.twitch4j.eventsub.domain.RedemptionStatus newStatus)
      Updates the status of Custom Reward Redemption objects on a channel that are in the UNFULFILLED status.

      Only redemptions for a reward created programmatically by the same client_id as attached to the access token can be updated.

      Parameters:
      authToken - User access token for the broadcaster (scope: channel:manage:redemptions).
      broadcasterId - The id of the target channel, which must match the token user id.
      rewardId - ID of the Custom Reward the redemptions to be updated are for.
      redemptionIds - ID of the Custom Reward Redemption to update, must match a Custom Reward Redemption on broadcaster_id’s channel. Max: 50.
      newStatus - The new status to set redemptions to. Can be either FULFILLED or CANCELED. Updating to CANCELED will refund the user their points.
      Returns:
      CustomRewardRedemptionList

    • getChannelChatBadges

      com.netflix.hystrix.HystrixCommand<ChatBadgeSetList> getChannelChatBadges​(java.lang.String authToken, java.lang.String broadcasterId)
      Gets a list of custom chat badges that can be used in chat for the specified channel. This includes subscriber badges and Bit badges.
      Parameters:
      authToken - User OAuth Token from the broadcaster.
      broadcasterId - The id of the broadcaster whose chat badges are being requested. Provided broadcaster_id must match the user_id in the user OAuth token.
      Returns:
      ChatBadgeSetList

    • getGlobalChatBadges

      com.netflix.hystrix.HystrixCommand<ChatBadgeSetList> getGlobalChatBadges​(java.lang.String authToken)
      Gets a list of chat badges that can be used in chat for any channel.
      Parameters:
      authToken - User OAuth Token or App Access Token.
      Returns:
      ChatBadgeSetList

    • getCodeStatus

      com.netflix.hystrix.HystrixCommand<CodeStatusList> getCodeStatus​(java.lang.String authToken, java.util.List<java.lang.String> code, java.lang.Integer userId)
      Gets the status of one or more provided codes.

      The API is throttled to one request per second per authenticated user.

      Parameters:
      authToken - App access token. The client ID associated with the app access token must be approved by Twitch as part of a contracted arrangement.
      code - The code to get the status of. 1-20 code parameters are allowed.
      userId - Represents a numeric Twitch user ID. The user account which is going to receive the entitlement associated with the code.
      Returns:
      CodeStatusList

    • redeemCode

      com.netflix.hystrix.HystrixCommand<CodeStatusList> redeemCode​(java.lang.String authToken, java.util.List<java.lang.String> code, java.lang.Integer userId)
      Redeems one or more provided codes to the authenticated Twitch user.

      The API is throttled to one request per second per authenticated user.

      Parameters:
      authToken - App access token. The client ID associated with the app access token must be one approved by Twitch.
      code - The code to redeem to the authenticated user’s account. 1-20 code parameters are allowed.
      userId - Represents a numeric Twitch user ID. The user account which is going to receive the entitlement associated with the code.
      Returns:
      CodeStatusList

    • getDropsEntitlements

      com.netflix.hystrix.HystrixCommand<DropsEntitlementList> getDropsEntitlements​(java.lang.String authToken, java.lang.String id, java.lang.String userId, java.lang.String gameId, java.lang.String after, java.lang.Integer limit)
      Gets a list of entitlements for a given organization that have been granted to a game, user, or both.

      Valid combinations of requests are:

      • No fields - All entitlements with benefits owned by your organization.
      • Only userId - All entitlements for a user with benefits owned by your organization.
      • Only gameId - All entitlements for all users for a game. Your organization must own the game.
      • Both userId and gameId - All entitlements for the game granted to a user. Your organization must own the game.

      Pagination support: Forward only

      Parameters:
      authToken - Required: App Access OAuth Token. OAuth Token Client ID must have ownership of Game: Client ID > RBAC Organization ID > Game ID.
      id - Optional: Unique Identifier of the entitlement.
      userId - Optional: A Twitch User ID.
      gameId - Optional: A Twitch Game ID.
      after - Optional: The cursor used to fetch the next page of data.
      limit - Optional: Maximum number of entitlements to return. Default: 20. Max: 1000.
      Returns:
      DropsEntitlementList

    • createEventSubSubscription

      com.netflix.hystrix.HystrixCommand<EventSubSubscriptionList> createEventSubSubscription​(java.lang.String authToken, com.github.twitch4j.eventsub.EventSubSubscription subscription)
      Creates an EventSub subscription.
      Parameters:
      authToken - Required: App access token.
      subscription - Required: The subscription that is being created. Must include type, version, condition, and transport.
      Returns:
      EventSubSubscriptionList

    • deleteEventSubSubscription

      com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteEventSubSubscription​(java.lang.String authToken, java.lang.String subscriptionId)
      Delete an EventSub subscription.
      Parameters:
      authToken - Required: App Access Token.
      subscriptionId - Required: The subscription ID for the subscription you want to delete.
      Returns:
      204 No Content upon a successful deletion

    • getEventSubSubscriptions

      com.netflix.hystrix.HystrixCommand<EventSubSubscriptionList> getEventSubSubscriptions​(java.lang.String authToken, com.github.twitch4j.eventsub.EventSubSubscriptionStatus status, java.lang.String after, java.lang.Integer limit)
      Get a list of your EventSub subscriptions.
      Parameters:
      authToken - Required: App Access Token.
      status - Optional: Include this parameter to filter subscriptions by their status.
      after - Optional: Cursor for forward pagination.
      limit - Optional: Maximum number of objects to return. Maximum: 100. Minimum: 10.
      Returns:
      EventSubSubscriptionList

    • getExtensionTransactions

      com.netflix.hystrix.HystrixCommand<ExtensionTransactionList> getExtensionTransactions​(java.lang.String authToken, java.lang.String extensionId, java.util.List<java.lang.String> transactionIds, java.lang.String after, java.lang.Integer limit)
      Get Extension Transactions allows extension back end servers to fetch a list of transactions that have occurred for their extension across all of Twitch.
      Parameters:
      authToken - App Access OAuth Token
      extensionId - ID of the extension to list transactions for.
      transactionIds - Transaction IDs to look up. Can include multiple to fetch multiple transactions in a single request. Maximum: 100
      after - The cursor used to fetch the next page of data. This only applies to queries without ID. If an ID is specified, it supersedes the cursor.
      limit - Maximum number of objects to return. Maximum: 100 Default: 20
      Returns:
      ExtensionTransactionList

    • searchCategories

      com.netflix.hystrix.HystrixCommand<CategorySearchList> searchCategories​(java.lang.String authToken, java.lang.String query, java.lang.Integer limit, java.lang.String after)
      Returns a list of games or categories that match the query via name either entirely or partially
      Parameters:
      authToken - Auth Token
      query - the search query
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      after - Cursor for forward pagination
      Returns:
      CategorySearchList

    • getChannelInformation

      com.netflix.hystrix.HystrixCommand<ChannelInformationList> getChannelInformation​(java.lang.String authToken, java.util.List<java.lang.String> broadcasterIds)
      Gets channel information for users
      Parameters:
      authToken - Auth Token
      broadcasterIds - IDs of the channels to be retrieved
      Returns:
      ChannelInformationList

    • updateChannelInformation

      com.netflix.hystrix.HystrixCommand<java.lang.Void> updateChannelInformation​(java.lang.String authToken, java.lang.String broadcasterId, ChannelInformation channelInformation)
      Modifies channel information for users
      Parameters:
      authToken - Auth Token (scope: channel:manage:broadcast or user:edit:broadcast)
      broadcasterId - ID of the channel to be updated (required)
      channelInformation - ChannelInformation (at least one parameter must be provided)
      Returns:
      204 No Content upon a successful update

    • searchChannels

      com.netflix.hystrix.HystrixCommand<ChannelSearchList> searchChannels​(java.lang.String authToken, java.lang.String query, java.lang.Integer limit, java.lang.String after, java.lang.Boolean liveOnly)
      Returns a list of channels (those that have streamed within the past 6 months) that match the query either entirely or partially
      Parameters:
      authToken - Auth Token
      query - the search query
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      after - Cursor for forward pagination
      liveOnly - Filter results for live streams only. Default: false
      Returns:
      ChannelSearchList

    • startCommercial

      com.netflix.hystrix.HystrixCommand<CommercialList> startCommercial​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Integer length)
      Starts a commercial on a specified channel
      Parameters:
      authToken - Auth Token (scope: channel:edit:commercial)
      broadcasterId - ID of the channel requesting a commercial
      length - Desired length of the commercial in seconds. Valid options are 30, 60, 90, 120, 150, 180.
      Returns:
      CommercialList

    • getChannelEditors

      com.netflix.hystrix.HystrixCommand<ChannelEditorList> getChannelEditors​(java.lang.String authToken, java.lang.String broadcasterId)
      Gets a list of users who have editor permissions for a specific channel.
      Parameters:
      authToken - Required: User access token of the broadcaster with the channel:read:editors scope.
      broadcasterId - Required: Broadcaster’s user ID associated with the channel.
      Returns:
      ChannelEditorList
      See Also:
      TwitchScopes.HELIX_CHANNEL_EDITORS_READ

    • createClip

      com.netflix.hystrix.HystrixCommand<CreateClipList> createClip​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Boolean hasDelay)
      Creates a clip programmatically. This returns both an ID and an edit URL for the new clip.
      Parameters:
      authToken - Auth Token
      broadcasterId - ID of the stream from which the clip will be made.
      hasDelay - If false, the clip is captured from the live stream when the API is called; otherwise, a delay is added before the clip is captured (to account for the brief delay between the broadcaster’s stream and the viewer’s experience of that stream). Default: false.
      Returns:
      CreateClip

    • getClips

      com.netflix.hystrix.HystrixCommand<ClipList> getClips​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String gameId, java.lang.String id, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.time.Instant startedAt, java.time.Instant endedAt)
      Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only). Using user-token or app-token to increase rate limits.
      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      broadcasterId - ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
      gameId - ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
      id - ID of the clip being queried. Limit: 100.
      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.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      startedAt - Starting date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.)
      endedAt - Ending date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.)
      Returns:
      ClipList Clip List

    • createEntitlementUploadUrl

      com.netflix.hystrix.HystrixCommand<UploadEntitlementUrlList> createEntitlementUploadUrl​(java.lang.String authToken, java.lang.String manifestId, java.lang.String type)
      Creates a URL where you can upload a manifest file and notify users that they have an entitlement
      Parameters:
      authToken - App access token
      manifestId - Unique identifier of the manifest file to be uploaded. Must be 1-64 characters.
      type - Type of entitlement being granted. Only "bulk_drops_grant" is supported.
      Returns:
      UploadEntitlementUrlList

    • getGames

      com.netflix.hystrix.HystrixCommand<GameList> getGames​(java.lang.String authToken, java.util.List<java.lang.String> id, java.util.List<java.lang.String> name)
      Gets game information by game ID or name. Using user-token or app-token to increase rate limits.
      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      id - Game ID. At most 100 id values can be specified.
      name - Game name. The name must be an exact match. For instance, “Pokemon� will not return a list of Pokemon games; instead, query the specific Pokemon game(s) in which you are interested. At most 100 name values can be specified.
      Returns:
      GameList

    • getHypeTrainEvents

      com.netflix.hystrix.HystrixCommand<HypeTrainEventList> getHypeTrainEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.Integer limit, java.lang.String id, java.lang.String after)
      Gets the information of the most recent Hype Train of the given channel ID. After 5 days, if no Hype Train has been active, the endpoint will return an empty response
      Parameters:
      authToken - Auth Token (scope: channel:read:hype_train)
      broadcasterId - User ID of the broadcaster (required)
      limit - Maximum number of objects to return. Maximum: 100. Default: 1. (optional)
      id - The id of the wanted event, if known. (optional)
      after - Cursor for forward pagination (optional)
      Returns:
      HypeTrainEventList

    • getIngestServers

      com.netflix.hystrix.HystrixCommand<IngestServerList> getIngestServers​(java.net.URI baseUrl)

    • getIngestServers

      default com.netflix.hystrix.HystrixCommand<IngestServerList> getIngestServers()
      Get Ingest Servers returns a list of endpoints for ingesting live video into Twitch.
      Returns:
      IngestServerList

    • manageAutoModHeldMessage

      com.netflix.hystrix.HystrixCommand<java.lang.Void> manageAutoModHeldMessage​(java.lang.String authToken, java.lang.String moderatorId, java.lang.String messageId, AutoModHeldMessageAction action)
      Allow or deny a message that was held for review by AutoMod.

      In order to retrieve messages held for review, use ITwitchPubsub#listenForModerationEvents(OAuth2Credential, String, String) and ChatModerationEvent.

      Note that the scope allows this endpoint to be used for any channel that the authenticated user is a moderator, including their own channel.

      Parameters:
      authToken - User OAuth token from a moderator with the moderator:manage:automod scope.
      moderatorId - The moderator who is approving or rejecting the held message. Must match the user_id in the user OAuth token.
      messageId - ID of the message to be allowed or denied. These message IDs are retrieved from IRC or PubSub.
      action - The action to take for the message.
      Returns:
      204 No Content upon a successful request.
      See Also:
      TwitchScopes.HELIX_AUTOMOD_MANAGE

    • getBannedUsers

      com.netflix.hystrix.HystrixCommand<BannedUserList> getBannedUsers​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.String before, java.lang.Integer limit)
      Returns all banned and timed-out users in a channel.
      Parameters:
      authToken - Auth Token (scope: moderation:read)
      broadcasterId - Required: Provided broadcaster_id must match the user_id in the auth token.
      userId - Optional: Filters the results for only those with a matching user_id. Maximum: 100.
      after - Optional: Cursor for forward pagination.
      before - Optional: Cursor for backward pagination.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      BannedUserList

    • getBannedUsers

      @Deprecated default com.netflix.hystrix.HystrixCommand<BannedUserList> getBannedUsers​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.String before)
      Deprecated.
      in favor of getBannedUsers(String, String, List, String, String, Integer) where the last param is the number of objects to retrieve.
      Returns all banned and timed-out users in a channel.
      Parameters:
      authToken - Auth Token (scope: moderation:read)
      broadcasterId - Required: Provided broadcaster_id must match the user_id in the auth token.
      userId - Optional: Filters the results for only those with a matching user_id. Maximum: 100.
      after - Optional: Cursor for forward pagination.
      before - Optional: Cursor for backward pagination.
      Returns:
      BannedUserList

    • getBannedEvents

      com.netflix.hystrix.HystrixCommand<BannedEventList> getBannedEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userId, java.lang.String after, java.lang.Integer limit)
      Returns all user bans and un-bans in a channel.
      Parameters:
      authToken - Auth Token (scope: moderation:read)
      broadcasterId - Required: Provided broadcaster_id must match the user_id in the auth token.
      userId - Optional: Filters the results and only returns a status object for users who are banned in this channel and have a matching user_id. Maximum: 100.
      after - Optional: Cursor for forward pagination.
      limit - Optional: Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      BannedEventList

    • checkAutomodStatus

      com.netflix.hystrix.HystrixCommand<AutomodEnforceStatusList> checkAutomodStatus​(java.lang.String authToken, java.lang.String broadcasterId, AutomodEnforceCheckList messages)
      Determines whether a string message meets the channel’s AutoMod requirements.
      Parameters:
      authToken - Auth Token (scope: moderation:read)
      broadcasterId - Provided broadcaster_id must match the user_id in the auth token.
      messages - the messages to be checked
      Returns:
      AutomodEnforceStatusList

    • getModerators

      com.netflix.hystrix.HystrixCommand<ModeratorList> getModerators​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after, java.lang.Integer limit)
      Returns all moderators in a channel.
      Parameters:
      authToken - User Token for the broadcaster
      broadcasterId - Provided broadcaster_id must match the user_id in the auth token.
      userIds - Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      ModeratorList

    • getModerators

      @Deprecated default com.netflix.hystrix.HystrixCommand<ModeratorList> getModerators​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after)
      Deprecated.
      in favor of getModerators(String, String, List, String, Integer) where the last param is the number of objects to retrieve.
      Returns all moderators in a channel.
      Parameters:
      authToken - User Token for the broadcaster
      broadcasterId - Provided broadcaster_id must match the user_id in the auth token.
      userIds - Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      Returns:
      ModeratorList

    • getModeratorEvents

      com.netflix.hystrix.HystrixCommand<ModeratorEventList> getModeratorEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after, java.lang.Integer limit)
      Returns a list of moderators or users added and removed as moderators from a channel.
      Parameters:
      authToken - User Token for the broadcaster
      broadcasterId - Provided broadcaster_id must match the user_id in the auth token.
      userIds - Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      ModeratorList

    • getModeratorEvents

      @Deprecated default com.netflix.hystrix.HystrixCommand<ModeratorEventList> getModeratorEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds, java.lang.String after)
      Deprecated.
      in favor of getModeratorEvents(String, String, List, String, Integer) where the last param is the number of objects to retrieve.
      Returns a list of moderators or users added and removed as moderators from a channel.
      Parameters:
      authToken - User Token for the broadcaster
      broadcasterId - Provided broadcaster_id must match the user_id in the auth token.
      userIds - Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      Returns:
      ModeratorList

    • getPolls

      com.netflix.hystrix.HystrixCommand<PollsList> getPolls​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> pollIds, java.lang.String after, java.lang.Integer limit)
      Get information about all polls or specific polls for a Twitch channel.

      Poll information is available for 90 days.

      Parameters:
      authToken - Required: User OAuth token from the broadcaster with the channel:read:polls scope.
      broadcasterId - Required: The broadcaster running polls. Provided broadcaster_id must match the user_id in the user OAuth token.
      pollIds - Optional: ID of a poll. Filters results to one or more specific polls. Not providing one or more IDs will return the full list of polls for the authenticated channel. Maximum: 100.
      after - Optional: Cursor for forward pagination: The cursor value specified here is from the pagination response field of a prior query.
      limit - Optional: Maximum number of objects to return. Maximum: 20. Default: 20.
      Returns:
      PollsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_POLLS_READ

    • createPoll

      com.netflix.hystrix.HystrixCommand<PollsList> createPoll​(java.lang.String authToken, Poll poll)
      Create a poll for a specific Twitch channel.
      Parameters:
      authToken - User OAuth token from the broadcaster with the channel:manage:polls scope.
      poll - The new poll to be created. Required: broadcaster_id, title, choices, choice.title, duration. Optional: bits_voting_enabled, bits_per_vote, channel_points_voting_enabled, channel_points_per_vote.
      Returns:
      PollsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_POLLS_MANAGE

    • endPoll

      com.netflix.hystrix.HystrixCommand<PollsList> endPoll​(java.lang.String authToken, Poll poll)
      End a poll that is currently active.
      Parameters:
      authToken - User OAuth token from the broadcaster with the channel:manage:polls scope.
      poll - The poll to be ended. Required: broadcaster_id, id, status (must be TERMINATED or ARCHIVED, depending on whether it should be viewed publicly).
      Returns:
      PollsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_POLLS_MANAGE

    • getPredictions

      com.netflix.hystrix.HystrixCommand<PredictionsList> getPredictions​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> predictionId, java.lang.String after, java.lang.Integer limit)
      Get information about all Channel Points Predictions or specific Channel Points Predictions for a Twitch channel.
      Parameters:
      authToken - Required: User OAuth token from the broadcaster with the channel:read:predictions scope.
      broadcasterId - Required: The broadcaster running Predictions. Provided broadcaster_id must match the user_id in the user OAuth token.
      predictionId - Optional: ID of a Prediction. Filters results to one or more specific Predictions. Not providing one or more IDs will return the full list of Predictions for the authenticated channel. Maximum: 100
      after - Optional: The cursor value specified here is from the pagination response field of a prior query.
      limit - Optional: Maximum number of objects to return. Maximum: 20. Default: 20.
      Returns:
      PredictionsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_PREDICTIONS_READ

    • createPrediction

      com.netflix.hystrix.HystrixCommand<PredictionsList> createPrediction​(java.lang.String authToken, Prediction prediction)
      Create a Channel Points Prediction for a specific Twitch channel.
      Parameters:
      authToken - User OAuth token from the broadcaster with the channel:manage:predictions scope.
      prediction - The prediction to be created. Required: broadcaster_id, title, outcomes, outcome.title, prediction_window.
      Returns:
      PredictionsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_PREDICTIONS_MANAGE

    • endPrediction

      com.netflix.hystrix.HystrixCommand<PredictionsList> endPrediction​(java.lang.String authToken, Prediction prediction)
      Lock, resolve, or cancel a Channel Points Prediction.

      Active Predictions can be updated to be "locked," "resolved," or "canceled." Locked Predictions can be updated to be "resolved" or "canceled."

      Parameters:
      authToken - User OAuth token from the broadcaster with the channel:manage:predictions scope.
      prediction - The prediction to be ended. Required: broadcaster_id, id, status (RESOLVED or CANCELED or LOCKED). Optional: winning_outcome_id (must be present for RESOLVED status).
      Returns:
      PredictionsList
      See Also:
      TwitchScopes.HELIX_CHANNEL_PREDICTIONS_MANAGE

    • getTopGames

      com.netflix.hystrix.HystrixCommand<GameTopList> getTopGames​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.String first)
      Gets games sorted by number of current viewers on Twitch, most popular first. Using user-token or app-token to increase rate limits.
      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      before - Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      first - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      GameList

    • getStreams

      com.netflix.hystrix.HystrixCommand<StreamList> getStreams​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.util.List<java.lang.String> gameIds, java.util.List<java.lang.String> language, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userLogins)
      Gets information about active streams.

      Streams are returned sorted by number of current viewers, in descending order. Across multiple pages of results, there may be duplicate or missing streams, as viewers join and leave streams.

      Parameters:
      authToken - User or App Access Token
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      before - Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      gameIds - Returns streams broadcasting a specified game ID. You can specify up to 100 IDs.
      language - Stream language. You can specify up to 100 languages. A language value must be either the ISO 639-1 two-letter code for a supported stream language or "other".
      userIds - Returns streams broadcast by one or more specified user IDs. You can specify up to 100 IDs.
      userLogins - Returns streams broadcast by one or more specified user login names. You can specify up to 100 names.
      Returns:
      StreamList

    • getStreams

      @Deprecated default com.netflix.hystrix.HystrixCommand<StreamList> getStreams​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.util.List<java.util.UUID> communityId, java.util.List<java.lang.String> gameIds, java.lang.String language, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userLogins)
      Deprecated.
      in favor of getStreams(String, String, String, Integer, List, List, List, List); simply remove the argument for communityId to migrate
      Gets information about active streams.
      Parameters:
      authToken - User or App Access Token
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      before - Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      communityId - Returns streams in a specified community ID. You can specify up to 100 IDs. No longer supported by twitch.
      gameIds - Returns streams broadcasting a specified game ID. You can specify up to 100 IDs.
      language - Stream language. You can specify up to 100 languages.
      userIds - Returns streams broadcast by one or more specified user IDs. You can specify up to 100 IDs.
      userLogins - Returns streams broadcast by one or more specified user login names. You can specify up to 100 names.
      Returns:
      StreamList

    • getFollowedStreams

      com.netflix.hystrix.HystrixCommand<StreamList> getFollowedStreams​(java.lang.String authToken, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
      Gets information about active streams belonging to channels that the authenticated user follows.

      Streams are returned sorted by number of current viewers, in descending order. Across multiple pages of results, there may be duplicate or missing streams, as viewers join and leave streams.

      Parameters:
      authToken - Required: OAuth user token with the user:read:follows scope.
      userId - Required: Results will only include active streams from the channels that this Twitch user follows. This must match the User ID in the bearer token.
      after - Optional: Cursor for forward pagination.
      limit - Optional: Maximum number of objects to return. Maximum: 100. Default: 100.
      Returns:
      StreamList
      See Also:
      TwitchScopes.HELIX_USER_FOLLOWS_READ

    • getStreamKey

      com.netflix.hystrix.HystrixCommand<StreamKeyList> getStreamKey​(java.lang.String authToken, java.lang.String broadcasterId)
      Gets the channel stream key for a user
      Parameters:
      authToken - Auth Token (scope: channel:read:stream_key)
      broadcasterId - User ID of the broadcaster
      Returns:
      StreamKeyList

    • getAllStreamTags

      com.netflix.hystrix.HystrixCommand<StreamTagList> getAllStreamTags​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit, java.util.List<java.util.UUID> tagIds)
      Gets available Twitch stream tags.
      Parameters:
      authToken - User Token or App auth Token, for increased rate-limits
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      tagIds - Returns tags by one or more specified tag IDs. You can specify up to 100 IDs. If you search by tagIds, no pagination is used.
      Returns:
      StreamTagList

    • getStreamTags

      com.netflix.hystrix.HystrixCommand<StreamTagList> getStreamTags​(java.lang.String authToken, java.lang.String broadcasterId)
      Gets stream tags which are active on the specified stream.
      Parameters:
      authToken - User Token or App auth Token, for increased rate-limits
      broadcasterId - ID of the stream to fetch current tags from
      Returns:
      StreamTagList

    • replaceStreamTags

      com.netflix.hystrix.HystrixCommand<java.lang.Void> replaceStreamTags​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.util.UUID> tagIds)
      Replaces the active stream tags on the specified stream with the specified tags (or clears all tags, if no new tags are specified). Requires scope: channel:manage:broadcast or user:edit:broadcast
      Parameters:
      authToken - Auth Token
      broadcasterId - ID of the stream to replace tags for
      tagIds - Tag ids to replace the current stream tags with. Maximum: 100. If empty, all tags are cleared from the stream. Tags currently expire 72 hours after they are applied, unless the stream is live within that time period.
      Returns:
      Object nothing

    • createStreamMarker

      com.netflix.hystrix.HystrixCommand<StreamMarker> createStreamMarker​(java.lang.String authToken, Highlight highlight)
      Creates a marker at the current time during a live stream. A marker is a temporal indicator that appears on the Twitch web UI for highlight creation and can also be retrieved with getStreamMarkers. Markers are meant to remind streamers and their video editors of important moments during a stream. Markers can be created only if the broadcast identified by the specified userId is live and has enabled VOD (past broadcast) storage. Marker creation will fail if the broadcaster is airing a premiere or a rerun. Requires scope: channel:manage:broadcast or user:edit:broadcast
      Parameters:
      authToken - Auth Token
      highlight - User id and optional description for the marker
      Returns:
      StreamMarker

    • getStreamMarkers

      com.netflix.hystrix.HystrixCommand<StreamMarkersList> getStreamMarkers​(java.lang.String authToken, java.lang.String after, java.lang.String before, java.lang.Integer limit, java.lang.String userId, java.lang.String videoId)
      Gets a list of markers for either a specified user’s most recent stream or a specified VOD/video (stream), ordered by recency. A marker is an arbitrary point in a stream that the broadcaster wants to mark; e.g., to easily return to later. The only markers returned are those created by the user identified by the Bearer token.
      Parameters:
      authToken - User Auth Token
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      before - Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      userId - ID of the broadcaster from whose stream markers are returned.
      videoId - ID of the VOD/video whose stream markers are returned.
      Returns:
      StreamMarkersList

    • getSubscriptions

      com.netflix.hystrix.HystrixCommand<SubscriptionList> getSubscriptions​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String after, java.lang.String before, java.lang.Integer limit)
      Get all subscribers of a channel
      Parameters:
      authToken - User Auth Token
      broadcasterId - User ID of the broadcaster. Must match the User ID in the Bearer token.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      before - Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      SubscriptionList

    • getSubscriptionsByUser

      com.netflix.hystrix.HystrixCommand<SubscriptionList> getSubscriptionsByUser​(java.lang.String authToken, java.lang.String broadcasterId, java.util.List<java.lang.String> userIds)
      Check subscription status of provided user IDs (one or more) for a given channel
      Parameters:
      authToken - User Auth Token
      broadcasterId - User ID of the broadcaster. Must match the User ID in the Bearer token.
      userIds - Unique identifier of account to get subscription status of. Accepts up to 100 values.
      Returns:
      SubscriptionList

    • getSubscriptionEvents

      com.netflix.hystrix.HystrixCommand<SubscriptionEventList> getSubscriptionEvents​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String id, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
      Returns all subscription events for the past five days.
      Parameters:
      authToken - Required: User Auth Token (scope: channel:read:subscriptions).
      broadcasterId - Required: User ID of the broadcaster. Must match the User ID in the Bearer token.
      id - Optional: Retrieve a single event by the event ID.
      userId - Optional: ID of the subscribed user.
      after - Optional: Cursor for forward pagination; where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id.
      limit - Optional: Limit the number of items in the response payload. Maximum: 100.
      Returns:
      SubscriptionEventList

    • checkUserSubscription

      com.netflix.hystrix.HystrixCommand<SubscriptionList> checkUserSubscription​(java.lang.String authToken, java.lang.String broadcasterId, java.lang.String userId)
      Checks if a specific user (user_id) is subscribed to a specific channel (broadcaster_id).
      Parameters:
      authToken - Token with the user:read:subscriptions scope. App access works if the user has authorized your application.
      broadcasterId - User ID of an Affiliate or Partner broadcaster.
      userId - User ID of a Twitch viewer.
      Returns:
      SubscriptionList on success, error 404 if not subscribed

    • getTeams

      com.netflix.hystrix.HystrixCommand<TeamList> getTeams​(java.lang.String authToken, java.lang.String name, java.lang.String id)
      Gets information for a specific Twitch Team.

      One of the two optional query parameters must be specified to return Team information.

      Parameters:
      authToken - User OAuth Token or App Access Token.
      name - Team name.
      id - Team ID.
      Returns:
      TeamList

    • getChannelTeams

      com.netflix.hystrix.HystrixCommand<TeamMembershipList> getChannelTeams​(java.lang.String authToken, java.lang.String broadcasterId)
      Retrieves a list of Twitch Teams of which the specified channel/broadcaster is a member.
      Parameters:
      authToken - User OAuth Token or App Access Token
      broadcasterId - User ID for a Twitch user.
      Returns:
      TeamMembershipList

    • getUsers

      com.netflix.hystrix.HystrixCommand<UserList> getUsers​(java.lang.String authToken, java.util.List<java.lang.String> userIds, java.util.List<java.lang.String> userNames)
      Get Users

      Gets information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name. If neither a user ID nor a login name is specified, the user is looked up by Bearer token.

      Parameters:
      authToken - Auth Token (optionally with the user:read:email scope)
      userIds - User ID. Multiple user IDs can be specified. Limit: 100.
      userNames - User login name. Multiple login names can be specified. Limit: 100.
      Returns:
      HelixUser

    • getUserBlockList

      com.netflix.hystrix.HystrixCommand<BlockedUserList> getUserBlockList​(java.lang.String authToken, java.lang.String userId, java.lang.String after, java.lang.Integer limit)
      Gets a specified user’s block list.

      The list is sorted by when the block occurred in descending order (i.e. most recent block first).

      Parameters:
      authToken - Required: User Access Token with the user:read:blocked_users scope.
      userId - Required: User ID for a Twitch user.
      after - Optional: The cursor value specified here is from the pagination response field of a prior query.
      limit - Optional: Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      BlockedUserList
      See Also:
      TwitchScopes.HELIX_USER_BLOCKS_READ

    • blockUser

      com.netflix.hystrix.HystrixCommand<java.lang.Void> blockUser​(java.lang.String authToken, java.lang.String targetUserId, java.lang.String sourceContext, java.lang.String reason)
      Blocks the specified user on behalf of the authenticated user.
      Parameters:
      authToken - Required: User Access Token with the user:manage:blocked_users scope.
      targetUserId - Required: User ID of the user to be blocked.
      sourceContext - Optional: Source context for blocking the user. Valid values: "chat", "whisper".
      reason - Optional: Reason for blocking the user. Valid values: "spam", "harassment", or "other".
      Returns:
      204 No Content upon a successful call.
      See Also:
      TwitchScopes.HELIX_USER_BLOCKS_MANAGE

    • unblockUser

      com.netflix.hystrix.HystrixCommand<java.lang.Void> unblockUser​(java.lang.String authToken, java.lang.String targetUserId)
      Unblocks the specified user on behalf of the authenticated user.
      Parameters:
      authToken - Required: User Access Token with the user:manage:blocked_users scope.
      targetUserId - Required: User ID of the user to be unblocked.
      Returns:
      204 No Content upon a successful call.
      See Also:
      TwitchScopes.HELIX_USER_BLOCKS_MANAGE

    • getFollowers

      com.netflix.hystrix.HystrixCommand<FollowList> getFollowers​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId, java.lang.String after, java.lang.Integer limit)
      Get Followers

      Gets information on follow relationships between two Twitch users. Information returned is sorted in order, most recent follow first. This can return information like “who is lirik following,” “who is following lirik,” or “is user X following user Y.” Using user-token or app-token to increase rate limits.

      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      fromId - User ID. The request returns information about users who are being followed by the from_id user.
      toId - User ID. The request returns information about users who are following the to_id user.
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      limit - Maximum number of objects to return. Maximum: 100. Default: 20.
      Returns:
      FollowList

    • createFollow

      com.netflix.hystrix.HystrixCommand<java.lang.Void> createFollow​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId, boolean allowNotifications)
      Adds a specified user to the followers of a specified channel
      Parameters:
      authToken - Auth Token (scope: user:edit:follows)
      fromId - User ID of the follower
      toId - ID of the channel to be followed by the user
      allowNotifications - Whether the user gets email or push notifications (depending on the user’s notification settings) when the channel goes live. Default value is false
      Returns:
      204 No Content upon a successfully created follow

    • deleteFollow

      com.netflix.hystrix.HystrixCommand<java.lang.Void> deleteFollow​(java.lang.String authToken, java.lang.String fromId, java.lang.String toId)
      Deletes a specified user from the followers of a specified channel
      Parameters:
      authToken - Auth Token (scope: user:edit:follows)
      fromId - User ID of the follower
      toId - Channel to be unfollowed by the user
      Returns:
      204 No Content upon a successful deletion from the list of channel followers

    • updateUser

      com.netflix.hystrix.HystrixCommand<UserList> updateUser​(java.lang.String authToken, java.lang.String description)
      Update User

      Updates the description of a user specified by a Bearer token. Requires scope: user:edit

      Parameters:
      authToken - Auth Token
      description - New user description
      Returns:
      UserList

    • getUserExtensions

      com.netflix.hystrix.HystrixCommand<ExtensionList> getUserExtensions​(java.lang.String authToken)
      Get User Extensions

      Gets a list of all extensions (both active and inactive) for a specified user, identified by a Bearer token. The response has a JSON payload with a data field containing an array of user-information elements. Required scope: user:read:broadcast

      Parameters:
      authToken - Auth Token
      Returns:
      ExtensionList

    • getUserActiveExtensions

      com.netflix.hystrix.HystrixCommand<ExtensionActiveList> getUserActiveExtensions​(java.lang.String authToken, java.lang.String userId)
      Get User Active Extensions

      Gets information about active extensions installed by a specified user, identified by a user ID or Bearer token. Optional scope: user:read:broadcast or user:edit:broadcast

      Parameters:
      authToken - Auth Token
      userId - ID of the user whose installed extensions will be returned. Limit: 1.
      Returns:
      ExtensionActiveList

    • updateUserExtensions

      com.netflix.hystrix.HystrixCommand<ExtensionActiveList> updateUserExtensions​(java.lang.String authToken, ExtensionActiveList extensions)
      Updates the activation state, extension ID, and/or version number of installed extensions for a specified user, identified by a Bearer token. If you try to activate a given extension under multiple extension types, the last write wins (and there is no guarantee of write order).
      Parameters:
      authToken - Auth Token (scope: user:edit:broadcast)
      extensions - ExtensionActiveList
      Returns:
      ExtensionActiveList

    • getVideos

      com.netflix.hystrix.HystrixCommand<VideoList> getVideos​(java.lang.String authToken, java.lang.String id, java.lang.String userId, java.lang.String gameId, java.lang.String language, java.lang.String period, java.lang.String sort, java.lang.String type, java.lang.String after, java.lang.String before, java.lang.Integer limit)
      Get Videos

      Gets video information by video ID (one or more), user ID (one only), or game ID (one only). The response has a JSON payload with a data field containing an array of video elements. For lookup by user or game, pagination is available, along with several filters that can be specified as query string parameters. Using user-token or app-token to increase rate limits.

      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      id - Required: ID of the video being queried. Limit: 100. If this is specified, you cannot use any of the optional query string parameters below.
      userId - Required: ID of the user who owns the video. Limit 1.
      gameId - Required: ID of the game the video is of. Limit 1.
      language - Optional: Language of the video being queried. Limit: 1.
      period - Optional: Period during which the video was created. Valid values: "all", "day", "week", "month". Default: "all".
      sort - Optional: Sort order of the videos. Valid values: "time", "trending", "views". Default: "time".
      type - Optional: Type of video. Valid values: "all", "upload", "archive", "highlight". Default: "all".
      after - Optional: Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      before - Optional: Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      limit - Optional: Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
      Returns:
      VideoList

    • deleteVideos

      com.netflix.hystrix.HystrixCommand<DeletedVideoList> deleteVideos​(java.lang.String authToken, java.util.List<java.lang.String> ids)
      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.

      Parameters:
      authToken - Required: User OAuth token with the channel:manage:videos scope.
      ids - Required: ID of the video(s) to be deleted. Limit: 5.
      Returns:
      DeletedVideoList
      See Also:
      TwitchScopes.HELIX_CHANNEL_VIDEOS_MANAGE

    • getWebhookSubscriptions

      com.netflix.hystrix.HystrixCommand<WebhookSubscriptionList> getWebhookSubscriptions​(java.lang.String authToken, java.lang.String after, java.lang.Integer limit)
      Get Webhook Subscriptions

      Gets the Webhook subscriptions of a user identified by a Bearer token, in order of expiration. The response has a JSON payload with a data field containing an array of subscription elements and a pagination field containing information required to query for more subscriptions.

      Parameters:
      authToken - User or App auth Token, for increased rate-limits
      after - Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
      limit - Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
      Returns:
      WebhookSubscriptionList

    • requestWebhookSubscription

      com.netflix.hystrix.HystrixCommand<feign.Response> requestWebhookSubscription​(WebhookRequest request, java.lang.String authToken)
      Subscribe to or unsubscribe from events for a specified topic.

      Web hook response payloads mimic their respective New Twitch API endpoint responses (with minor omissions for unnecessary fields). That is, a call to a web hook returns in its payload the same data as a call to the corresponding endpoint in the new Twitch API.

      When you submit a request to subscribe to an event (with the Subscribe To/Unsubscribe From Events endpoint), your request is asynchronously validated to confirm you are allowed to create the subscription.
      Depending on the results of this validation, Twitch responds by sending you one of two GET requests:

      * Subscription verify

      * Subscription denied

      Parameters:
      request - WebhookRequest to be converted to the Json body of the API call.
      authToken - Auth Token
      Returns:
      The response from the server
      See Also:
      Twitch Webhooks Guide