Interface WebhookAction

    • Method Detail

      • setCheck

        @Nonnull
        WebhookAction setCheck​(@Nullable
                               java.util.function.BooleanSupplier checks)
        Description copied from interface: AuditableRestAction
        Sets the last-second checks before finally executing the http request in the queue.
        If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.
        Specified by:
        setCheck in interface AuditableRestAction<Webhook>
        Specified by:
        setCheck in interface RestAction<Webhook>
        Parameters:
        checks - The checks to run before executing the request, or null to run no checks
        Returns:
        The current RestAction for chaining convenience
        See Also:
        RestAction.getCheck(), RestAction.addCheck(BooleanSupplier)
      • timeout

        @Nonnull
        WebhookAction timeout​(long timeout,
                              @Nonnull
                              java.util.concurrent.TimeUnit unit)
        Description copied from interface: AuditableRestAction
        Timeout for this RestAction instance.
        If the request doesn't get executed within the timeout it will fail.

        When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

        Example

        
         action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
               .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
         
        Specified by:
        timeout in interface AuditableRestAction<Webhook>
        Specified by:
        timeout in interface RestAction<Webhook>
        Parameters:
        timeout - The timeout to use
        unit - Unit for the timeout value
        Returns:
        The same RestAction instance with the applied timeout
        See Also:
        RestAction.setDefaultTimeout(long, TimeUnit)
      • deadline

        @Nonnull
        WebhookAction deadline​(long timestamp)
        Description copied from interface: AuditableRestAction
        Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
        If the deadline is reached, the request will fail with a TimeoutException.

        This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

        Example

        
         action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
               .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
         
        Specified by:
        deadline in interface AuditableRestAction<Webhook>
        Specified by:
        deadline in interface RestAction<Webhook>
        Parameters:
        timestamp - Millisecond timestamp at which the request will timeout
        Returns:
        The same RestAction with the applied deadline
        See Also:
        RestAction.timeout(long, TimeUnit), RestAction.setDefaultTimeout(long, TimeUnit)
      • getChannel

        @Nonnull
        TextChannel getChannel()
        The TextChannel to create this webhook in
        Returns:
        The channel
      • getGuild

        @Nonnull
        default Guild getGuild()
        The Guild to create this webhook in
        Returns:
        The guild
      • setName

        @Nonnull
        @CheckReturnValue
        WebhookAction setName​(@Nonnull
                              java.lang.String name)
        Sets the Name for the custom Webhook User
        Parameters:
        name - A not-null String name for the new Webhook user.
        Returns:
        The current WebhookAction for chaining convenience.
        Throws:
        java.lang.IllegalArgumentException - If the specified name is not in the range of 2-100.
      • setAvatar

        @Nonnull
        @CheckReturnValue
        WebhookAction setAvatar​(@Nullable
                                Icon icon)
        Sets the Avatar for the custom Webhook User
        Parameters:
        icon - An Icon for the new avatar. Or null to use default avatar.
        Returns:
        The current WebhookAction for chaining convenience.