PspdfkitApi class
The API for interacting with a PDF document.
Constructors
- PspdfkitApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
-
Constructor for PspdfkitApi. The
binaryMessengernamed argument is available for dependency injection. If it is left null, the default BinaryMessenger will be used which routes to the host platform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- pigeonVar_binaryMessenger → BinaryMessenger?
-
final
- pigeonVar_messageChannelSuffix → String
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addAnnotation(
String annotation, String? attachment) → Future< bool?> -
applyInstantJson(
String annotationsJson) → Future< bool?> -
checkAndroidWriteExternalStoragePermission(
) → Future< bool?> -
enableAnalyticsEvents(
bool enable) → Future< void> - Configure Nutrient Analytics events.
-
exportInstantJson(
) → Future< String?> -
exportXfdf(
String xfdfPath) → Future< bool?> -
generatePdf(
List< Map< pages, String outputPath) → Future<String, Object> >String?> -
Generate PDF from Images, Template, and Patterns.
pages: NewPages to be added to the PDF.outputPath: The path to the output file. Returns the path to the generated PDF path or null if the input is invalid or if the PDF generation fails. -
generatePdfFromHtmlString(
String html, String outPutFile, Map< String, Object> ? options) → Future<String?> - Generates a PDF from HTML string.
-
generatePdfFromHtmlUri(
String htmlUri, String outPutFile, Map< String, Object> ? options) → Future<String?> -
getAllUnsavedAnnotations(
) → Future< Object?> -
getAnnotations(
int pageIndex, String type) → Future< Object?> -
getAuthorName(
) → Future< String> -
getFormFieldValue(
String fullyQualifiedName) → Future< String?> -
getFrameworkVersion(
) → Future< String?> -
getTemporaryDirectory(
) → Future< String> -
importXfdf(
String xfdfString) → Future< bool?> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openAndroidSettings(
) → Future< void> -
present(
String document, {Map< String, Object> ? configuration}) → Future<bool?> -
presentInstant(
String serverUrl, String jwt, {Map< String, Object> ? configuration}) → Future<bool?> -
processAnnotations(
AnnotationType type, AnnotationProcessingMode processingMode, String destinationPath) → Future< bool?> -
removeAnnotation(
String annotation) → Future< bool?> -
requestAndroidWriteExternalStoragePermission(
) → Future< AndroidPermissionStatus> -
save(
) → Future< bool?> -
setAnnotationPresetConfigurations(
Map< String, Object?> configurations) → Future<bool?> -
setAuthorName(
String name) → Future< void> -
setDelayForSyncingLocalChanges(
double delay) → Future< bool?> -
setFormFieldValue(
String value, String fullyQualifiedName) → Future< bool?> -
setLicenseKey(
String? licenseKey) → Future< void> -
setLicenseKeys(
String? androidLicenseKey, String? iOSLicenseKey, String? webLicenseKey) → Future< void> -
setListenToServerChanges(
bool listen) → Future< bool?> -
syncAnnotations(
) → Future< bool?> -
toString(
) → String -
A string representation of this object.
inherited
-
updateAnnotation(
String annotation) → Future< void>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
pigeonChannelCodec
→ const MessageCodec<
Object?>