diff --git a/src/main/java/com/zamzar/api/ZamzarClient.java b/src/main/java/com/zamzar/api/ZamzarClient.java index a7d8390..d4b4ef8 100644 --- a/src/main/java/com/zamzar/api/ZamzarClient.java +++ b/src/main/java/com/zamzar/api/ZamzarClient.java @@ -22,10 +22,9 @@ *
* ZamzarClient zamzar = new ZamzarClient("YOUR_API_KEY_GOES_HERE"); * - * client + * zamzar * .convert(new File("path/to/source.pdf"), "jpg") - * .awaitOrThrow() - * .download(new File("path/to/destination.jpg")); + * .store(new File("path/to/destination.jpg")); ** * @see Zamzar API Documentation @@ -157,8 +156,7 @@ public ZamzarClient(String apiKey, URI baseUrl, OkHttpClient transport) { } /** - * Converts a local file to the specified format. Call {@link JobManager#awaitOrThrow()} on the result - * to wait for the conversion to complete. + * Converts a local file to the specified format, blocking until the conversion is complete. *
* Example usage: *
@@ -166,8 +164,7 @@ public ZamzarClient(String apiKey, URI baseUrl, OkHttpClient transport) { * * zamzar * .convert(new File("path/to/source.pdf"), "jpg") - * .awaitOrThrow() - * .download(new File("path/to/destination.jpg")) + * .store(new File("path/to/destination.jpg")) * .deleteAllFiles(); **/ @@ -176,8 +173,8 @@ public JobManager convert(File source, String targetFormat) throws ApiException } /** - * Converts a local file to the specified format using a custom job builder. Call {@link JobManager#awaitOrThrow()} - * on the result to wait for the conversion to complete. + * Converts a local file to the specified format using a custom job builder, blocking until the conversion is + * complete. *
* Example usage: *
@@ -189,7 +186,6 @@ public JobManager convert(File source, String targetFormat) throws ApiException * "jpg", * builder -> builder.exportingTo("s3://my-bucket/path/to/destination.jpg") * ) - * .awaitOrThrow() * .deleteAllFiles(); **/ @@ -198,8 +194,7 @@ public JobManager convert(File source, String targetFormat, JobBuilder.Modifier } /** - * Converts a file already present on Zamzar's API servers to the specified format. Call {@link JobManager#awaitOrThrow()} - * on the result to wait for the conversion to complete. + * Converts a file already present on Zamzar's API servers to the specified format. *
* Example usage: *
@@ -207,8 +202,7 @@ public JobManager convert(File source, String targetFormat, JobBuilder.Modifier * * zamzar * .convert(123, "jpg") - * .awaitOrThrow() - * .download(new File("path/to/destination.jpg")) + * .store(new File("path/to/destination.jpg")) * .deleteTargetFiles(); **/ @@ -218,7 +212,6 @@ public JobManager convert(Integer sourceId, String targetFormat) throws ApiExcep /** * Converts a file already present on Zamzar's API servers to the specified format using a custom job builder. - * Call {@link JobManager#awaitOrThrow()} on the result to wait for the conversion to complete. *
* Example usage: *
@@ -230,7 +223,6 @@ public JobManager convert(Integer sourceId, String targetFormat) throws ApiExcep * "jpg", * builder -> builder.exportingTo("s3://my-bucket/path/to/destination.jpg") * ) - * .awaitOrThrow() * .deleteTargetFiles(); **/ @@ -239,8 +231,7 @@ public JobManager convert(Integer sourceId, String targetFormat, JobBuilder.Modi } /** - * Converts a file at the given URL to the specified format. Call {@link JobManager#awaitOrThrow()} on the result - * to wait for the conversion to complete. + * Converts a file at the given URL to the specified format. *
* Example usage: *
@@ -248,8 +239,7 @@ public JobManager convert(Integer sourceId, String targetFormat, JobBuilder.Modi * * zamzar * .convert(new URL("https://example.com/source.pdf"), "jpg") - * .awaitOrThrow() - * .download(new File("path/to/destination.jpg")) + * .store(new File("path/to/destination.jpg")) * .deleteAllFiles(); **/ @@ -258,8 +248,7 @@ public JobManager convert(URI source, String targetFormat) throws ApiException { } /** - * Converts a file at the given URL to the specified format using a custom job builder. Call {@link JobManager#awaitOrThrow()} - * on the result to wait for the conversion to complete. + * Converts a file at the given URL to the specified format using a custom job builder. *
* Example usage: *
@@ -271,7 +260,6 @@ public JobManager convert(URI source, String targetFormat) throws ApiException { * "jpg", * builder -> builder.exportingTo("s3://my-bucket/path/to/destination.jpg") * ) - * .awaitOrThrow() * .deleteAllFiles(); **/