discord4j.rest.interaction.GlobalCommandRegistrar Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of discord4j-rest Show documentation

A JVM-based REST/WS wrapper for the official Discord Bot API

There is a newer version: 3.3.0-RC2

/*
 * This file is part of Discord4J.
 *
 * Discord4J is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Discord4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Discord4J. If not, see .
 */

package discord4j.rest.interaction;

import discord4j.discordjson.json.ApplicationCommandData;
import discord4j.discordjson.json.ApplicationCommandRequest;
import discord4j.rest.RestClient;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.util.Logger;
import reactor.util.Loggers;

import java.util.List;

/**
 * A simple way to register a set of application command definitions globally. Use {@link #create(RestClient, List)}
 * to build one.
 */
public class GlobalCommandRegistrar {

    private static final Logger log = Loggers.getLogger(GlobalCommandRegistrar.class);

    private final RestClient restClient;
    private final List commandRequests;
    private final Mono applicationId;

    private GlobalCommandRegistrar(RestClient restClient, List commandRequests) {
        this.restClient = restClient;
        this.commandRequests = commandRequests;
        this.applicationId = restClient.getApplicationId().cache();
    }

    /**
     * Create a registrar using a list of {@link ApplicationCommandRequest} entries. Run the command registration
     * process by subscribing to {@link #registerCommands()}.
     *
     * @param restClient a Discord web client to perform API requests
     * @param commandRequests a list of command definitions
     * @return a registrar that can register application commands by subscribing to {@link #registerCommands()}
     */
    public static GlobalCommandRegistrar create(RestClient restClient,
                                                List commandRequests) {
        return new GlobalCommandRegistrar(restClient, commandRequests);
    }

    /**
     * Submit the command definitions to Discord to register each application command globally.
     *
     * @return a Flux with each command registration response from Discord if successful
     */
    public Flux registerCommands() {
        return bulkOverwriteCommands(commandRequests);
    }

    private Flux bulkOverwriteCommands(List requests) {
        return applicationId.flatMapMany(id -> restClient.getApplicationService()
            .bulkOverwriteGlobalApplicationCommand(id, requests)
            .doOnNext(it -> log.debug("Registered command {} globally", it.name())));
    }
}