Constructor Detail

Method Detail

• getEmbeddedFiles

  @NonNull() abstract List<EmbeddedFile> getEmbeddedFiles(boolean includeFileAnnotations)

  Returns the list of embedded files in the document.

  Note: this call may block for a while and should not be called on the main thread.

  Parameters:

  includeFileAnnotations - true to include files embedded in .

  Returns:

  List of embedded files or empty list if this document contains no embedded files.

• getEmbeddedFilesAsync

  @NonNull() abstract Single<List<EmbeddedFile>> getEmbeddedFilesAsync(boolean includeFileAnnotations)

  Returns the list of embedded files in the document, async.

  Parameters:

  includeFileAnnotations - true to include files embedded in .

  Returns:

  Single emitting list of all embedded files in the document.

• getEmbeddedFileWithFileNameAsync

  @NonNull() abstract Maybe<EmbeddedFile> getEmbeddedFileWithFileNameAsync(@NonNull() String fileName, boolean includeFileAnnotations)

  Returns embedded file with file name if it exists, asynchronously.

  Parameters:

  fileName - Name of the embedded file to search for.

  includeFileAnnotations - true to include files embedded in .

  Returns:

  An instance of Maybe that either emits the requested file in `onSuccess()` or terminates with `onCompleted()` or `onError()`.

• getEmbeddedFileWithIdAsync

  @NonNull() abstract Maybe<EmbeddedFile> getEmbeddedFileWithIdAsync(@NonNull() String id, boolean includeFileAnnotations)

  Returns embedded file with given identifier if it exists, asynchronously.

  Parameters:

  id - Id of the embedded file to search for.

  includeFileAnnotations - true to include files embedded in .

  Returns:

  An instance of Maybe that either emits the requested file in `onSuccess()` or terminates with `onCompleted()` or `onError()`.