discord4j.rest.entity.RestInvite 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.entity;

import discord4j.common.util.Snowflake;
import discord4j.discordjson.json.InviteData;
import discord4j.rest.RestClient;
import reactor.core.publisher.Mono;
import reactor.util.annotation.Nullable;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * Represents a code that can be used to add a user to a guild.
 */
public class RestInvite {

    private final RestClient restClient;
    private final String code;

    private RestInvite(RestClient restClient, String code) {
        this.restClient = restClient;
        this.code = code;
    }

    /**
     * Create a {@link RestInvite} with the given parameters. This method does not perform any API request.
     *
     * @param restClient REST API resources
     * @param code the ID of this entity
     * @return a {@code RestInvite} represented by the given parameters.
     */
    public static RestInvite create(RestClient restClient, String code) {
        return new RestInvite(restClient, code);
    }

    /**
     * Gets the invite code.
     *
     * @return The invite code
     */
    public String getCode() {
        return code;
    }

    /**
     * Retrieve the contents of this REST entity from Discord API.
     *
     * @return a Mono with the {@link InviteData} contents if successful, otherwise an error Mono
     */
    public Mono getData() {
        return restClient.getInviteService().getInvite(code);
    }

    /**
     * Retrieve the contents of this REST entity from Discord API.
     *
     * @param withCounts whether the invite should contain approximate member counts
     * @param withExpiration whether the invite should contain the expiration date
     * @param guildScheduledEventId the guild scheduled event to include with the invite, can be {@code null}
     * @return a Mono with the {@link InviteData} contents if successful, otherwise an error Mono
     */
    public Mono getData(boolean withCounts, boolean withExpiration,
                                    @Nullable Snowflake guildScheduledEventId) {
        Map queryParams = new HashMap<>();
        queryParams.put("with_counts", withCounts);
        queryParams.put("with_expiration", withExpiration);
        if (guildScheduledEventId != null) {
            queryParams.put("guild_scheduled_event_id", guildScheduledEventId.asString());
        }
        return restClient.getInviteService().getInvite(code, queryParams);
    }

    /**
     * Delete this resource from the Discord API.
     *
     * @param reason include a reason for audit log purposes, can be {@code null}
     * @return a Mono with the {@link InviteData} contents if successful, otherwise an empty Mono
     */
    public Mono delete(@Nullable String reason) {
        return restClient.getInviteService().deleteInvite(code, reason);
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        final RestInvite that = (RestInvite) o;
        return code.equals(that.code);
    }

    @Override
    public int hashCode() {
        return Objects.hash(code);
    }
}