Package com.github.twitch4j.tmi

Interface TwitchMessagingInterface

@Deprecated @ScheduledForRemoval(inVersion="2.0.0") public interface TwitchMessagingInterface
Deprecated.
All of these endpoints have been (or will be) decommissioned by Twitch.
Twitch - Messaging Interface

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final URI
    BADGES_BASE_URL
    Deprecated.
    Twitch will decommission this namespace on 2023-06-01

  • Method Summary

    Modifier and Type
    Method
    Description
    default com.netflix.hystrix.HystrixCommand<BadgeSets>
    getChannelBadges(String channelId, String language)
    Deprecated.
    Twitch will decommission this endpoint on 2023-06-01; do migrate to TwitchHelix#getChannelChatBadges(String, String)
    com.netflix.hystrix.HystrixCommand<BadgeSets>
    getChannelBadges(URI baseUrl, String channelId, String language)
    Deprecated.
    com.netflix.hystrix.HystrixCommand<Chatters>
    getChatters(String channelName)
    Deprecated.
    This method will be permanently shutdown by Twitch on 2023-04-03 in favor of TwitchHelix#getChatters
    default com.netflix.hystrix.HystrixCommand<BadgeSets>
    getGlobalBadges(String language)
    Deprecated.
    Twitch will decommission this endpoint on 2023-06-01; do migrate to TwitchHelix#getGlobalChatBadges(String)
    com.netflix.hystrix.HystrixCommand<BadgeSets>
    getGlobalBadges(URI baseUrl, String language)
    Deprecated.
    com.netflix.hystrix.HystrixCommand<HostList>
    getHosts(List<String> channelIds)
    Deprecated.
    Twitch is removing host mode on October 3, 2022
    com.netflix.hystrix.HystrixCommand<HostList>
    getHostsOf(String targetId)
    Deprecated.
    Decommissioned by Twitch.

  • Field Details

  • Method Details

    • getGlobalBadges

      @Unofficial @Deprecated com.netflix.hystrix.HystrixCommand<BadgeSets> getGlobalBadges(URI baseUrl, String language)
      Deprecated.

    • getGlobalBadges

      @Unofficial @Deprecated default com.netflix.hystrix.HystrixCommand<BadgeSets> getGlobalBadges(String language)
      Deprecated.
      Twitch will decommission this endpoint on 2023-06-01; do migrate to TwitchHelix#getGlobalChatBadges(String)
      Get the chat badges that are globally available in chat.
      Parameters:
      language - Two-letter language code. Default: en.
      Returns:
      BadgeSets
      See Also:

    • getChannelBadges

      @Unofficial @Deprecated com.netflix.hystrix.HystrixCommand<BadgeSets> getChannelBadges(URI baseUrl, String channelId, String language)
      Deprecated.

    • getChannelBadges

      @Unofficial @Deprecated default com.netflix.hystrix.HystrixCommand<BadgeSets> getChannelBadges(String channelId, String language)
      Deprecated.
      Twitch will decommission this endpoint on 2023-06-01; do migrate to TwitchHelix#getChannelChatBadges(String, String)
      Get the chat badges that are specific for the given channel.
      Parameters:
      channelId - The ID of the channel to query the badges of.
      language - Two-letter language code. Default: en.
      Returns:
      BadgeSets
      See Also:

    • getChatters

      @Deprecated com.netflix.hystrix.HystrixCommand<Chatters> getChatters(String channelName)
      Deprecated.
      This method will be permanently shutdown by Twitch on 2023-04-03 in favor of TwitchHelix#getChatters
      Get Chatters

      This endpoint returns all chatters in a channel.

      Parameters:
      channelName - Channel Name
      Returns:
      List of all Viewers/mods/...
      See Also:

    • getHosts

      @Deprecated com.netflix.hystrix.HystrixCommand<HostList> getHosts(List<String> channelIds)
      Deprecated.
      Twitch is removing host mode on October 3, 2022
      Get Hosts

      This endpoint returns a "host" record for each channel ID provided. If the channel is not hosting anyone, the target_id and target_login fields will not be present. Since it is not official and undocumented, this could disappear at any time. Hopefully they would provide an official way to retrieve this data before removing it, though.

      Parameters:
      channelIds - A list containing a user ID for each channel to check.
      Returns:
      Host information for each channel ID passed.

    • getHostsOf

      @Deprecated com.netflix.hystrix.HystrixCommand<HostList> getHostsOf(String targetId)
      Deprecated.
      Decommissioned by Twitch.
      Get Hosts of target channel

      This endpoint returns a "host" record for each channel hosting the channel with the provided targetId. It does not return the login of the target, only of the hosts. Therefore getTargetLogin will return null for each Host in HostList.getHosts(). Since it is not official and undocumented, this could disappear at any time. Hopefully they would provide an official way to retrieve this data before removing it, though.

      Parameters:
      targetId - The user ID of the channel for which to get host information.
      Returns:
      List of hosts of the target channel.