com.github.twitch4j.tmi.TwitchMessagingInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitch4j-messaginginterface Show documentation
Twitch Message Interface API dependency
The newest version!
package com.github.twitch4j.tmi;

import com.github.twitch4j.common.annotation.Unofficial;
import com.github.twitch4j.tmi.domain.BadgeSets;
import com.github.twitch4j.tmi.domain.Chatters;
import com.github.twitch4j.tmi.domain.HostList;
import com.netflix.hystrix.HystrixCommand;
import feign.Param;
import feign.RequestLine;
import org.jetbrains.annotations.ApiStatus;

import java.net.URI;
import java.util.List;
import java.util.function.Supplier;

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

    /**
     * The default baseUrl to pass to {@link #getGlobalBadges(URI, String)} and {@link #getChannelBadges(URI, String, String)}
     *
     * @deprecated Twitch will decommission this namespace on 2023-06-01
     */
    @Unofficial
    @Deprecated
    URI BADGES_BASE_URL = ((Supplier) () -> {
        try {
            return new URI("https://badges.twitch.tv/v1");
        } catch (Exception e) {
            return null;
        }
    }).get();

    @Unofficial
    @Deprecated
    @RequestLine("GET /badges/global/display?language={language}")
    HystrixCommand getGlobalBadges(
        URI baseUrl,
        @Param("language") String language
    );

    /**
     * Get the chat badges that are globally available in chat.
     *
     * @param language Two-letter language code. Default: en.
     * @return BadgeSets
     * @see Deprecation Announcement
     * @deprecated Twitch will decommission this endpoint on 2023-06-01; do migrate to {@code TwitchHelix#getGlobalChatBadges(String)}
     */
    @Unofficial
    @Deprecated
    default HystrixCommand getGlobalBadges(String language) {
        return getGlobalBadges(BADGES_BASE_URL, language);
    }

    @Unofficial
    @Deprecated
    @RequestLine("GET /badges/channels/{channel_id}/display?language={language}")
    HystrixCommand getChannelBadges(
        URI baseUrl,
        @Param("channel_id") String channelId,
        @Param("language") String language
    );

    /**
     * Get the chat badges that are specific for the given channel.
     *
     * @param channelId The ID of the channel to query the badges of.
     * @param language  Two-letter language code. Default: en.
     * @return BadgeSets
     * @see Deprecation Announcement
     * @deprecated Twitch will decommission this endpoint on 2023-06-01; do migrate to {@code TwitchHelix#getChannelChatBadges(String, String)}
     */
    @Unofficial
    @Deprecated
    default HystrixCommand getChannelBadges(String channelId, String language) {
        return getChannelBadges(BADGES_BASE_URL, channelId, language);
    }

    /**
     * Get Chatters
     * 
     * This endpoint returns all chatters in a channel.
     *
     * @param channelName Channel Name
     * @return List of all Viewers/mods/...
     * @see Shutdown Announcement
     * @deprecated This method will be permanently shutdown by Twitch on 2023-04-03 in favor of TwitchHelix#getChatters
     */
    @Deprecated
    @SuppressWarnings("DeprecatedIsStillUsed")
    @RequestLine("GET /group/user/{channel}/chatters")
    HystrixCommand getChatters(
        @Param("channel") String channelName
    );

    /**
     * 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.
     *
     * @param channelIds A list containing a user ID for each channel to check.
     * @return Host information for each channel ID passed.
     * @deprecated Twitch is removing host mode on October 3, 2022
     */
    @Deprecated
    @RequestLine("GET /hosts?include_logins=1&host={id}")
    HystrixCommand getHosts(
        @Param("id") List channelIds
    );

    /**
     * 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.
     *
     * @param targetId The user ID of the channel for which to get host information.
     * @return List of hosts of the target channel.
     * @deprecated Decommissioned by Twitch.
     */
    @Deprecated
    @RequestLine("GET /hosts?include_logins=1&target={id}")
    HystrixCommand getHostsOf(
        @Param("id") String targetId
    );
}