All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.dv8tion.jda.api.requests.restaction.WebhookMessageCreateAction Maven / Gradle / Ivy

Go to download

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0
Show newest version
/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.requests.restaction;

import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
import net.dv8tion.jda.api.entities.channel.forums.ForumTagSnowflake;
import net.dv8tion.jda.api.interactions.InteractionHook;
import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
import net.dv8tion.jda.api.utils.messages.MessageCreateRequest;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Extension of a default {@link net.dv8tion.jda.api.requests.RestAction RestAction}
 * that allows setting message information before sending!
 *
 * 

This is available as return type of all sendMessage/sendFile methods in {@link net.dv8tion.jda.api.entities.WebhookClient WebhookClient}. * *

When this RestAction has been executed all provided files will be closed. *
Note that the garbage collector also frees opened file streams when it finalizes the stream object. * * @see net.dv8tion.jda.api.entities.WebhookClient#sendMessage(String) */ public interface WebhookMessageCreateAction extends MessageCreateRequest>, AbstractWebhookMessageAction> { /** * Set whether this message should be visible to other users. *
When a message is ephemeral, it will only be visible to the user that used the interaction. * *

Ephemeral messages have some limitations and will be removed once the user restarts their client. *
Limitations: *

    *
  • Cannot be reacted to
  • *
  • Cannot be retrieved
  • *
* *

This only works on {@link InteractionHook InteractionHooks}! * For a {@link IReplyCallback#deferReply() deferred reply}, this is not supported. When a reply is deferred, * the very first message sent through the {@link InteractionHook}, inherits the ephemeral state of the initial reply. * To send an ephemeral deferred reply, you must use {@link IReplyCallback#deferReply(boolean) deferReply(true)} instead. * * @param ephemeral * True, if this message should be invisible for other users * * @throws IllegalStateException * If this is not an interaction webhook * * @return The same message action, for chaining convenience */ @Nonnull @CheckReturnValue WebhookMessageCreateAction setEphemeral(boolean ephemeral); /** * Set the apparent username for the message author. *
This changes the username that is shown for the message author. * *

This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}! * * @param name * The username to use, or null to use the default * * @throws IllegalStateException * If this is an interaction webhook * * @return The same message action, for chaining convenience */ @Nonnull @CheckReturnValue WebhookMessageCreateAction setUsername(@Nullable String name); /** * Set the apparent avatar for the message author. *
This changes the avatar that is shown for the message author. * *

This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}! * * @param iconUrl * The URL to the avatar, or null to use default * * @throws IllegalStateException * If this is an interaction webhook * * @return The same message action, for chaining convenience */ @Nonnull @CheckReturnValue WebhookMessageCreateAction setAvatarUrl(@Nullable String iconUrl); /** * Create a new thread channel for this webhook message. *
This is currently limited to forum channels. *
Does nothing if a {@link #setThread(ThreadChannel) target thread} is already configured. * *

This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}! * * @param threadMetadata * The metadata for the thread * * @throws IllegalStateException * If this is an interaction webhook * @throws IllegalArgumentException * If null is provided * * @return The same message action, for chaining convenience * * @see #createThread(String, ForumTagSnowflake...) */ @Nonnull @CheckReturnValue WebhookMessageCreateAction createThread(@Nonnull ThreadCreateMetadata threadMetadata); /** * Create a new thread channel for this webhook message. *
This is currently limited to forum channels. *
Does nothing if a {@link #setThread(ThreadChannel) target thread} is already configured. * *

This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}! * * @param threadName * The thread title * @param tags * The tags to apply to this forum post * * @throws IllegalStateException * If this is an interaction webhook * @throws IllegalArgumentException * If null is provided or the name is not between 1 and 80 characters long * * @return The same message action, for chaining convenience * * @see #createThread(ThreadCreateMetadata) */ @Nonnull @CheckReturnValue default WebhookMessageCreateAction createThread(@Nonnull String threadName, @Nonnull ForumTagSnowflake... tags) { return createThread(new ThreadCreateMetadata(threadName).addTags(tags)); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy