Constructor Detail

Method Detail

• videoTransformationAccepted

   final Optional<VideoTransformationAcceptedEvent> videoTransformationAccepted()

  Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.

• videoTransformationReady

   final Optional<VideoTransformationReadyEvent> videoTransformationReady()

  Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users.

• videoTransformationError

   final Optional<VideoTransformationErrorEvent> videoTransformationError()

  Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support.

• uploadPreTransformSuccess

   final Optional<UploadPreTransformSuccessEvent> uploadPreTransformSuccess()

  Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.

• uploadPreTransformError

   final Optional<UploadPreTransformErrorEvent> uploadPreTransformError()

  Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.

• uploadPostTransformSuccess

   final Optional<UploadPostTransformSuccessEvent> uploadPostTransformSuccess()

  Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.

• uploadPostTransformError

   final Optional<UploadPostTransformErrorEvent> uploadPostTransformError()

  Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.

• fileCreated

   final Optional<FileCreateEvent> fileCreated()

  Triggered when a file is created.

• fileUpdated

   final Optional<FileUpdateEvent> fileUpdated()

  Triggered when a file is updated.

• fileDeleted

   final Optional<FileDeleteEvent> fileDeleted()

  Triggered when a file is deleted.

• fileVersionCreated

   final Optional<FileVersionCreateEvent> fileVersionCreated()

  Triggered when a file version is created.

• fileVersionDeleted

   final Optional<FileVersionDeleteEvent> fileVersionDeleted()

  Triggered when a file version is deleted.

• folderCreated

   final Optional<FolderCreateEvent> folderCreated()

  Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.

• folderUpdated

   final Optional<FolderUpdateEvent> folderUpdated()

  Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new folderPath.

• folderDeleted

   final Optional<FolderDeleteEvent> folderDeleted()

  Triggered when a folder is deleted. Deleting a folder tree sends one event per folder in the tree; the files inside it send file.deleted events and their versions send file-version.deleted events. Moving a folder sends this event for the old folderId and folder.created for the new one.

• isVideoTransformationAccepted

   final Boolean isVideoTransformationAccepted()

• isVideoTransformationReady

   final Boolean isVideoTransformationReady()

• isVideoTransformationError

   final Boolean isVideoTransformationError()

• isUploadPreTransformSuccess

   final Boolean isUploadPreTransformSuccess()

• isUploadPreTransformError

   final Boolean isUploadPreTransformError()

• isUploadPostTransformSuccess

   final Boolean isUploadPostTransformSuccess()

• isUploadPostTransformError

   final Boolean isUploadPostTransformError()

• isFileCreated

   final Boolean isFileCreated()

• isFileUpdated

   final Boolean isFileUpdated()

• isFileDeleted

   final Boolean isFileDeleted()

• isFileVersionCreated

   final Boolean isFileVersionCreated()

• isFileVersionDeleted

   final Boolean isFileVersionDeleted()

• isFolderCreated

   final Boolean isFolderCreated()

• isFolderUpdated

   final Boolean isFolderUpdated()

• isFolderDeleted

   final Boolean isFolderDeleted()

• asVideoTransformationAccepted

   final VideoTransformationAcceptedEvent asVideoTransformationAccepted()

  Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.

• asVideoTransformationReady

   final VideoTransformationReadyEvent asVideoTransformationReady()

  Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users.

• asVideoTransformationError

   final VideoTransformationErrorEvent asVideoTransformationError()

  Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support.

• asUploadPreTransformSuccess

   final UploadPreTransformSuccessEvent asUploadPreTransformSuccess()

  Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.

• asUploadPreTransformError

   final UploadPreTransformErrorEvent asUploadPreTransformError()

  Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.

• asUploadPostTransformSuccess

   final UploadPostTransformSuccessEvent asUploadPostTransformSuccess()

  Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.

• asUploadPostTransformError

   final UploadPostTransformErrorEvent asUploadPostTransformError()

  Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.

• asFileCreated

   final FileCreateEvent asFileCreated()

  Triggered when a file is created.

• asFileUpdated

   final FileUpdateEvent asFileUpdated()

  Triggered when a file is updated.

• asFileDeleted

   final FileDeleteEvent asFileDeleted()

  Triggered when a file is deleted.

• asFileVersionCreated

   final FileVersionCreateEvent asFileVersionCreated()

  Triggered when a file version is created.

• asFileVersionDeleted

   final FileVersionDeleteEvent asFileVersionDeleted()

  Triggered when a file version is deleted.

• asFolderCreated

   final FolderCreateEvent asFolderCreated()

  Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.

• asFolderUpdated

   final FolderUpdateEvent asFolderUpdated()

  Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new folderPath.

• asFolderDeleted

   final FolderDeleteEvent asFolderDeleted()

  Triggered when a folder is deleted. Deleting a folder tree sends one event per folder in the tree; the files inside it send file.deleted events and their versions send file-version.deleted events. Moving a folder sends this event for the old folderId and folder.created for the new one.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(UnwrapWebhookEvent.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import io.imagekit.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = unwrapWebhookEvent.accept(new UnwrapWebhookEvent.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitVideoTransformationAccepted(VideoTransformationAcceptedEvent videoTransformationAccepted) {
          return Optional.of(videoTransformationAccepted.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final UnwrapWebhookEvent validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofVideoTransformationAccepted

   final static UnwrapWebhookEvent ofVideoTransformationAccepted(VideoTransformationAcceptedEvent videoTransformationAccepted)

  Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.

• ofVideoTransformationReady

   final static UnwrapWebhookEvent ofVideoTransformationReady(VideoTransformationReadyEvent videoTransformationReady)

  Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users.

• ofVideoTransformationError

   final static UnwrapWebhookEvent ofVideoTransformationError(VideoTransformationErrorEvent videoTransformationError)

  Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support.

• ofUploadPreTransformSuccess

   final static UnwrapWebhookEvent ofUploadPreTransformSuccess(UploadPreTransformSuccessEvent uploadPreTransformSuccess)

  Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.

• ofUploadPreTransformError

   final static UnwrapWebhookEvent ofUploadPreTransformError(UploadPreTransformErrorEvent uploadPreTransformError)

  Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.

• ofUploadPostTransformSuccess

   final static UnwrapWebhookEvent ofUploadPostTransformSuccess(UploadPostTransformSuccessEvent uploadPostTransformSuccess)

  Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.

• ofUploadPostTransformError

   final static UnwrapWebhookEvent ofUploadPostTransformError(UploadPostTransformErrorEvent uploadPostTransformError)

  Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.

• ofFileCreated

   final static UnwrapWebhookEvent ofFileCreated(FileCreateEvent fileCreated)

  Triggered when a file is created.

• ofFileUpdated

   final static UnwrapWebhookEvent ofFileUpdated(FileUpdateEvent fileUpdated)

  Triggered when a file is updated.

• ofFileDeleted

   final static UnwrapWebhookEvent ofFileDeleted(FileDeleteEvent fileDeleted)

  Triggered when a file is deleted.

• ofFileVersionCreated

   final static UnwrapWebhookEvent ofFileVersionCreated(FileVersionCreateEvent fileVersionCreated)

  Triggered when a file version is created.

• ofFileVersionDeleted

   final static UnwrapWebhookEvent ofFileVersionDeleted(FileVersionDeleteEvent fileVersionDeleted)

  Triggered when a file version is deleted.

• ofFolderCreated

   final static UnwrapWebhookEvent ofFolderCreated(FolderCreateEvent folderCreated)

  Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.

• ofFolderUpdated

   final static UnwrapWebhookEvent ofFolderUpdated(FolderUpdateEvent folderUpdated)

  Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new folderPath.

• ofFolderDeleted

   final static UnwrapWebhookEvent ofFolderDeleted(FolderDeleteEvent folderDeleted)

  Triggered when a folder is deleted. Deleting a folder tree sends one event per folder in the tree; the files inside it send file.deleted events and their versions send file-version.deleted events. Moving a folder sends this event for the old folderId and folder.created for the new one.