Class WebhookUpdater



  • public class WebhookUpdater
    extends Object
    This class can be used to update webhooks.
    • Constructor Detail

      • WebhookUpdater

        public WebhookUpdater​(Webhook webhook)
        Creates a new webhook updater.
        Parameters:
        webhook - The webhook to update.
    • Method Detail

      • setAuditLogReason

        public WebhookUpdater setAuditLogReason​(String reason)
        Sets the reason for this update. This reason will be visible in the audit log entry(s).
        Parameters:
        reason - The reason for this update.
        Returns:
        The current instance in order to chain call methods.
      • setName

        public WebhookUpdater setName​(String name)
        Queues the name to be updated.
        Parameters:
        name - The new name of the webhook.
        Returns:
        The current instance in order to chain call methods.
      • setChannel

        public WebhookUpdater setChannel​(ServerTextChannel channel)
        Queues the channel to be updated.
        Parameters:
        channel - The new channel of the webhook.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(BufferedImage avatar)
        Queues the avatar to be updated. This method assumes the file type is "png"!
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(BufferedImage avatar,
                                        String fileType)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        fileType - The type of the avatar, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(File avatar)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(Icon avatar)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(URL avatar)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(byte[] avatar)
        Queues the avatar to be updated. This method assumes the file type is "png"!
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(byte[] avatar,
                                        String fileType)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        fileType - The type of the avatar, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(InputStream avatar)
        Queues the avatar to be updated. This method assumes the file type is "png"!
        Parameters:
        avatar - The avatar to set.
        Returns:
        The current instance in order to chain call methods.
      • setAvatar

        public WebhookUpdater setAvatar​(InputStream avatar,
                                        String fileType)
        Queues the avatar to be updated.
        Parameters:
        avatar - The avatar to set.
        fileType - The type of the avatar, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.
      • removeAvatar

        public WebhookUpdater removeAvatar​()
        Queues the avatar to be removed.
        Returns:
        The current instance in order to chain call methods.
      • update

        public CompletableFuture<Webhook> update​()
        Performs the queued updates.
        Returns:
        The updated webhook or the current instance if no updates were queued.