com.github.twitch4j.helix.webhooks.topics.UsersTopic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twitch4j-helix Show documentation

Helix API dependency

The newest version!

package com.github.twitch4j.helix.webhooks.topics;

import com.github.twitch4j.helix.domain.UserList;
import lombok.Getter;
import lombok.NonNull;
import org.jetbrains.annotations.ApiStatus;

import java.util.TreeMap;

/**
 * Notifies when a user changes information about his/her profile.
 * This web hook requires the user:read:email OAuth scope, to get notifications of email changes.
 *
 * @deprecated Twitch decommissioned this API; please migrate to EventSub
 */
@Getter
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2.0.0")
public class UsersTopic extends TwitchWebhookTopic {

    public static final String PATH = "/users";

    private static TreeMap mapParameters(String userId) {
        TreeMap parameterMap = new TreeMap<>();
        parameterMap.put("user_id", userId);
        return parameterMap;
    }

    /**
     * @return The user whose data is monitored.
     */
    private String userId;

    /**
     * Notifies when a user changes information about his/her profile.
     * This web hook requires the user:read:email OAuth scope, to get notifications of email changes.
     *
     * @param userId Required. Specifies the user whose data is monitored.
     * @deprecated Will be decommissioned after 2021-09-16 in favor of EventSub
     */
    @Deprecated
    public UsersTopic(@NonNull String userId) {
        super(
            PATH,
            UserList.class,
            mapParameters(userId)
        );
        this.userId = userId;
    }

}