Package com.github.twitch4j.tmi

Interface TwitchMessagingInterface

public interface TwitchMessagingInterface
Twitch - Messaging Interface

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.net.URI BADGES_BASE_URL
    The default baseUrl to pass to getGlobalBadges(URI, String) and getChannelBadges(URI, String, String)

  • Method Summary

    Modifier and Type Method Description
    default com.netflix.hystrix.HystrixCommand<BadgeSets> getChannelBadges​(java.lang.String channelId, java.lang.String language)
    Get the chat badges that are specific for the given channel.
    com.netflix.hystrix.HystrixCommand<BadgeSets> getChannelBadges​(java.net.URI baseUrl, java.lang.String channelId, java.lang.String language)
    Deprecated.
    com.netflix.hystrix.HystrixCommand<Chatters> getChatters​(java.lang.String channelName)
    Get Chatters
    default com.netflix.hystrix.HystrixCommand<BadgeSets> getGlobalBadges​(java.lang.String language)
    Get the chat badges that are globally available in chat.
    com.netflix.hystrix.HystrixCommand<BadgeSets> getGlobalBadges​(java.net.URI baseUrl, java.lang.String language)
    Deprecated.
    com.netflix.hystrix.HystrixCommand<HostList> getHosts​(java.util.List<java.lang.String> channelIds)
    Get Hosts
    com.netflix.hystrix.HystrixCommand<HostList> getHostsOf​(java.lang.String targetId)
    Deprecated.
    Decommissioned by Twitch.

  • Field Details

  • Method Details

    • getGlobalBadges

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

    • getGlobalBadges

      @Unofficial default com.netflix.hystrix.HystrixCommand<BadgeSets> getGlobalBadges​(java.lang.String language)
      Get the chat badges that are globally available in chat.
      Parameters:
      language - Two-letter language code. Default: en.
      Returns:
      BadgeSets

    • getChannelBadges

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

    • getChannelBadges

      @Unofficial default com.netflix.hystrix.HystrixCommand<BadgeSets> getChannelBadges​(java.lang.String channelId, java.lang.String language)
      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

    • getChatters

      com.netflix.hystrix.HystrixCommand<Chatters> getChatters​(java.lang.String channelName)
      Get Chatters

      This endpoint returns all chatters in a channel. It's not official, bot pretty much every single bot depends on this so i doubt that they will ever remove it.

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

    • getHosts

      com.netflix.hystrix.HystrixCommand<HostList> getHosts​(java.util.List<java.lang.String> channelIds)
      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​(java.lang.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.