### OnPreparePopupToolbarListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.listeners/index.html Listener for getting notified of when the popup toolbar is being prepared to be displayed. ```APIDOC ## interface OnPreparePopupToolbarListener ### Description Listener for getting notified of when the popup toolbar is being prepared to be displayed. ### Type interface OnPreparePopupToolbarListener ``` -------------------------------- ### RichMediaExecuteAction Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.actions/index.html Action for starting RichMediaAnnotations. This action is used to initiate rich media content associated with annotations. ```APIDOC ## RichMediaExecuteAction ### Description Action for starting RichMediaAnnotations. ### Class `RichMediaExecuteAction` ``` -------------------------------- ### InstantPdfActivityIntentBuilder Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.ui/index.html A builder class used to construct intents for starting the InstantPdfActivity. It allows for setting the document and all necessary configurations. ```APIDOC ## InstantPdfActivityIntentBuilder ### Description Builder used for creating an intent for starting InstantPdfActivity. Allows setting the document and all of the necessary configuration. ### Class class InstantPdfActivityIntentBuilder ``` -------------------------------- ### PackageManager.getSupportPackageInfo Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.utils/index.html Retrieves overall information about an application package that is installed on the system using appropriate API for Android Tiramisu and upwards. ```APIDOC ## PackageManager.getSupportPackageInfo ### Description Retrieves overall information about an application package that is installed on the system using appropriate API for Android Tiramisu and upwards. ### Method Signature ```kotlin fun PackageManager.getSupportPackageInfo(packageName: String, flags: Int): PackageInfo ``` ### Parameters #### Path Parameters - **packageName** (String) - The package name of the application. - **flags** (Int) - Flags to control the information returned. ### Returns - **PackageInfo** - An object containing the package information. ``` -------------------------------- ### PackageManager.getMetaData Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.utils/index.html Retrieves meta-data information about an application package that is installed on the system using appropriate API for Android Tiramisu and upwards. ```APIDOC ## PackageManager.getMetaData ### Description Retrieves meta-data information about an application package that is installed on the system using appropriate API for Android Tiramisu and upwards. ### Method Signature ```kotlin fun PackageManager.getMetaData(packageName: String): Bundle? ``` ### Parameters #### Path Parameters - **packageName** (String) - The package name of the application. ### Returns - **Bundle?** - A Bundle containing the meta-data, or null if not found. ``` -------------------------------- ### AnnotationSelectionViewThemeConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration.theming/index.html This class allows you to configure various visual aspects of the annotation selection view, including borders, handles, padding, and guide lines. ```APIDOC ## Class: AnnotationSelectionViewThemeConfiguration ### Description Configuration class holding all resolved theme configuration properties related to the annotation selection view. ### Properties - **selectionBorderWidth** (Int?) - The width of the selection border. - **selectionBorderColor** (ColorInt) - The color of the selection border. - **selectionScaleHandleColor** (ColorInt) - The color of the selection scale handle. - **selectionEditHandleColor** (ColorInt) - The color of the selection edit handle. - **editHandleDrawable** (Drawable?) - The drawable for the edit handle. - **handleTouchFeedbackAnimationEnabled** (Boolean?) - Whether touch feedback animation is enabled for handles. - **selectionPadding** (Int?) - The padding around the selection. - **guideLineWidth** (Int) - The width of the guide line. Must be non-negative. - **guideLineColor** (ColorInt) - The color of the guide line. - **guideLineIncrease** (Int) - The increase in guide line width. Must be non-negative. - **linkAnnotationBackgroundColor** (ColorInt) - The background color for link annotations. - **linkAnnotationBorderColor** (ColorInt) - The border color for link annotations. - **linkAnnotationHighlightBackgroundColor** (ColorInt) - The highlight background color for link annotations. - **linkAnnotationHighlightBorderColor** (ColorInt) - The highlight border color for link annotations. - **topLeftScaleHandleDrawable** (Drawable?) - The drawable for the top-left scale handle. - **topCenterScaleHandleDrawable** (Drawable?) - The drawable for the top-center scale handle. - **topRightScaleHandleDrawable** (Drawable?) - The drawable for the top-right scale handle. - **centerLeftScaleHandleDrawable** (Drawable?) - The drawable for the center-left scale handle. - **centerRightScaleHandleDrawable** (Drawable?) - The drawable for the center-right scale handle. - **bottomLeftScaleHandleDrawable** (Drawable?) - The drawable for the bottom-left scale handle. - **bottomCenterScaleHandleDrawable** (Drawable?) - The drawable for the bottom-center scale handle. - **bottomRightScaleHandleDrawable** (Drawable?) - The drawable for the bottom-right scale handle. - **rotationHandleDrawable** (Drawable?) - The drawable for the rotation handle. - **backgroundDrawable** (Drawable?) - The background drawable for the view. ``` -------------------------------- ### InitializationOptions Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.initialization/index.html Provides extra initialization options for Nutrient. These options are passed to the `com.pspdfkit.Nutrient.initialize` method. ```APIDOC ## InitializationOptions ### Description Data class for configuring advanced initialization settings for the Nutrient SDK. ### Class Signature data class InitializationOptions(val licenseKey: String? = null, val fontPaths: List = emptyList(), val crossPlatformTechnology: CrossPlatformTechnology? = null, val applicationPolicy: ApplicationPolicy? = null) ### Parameters - **licenseKey** (String?) - Optional license key for the SDK. - **fontPaths** (List) - Optional list of paths to custom fonts. - **crossPlatformTechnology** (CrossPlatformTechnology?) - Optional enum specifying the cross-platform technology used. - **applicationPolicy** (ApplicationPolicy?) - Optional application policy configuration. ``` -------------------------------- ### InstantClient Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.client/index.html The entry point to Nutrient Instant, representing a client’s connection to the Instant Server (Nutrient Document Engine). ```APIDOC ## Class InstantClient ### Description The entry point to Nutrient Instant, representing a client’s connection to the Instant Server (Nutrient Document Engine). ### Type class ``` -------------------------------- ### AgentCompletionRequest Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.data.models/index.html Represents a request to get an agent-specific completion response from the AI Assistant. ```APIDOC data class AgentCompletionRequest(val requestId: String, val issuer: String, val documents: List, val parameters: AgentCompletionRequestParameters, val chatId: String, val agent: String? = null) ``` -------------------------------- ### PSPDFKit Object Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit/index.html The main entry point for the PSPDFKit library. Use .initialize to initialize the library if you are not using the PdfActivity or PdfFragment, which handle initialization automatically. ```APIDOC object PSPDFKit Main PSPDFKit entry point. Use .initialize to initialize the library if you are not using the [com.pspdfkit.ui.PdfActivity](../com.pspdfkit.ui/-pdf-activity/index.html) or the [com.pspdfkit.ui.PdfFragment](../com.pspdfkit.ui/-pdf-fragment/index.html) (which handle initialization on their own). ``` -------------------------------- ### Bundle.getSupportParcelable Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.utils/index.html Gets parcelable with the value associated to the given key using appropriate API for Android Tiramisu and upwards. ```APIDOC ## Bundle.getSupportParcelable ### Description Gets parcelable with the value associated to the given key using appropriate API for Android Tiramisu and upwards. ### Method Signature ```kotlin fun Bundle.getSupportParcelable(key: String, clazz: Class): T? ``` ### Parameters #### Path Parameters - **key** (String) - The key associated with the parcelable. - **clazz** (Class) - The class of the parcelable object. ### Returns - **T?** - The parcelable object associated with the key, or null if not found. ``` -------------------------------- ### InitializationProvider Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.initialization/index.html A ContentProvider used for initializing the Nutrient framework. ```APIDOC ## InitializationProvider ### Description An Android ContentProvider designed to facilitate the initialization process of the Nutrient framework. ### Class Signature open class InitializationProvider : ContentProvider ### Inheritance Inherits from `android.content.ContentProvider`. ``` -------------------------------- ### OnMenuItemsGenerateListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.listeners/index.html A listener that gets notified when the order of menu items should be declared and the menu items are being generated for the first time. ```APIDOC ## interface OnMenuItemsGenerateListener ### Description A listener that gets notified when the order of menu items should be declared and the menu items are being generated for the first time. ### Type interface OnMenuItemsGenerateListener ``` -------------------------------- ### SimpleInstantDocumentListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.listeners/index.html Empty implementation of InstantDocumentListener. ```APIDOC open class SimpleInstantDocumentListener : InstantDocumentListener Empty implementation of InstantDocumentListener. ``` -------------------------------- ### DocumentEditingToolbarItemPresets Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.toolbar.grouping.presets/index.html An open class providing a list of different presets for the DocumentEditingToolbar. These presets are optimized for the available space of icons on the current device, offering adaptive configurations for document editing. ```APIDOC ## open class DocumentEditingToolbarItemPresets ### Description List of different presets for the com.pspdfkit.ui.toolbar.DocumentEditingToolbar (based on the available space of icons visible on the current device). ``` -------------------------------- ### PSPDFKit Configuration Options Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration/index.html Configuration for the core of PSPDFKit rendering engine. To create the configuration use the Builder. ```APIDOC ## Configuration Properties This class represents the configuration for the core of the PSPDFKit rendering engine. It includes various boolean flags and state objects to control rendering and annotation behavior. ### Properties - **showSignHereOverlay** (Boolean) - Controls the display of the 'Sign Here' overlay. - **showNoteEditorForNewNoteAnnotations** (Boolean) - Determines if the note editor is shown for new note annotations. - **enableStylusOnDetection** (Boolean) - Enables stylus input detection. - **outlineElementState** (OutlineElementState) - Represents the state of an outline element. - **useCubicInterpolationForInkAnnotations** (Boolean) - Enables cubic interpolation for ink annotations. - **isAiAssistantEnabled** (Boolean) - Indicates if the AI assistant is enabled. - **annotationsBlockLinks** (Boolean) - Controls whether annotations block links. ### Creation To create a `Configuration` object, use the [Builder](-pdf-configuration/-builder/index.html). ``` -------------------------------- ### DocumentScrollListener Interface Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.listeners.scrolling/index.html Interface for listeners that can receive scrolling events of a PdfFragment. Implement this interface to get notified about scrolling activities. ```APIDOC interface DocumentScrollListener Interface for listeners that can receive scrolling events of a PdfFragment. ``` -------------------------------- ### Nutrient Object Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit/index.html The main entry point for the Nutrient library. Use .initialize to initialize the library if you are not using the PdfActivity or PdfFragment, which handle initialization automatically. ```APIDOC object Nutrient Main Nutrient entry point. Use .initialize to initialize the library if you are not using the [com.pspdfkit.ui.PdfActivity](../com.pspdfkit.ui/-pdf-activity/index.html) or the [com.pspdfkit.ui.PdfFragment](../com.pspdfkit.ui/-pdf-fragment/index.html) (which handle initialization on their own). ``` -------------------------------- ### InitializationRequest Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.data.models/index.html Request object used to initialize an AI Assistant session. It includes session details and client features. ```APIDOC ## InitializationRequest ### Description Request to initialize an AI Assistant session. ### Fields - **requestId** (String?) - Optional identifier for the request. - **userId** (String?) - Optional identifier for the user. - **sessionId** (String) - Required identifier for the session. - **clientFeatures** (Array) - List of features supported by the client. ``` -------------------------------- ### Bundle.getSupportParcelableArrayList Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.utils/index.html Gets parcelable array list with the value associated to the given key using appropriate API for Android Tiramisu and upwards. ```APIDOC ## Bundle.getSupportParcelableArrayList ### Description Gets parcelable array list with the value associated to the given key using appropriate API for Android Tiramisu and upwards. ### Method Signature ```kotlin fun Bundle.getSupportParcelableArrayList(key: String, clazz: Class): ArrayList? ``` ### Parameters #### Path Parameters - **key** (String) - The key associated with the parcelable array list. - **clazz** (Class) - The class of the parcelable objects in the list. ### Returns - **ArrayList?** - An ArrayList of parcelable objects associated with the key, or null if not found. ``` -------------------------------- ### showAiAssistant Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ai/index.html Shows the AI Assistant dialog in the provided FragmentActivity. ```APIDOC ## showAiAssistant ### Description Shows the AI Assistant dialog in the provided [FragmentActivity](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity.html). ### Method Signature fun showAiAssistant(activity: FragmentActivity, textSelection: TextSelection? = null) ``` -------------------------------- ### createAiAssistantForInstant Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ai/index.html Factory method to create an instance of the AiAssistant for Instant documents. ```APIDOC ## createAiAssistantForInstant ### Description Factory method to create an instance of the AiAssistant for Instant documents. ### Method Signature fun createAiAssistantForInstant(context: Context, instantServerUrl: String, documentLayerJwts: List, aiAssistantServerUrl: String, sessionId: String, jwtToken: (List) -> String): AiAssistant ``` -------------------------------- ### MediaViewListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.media/index.html A listener for media content preparation. ```APIDOC ## MediaViewListener ### Description A listener for media content preparation. ### Interface interface MediaViewListener ``` -------------------------------- ### getDefaultInstantDocumentManager Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.jetpack.compose.interactors/index.html A Composable helper function to get an InstantDocumentManager instance. It allows for customization by accepting various listeners for document, annotation, UI, form, and instant events. ```APIDOC @Composable fun getDefaultInstantDocumentManager( documentListener: DocumentListener = DefaultListeners.documentListeners(), annotationListener: AnnotationListener = DefaultListeners.annotationListeners(), uiListener: UiListener = DefaultListeners.uiListeners(), formListener: FormListener = DefaultListeners.formListeners(), instantListener: InstantDocumentListener = DefaultListeners.instantListeners() ): InstantDocumentManager ``` -------------------------------- ### InstantPdfUiFragmentBuilder Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.ui/index.html An experimental builder class for creating InstantPdfUiFragment. Note: This API is experimental and might change. ```APIDOC ## InstantPdfUiFragmentBuilder ### Description **Experimental API - Might change in the future.** Builder used for creating an InstantPdfUiFragment. ### Class class InstantPdfUiFragmentBuilder ``` -------------------------------- ### SearchConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration.search/index.html Represents the configuration settings for search operations, including parameters like the number of characters to start searching, snippet length, and maximum search results. ```APIDOC class SearchConfiguration(val startSearchChars: Int = DEFAULT_START_SEARCH_CHARS, val snippetLength: Int = DEFAULT_SNIPPET_LENGTH, val startSearchOnCurrentPage: Boolean = false, val maxSearchResults: Int? = null) : Parcelable ``` -------------------------------- ### InstantDocumentView Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.jetpack.compose.views/index.html Composable that displays an Instant document with real-time collaboration support. ```APIDOC ## InstantDocumentView ### Description Composable that displays an Instant document with real-time collaboration support. ### Parameters * `documentState` (DocumentState) - The state of the document to display. * `modifier` (Modifier) - Optional modifier for the composable. * `instantDocumentManager` (InstantDocumentManager) - The instant document manager to use, defaults to `getDefaultInstantDocumentManager()`. ``` -------------------------------- ### MediaLinkUtils Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.media/index.html Methods for handling PSPDFKit media links. ```APIDOC ## MediaLinkUtils ### Description Methods for handling PSPDFKit media links. ### Class open class MediaLinkUtils ``` -------------------------------- ### InstantDownloadException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.exceptions/index.html Thrown when there's an error while downloading an instant document. ```APIDOC ## InstantDownloadException ### Description Thrown when there's an error while downloading instant document. ### Class open class InstantDownloadException : InstantException ``` -------------------------------- ### NutrientInitializationFailedException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.exceptions/index.html Thrown when the initialization of the Nutrient library fails. ```APIDOC ## Exception: NutrientInitializationFailedException ### Description Thrown when the initialization of the Nutrient library fails. ### Class Hierarchy [NutrientInitializationFailedException](-nutrient-initialization-failed-exception/index.html) ``` -------------------------------- ### InstantSyncException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.exceptions/index.html Thrown when there's an error while syncing annotations with the Instant Server. ```APIDOC ## InstantSyncException ### Description Thrown when there's an error while syncing annotations with Instant Server (Nutrient Document Engine). ### Class open class InstantSyncException : InstantException ``` -------------------------------- ### createAiAssistant Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ai/index.html Factory method to create an instance of the AiAssistant. ```APIDOC ## createAiAssistant ### Description Factory method to create an instance of the AiAssistant. ### Method Signature fun createAiAssistant(context: Context, documentsDescriptors: List, serverUrl: String, sessionId: String, jwtToken: (List) -> String): AiAssistant ``` -------------------------------- ### InstantProgress Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.client/index.html Object representing instant document download or annotations sync progress. ```APIDOC ## Class InstantProgress ### Description Object representing instant document download or annotations sync progress. ### Type class ``` -------------------------------- ### SigningConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.signatures/index.html Contains essential data for basic signing operations. ```APIDOC ## Data Class: SigningConfiguration ### Description Contains the essential data needed for basic signing operations with `SigningManager.signWithBasicSignature` and `SigningManager.signWithCAdESSignature`. ### Properties - **privateKey** (`PrivateKey`) - The private key for signing. - **certificates** (`List`) - The list of X.509 certificates. - **metadata** (`DigitalSignatureMetadata?`) - Optional - Metadata for the digital signature. ``` -------------------------------- ### InstantException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.exceptions/index.html Thrown when there's an error while communicating with the Instant Server. ```APIDOC ## InstantException ### Description Thrown when there's an error while communicating with Instant Server (Nutrient Document Engine). ### Class open class InstantException : RuntimeException ``` -------------------------------- ### InstantJsonVersion Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.client/index.html Currently supported Instant JSON format versions. ```APIDOC ## Enum InstantJsonVersion ### Description Currently supported Instant JSON format versions. ### Type enum ``` -------------------------------- ### AnnotationNoteHinterThemeConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.note/index.html A wrapper class for extracting theme attributes related to the annotation note hinter. ```APIDOC ## open class AnnotationNoteHinterThemeConfiguration ### Description Wrapper class for extracting annotation note hinter theme attributes. ### Class Signature open class AnnotationNoteHinterThemeConfiguration ``` -------------------------------- ### OverlayViewProvider Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.overlay/index.html Base class for classes that can return a list of views that should be drawn on top of the document. ```APIDOC ## OverlayViewProvider ### Description Base class for classes that can return a list of views that should be drawn on top of the document. ### Class abstract class OverlayViewProvider : PageObjectProvider ``` -------------------------------- ### LaunchAction Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.actions/index.html Represents an action to launch an external application or file. It can be followed by other actions. ```APIDOC ## LaunchAction ### Description Represents an action to launch an external application or file. ### Class Signature `LaunchAction(path: String?, subActions: List = emptyList()) : Action` ### Parameters * `path` (String?) - Optional. The path to the application or file to launch. * `subActions` (List) - Optional. A list of actions to perform after this action. ``` -------------------------------- ### LocalizationListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.listeners/index.html Listener that allows SDK UI strings to be localized programmatically. ```APIDOC ## interface LocalizationListener ### Description Listener that allows SDK UI strings to be localized programmatically. ### Type interface LocalizationListener ``` -------------------------------- ### NutrientInitializationFailedException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.exceptions/index.html This exception is thrown when the current device is not supported by the Nutrient SDK. This can occur due to an outdated Android version or an incompatible ABI. ```APIDOC ## NutrientInitializationFailedException ### Description Thrown when current device isn't supported by Nutrient (Android version too old, wrong ABI). ### Throws `NutrientInitializationFailedException` ``` -------------------------------- ### AnnotationCreationToolbarItemPresets Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.toolbar.grouping.presets/index.html A list of different presets for the AnnotationToolbar, designed to adapt to the available space for icons on the current device. It provides predefined configurations for the annotation toolbar. ```APIDOC ## object AnnotationCreationToolbarItemPresets ### Description List of different presets for the com.pspdfkit.ui.toolbar.AnnotationToolbar (based on the available space of icons visible on the current device). ``` -------------------------------- ### DefaultSharingMenu Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.actionmenu/index.html A SharingMenu that includes fixed actions for printing and opening documents, in addition to standard sharing actions. ```APIDOC ## DefaultSharingMenu ### Description Displays fixed actions for printing and opening documents in addition to standard share actions shown in [SharingMenu](-sharing-menu/index.html). ### Type open class DefaultSharingMenu : [SharingMenu](-sharing-menu/index.html) ``` -------------------------------- ### WebViewSettingsCustomizer Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.html/index.html Interface for customizing WebView settings, particularly for enabling file access for local HTML files. ```APIDOC interface WebViewSettingsCustomizer Interface for customizing the settings of a WebView. Implementations of this interface can modify the provided WebSettings object to enforce specific configurations or policies. This is mostly used to enable the security-risk WebSettings.setAllowFileAccess which can make HTML to PDF conversion work with HTML files on the device. ``` -------------------------------- ### SharingOptionsProvider Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.sharing/index.html Interface allowing you to provide default share options when the user initiates a share action. Enables customization of default sharing behavior. ```APIDOC ## SharingOptionsProvider ### Description Allows you to provide default share options when the user hits the share button in the toolbar. ### Interface interface SharingOptionsProvider ``` -------------------------------- ### URLDownloadSource Class Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.download.source/index.html Download using a URL (usually from the web). ```APIDOC open class URLDownloadSource : DownloadSource Download using a [URL](https://developer.android.com/reference/kotlin/java/net/URL.html) (usually from the web). ``` -------------------------------- ### InstantPdfDocument Interface Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.document/index.html Represents a PDF document managed by the Instant SDK. Instances can be created using InstantClient.openDocument or InstantClient.openDocumentAsync. ```APIDOC interface InstantPdfDocument : PdfDocument { // Methods and properties for managing an Instant PDF document. // Inherits from PdfDocument. } // To create an instance: // InstantClient.openDocument(path) // InstantClient.openDocumentAsync(path) ``` -------------------------------- ### MediaViewController Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.media/index.html An interface to be implemented by the views that control the media files. ```APIDOC ## MediaViewController ### Description An interface to be implemented by the views that control the media files. ### Interface interface MediaViewController ``` -------------------------------- ### GoToAction Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.actions/index.html Represents a PDF action to navigate to a different page. This action can be configured with a specific page index and an optional destination. ```APIDOC ## GoToAction ### Description PDF action representing a change to another page. ### Constructor @[JvmOverloads] constructor(val pageIndex: Int, subActions: List = emptyList(), val destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f, )) ### Class class GoToAction : Action ``` -------------------------------- ### PrintOptionsProvider Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.printing/index.html An interface that allows providing default print options when the user initiates printing. ```APIDOC ## PrintOptionsProvider ### Description Allows you to provide default print options when the user hits the share button in the toolbar. ### Interface interface PrintOptionsProvider ``` -------------------------------- ### AiAssistantConfiguration Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.data.models/index.html Configuration for AI Assistant. With AI Assistant, users can use AI chat to summarize, translate, and ask questions about documents. ```APIDOC data class AiAssistantConfiguration(val serverUrl: String, val jwt: String, val sessionId: String, val userId: String? = null) ``` -------------------------------- ### LocalizedSwitch Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui/index.html This is a Switch that will use registered `com.pspdfkit.listeners.LocalizationListener` to localize its contents. ```APIDOC ## LocalizedSwitch ### Description This is a Switch that will use registered `com.pspdfkit.listeners.LocalizationListener` to localize its contents. ### Class open class LocalizedSwitch : SwitchCompat ``` -------------------------------- ### Dark Mode Initialization Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.settings/index.html Initializes dark mode based on local storage settings or operating system preferences. If dark mode is enabled, it adds the 'theme-dark' class to the HTML element. ```javascript var pathToRoot = "../../"; document.documentElement.classList.replace("no-js", "js"); const storage = localStorage.getItem("dokka-dark-mode") if (storage == null) { const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches if (osDarkSchemePreferred === true) { document.getElementsByTagName("html")[0].classList.add("theme-dark") } } else { const savedDarkMode = JSON.parse(storage) if (savedDarkMode === true) { document.getElementsByTagName("html")[0].classList.add("theme-dark") } } ``` -------------------------------- ### getAiAssistantColorScheme Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.ui.theme/index.html Creates an AiAssistantColorScheme with customizable colors for AI assistant UI components like chat backgrounds, text, and input fields. ```APIDOC ## getAiAssistantColorScheme ### Description Creates an `AiAssistantColorScheme` with the specified colors for AI assistant UI components. ### Signature ```kotlin @Composable fun getAiAssistantColorScheme( containerColor: Color = MaterialTheme.colorScheme.background, chatBackground: Color = MaterialTheme.colorScheme.surface, mineChatBackground: Color = MaterialTheme.colorScheme.secondary, mineChatTextColor: Color = MaterialTheme.colorScheme.onSecondary, innerChatBackground: Color = MaterialTheme.colorScheme.secondaryContainer, innerChatTextColor: Color = MaterialTheme.colorScheme.onSecondaryContainer, textFieldBackgroundColor: Color = MaterialTheme.colorScheme.background, textFieldTextColor: Color = MaterialTheme.colorScheme.onSecondary, textFieldHintColor: Color = MaterialTheme.colorScheme.onSecondary, retryButtonBackgroundColor: Color = MaterialTheme.colorScheme.onSecondaryContainer, textColor: Color = MaterialTheme.colorScheme.primary, labelColor: Color = MaterialTheme.colorScheme.primary, iconColor: Color = MaterialTheme.colorScheme.primary, submitButtonEnabledColor: Color = MaterialTheme.colorScheme.secondaryContainer ): AiAssistantColorScheme ``` ### Parameters * `containerColor` (Color) - Default: `MaterialTheme.colorScheme.background` * `chatBackground` (Color) - Default: `MaterialTheme.colorScheme.surface` * `mineChatBackground` (Color) - Default: `MaterialTheme.colorScheme.secondary` * `mineChatTextColor` (Color) - Default: `MaterialTheme.colorScheme.onSecondary` * `innerChatBackground` (Color) - Default: `MaterialTheme.colorScheme.secondaryContainer` * `innerChatTextColor` (Color) - Default: `MaterialTheme.colorScheme.onSecondaryContainer` * `textFieldBackgroundColor` (Color) - Default: `MaterialTheme.colorScheme.background` * `textFieldTextColor` (Color) - Default: `MaterialTheme.colorScheme.onSecondary` * `textFieldHintColor` (Color) - Default: `MaterialTheme.colorScheme.onSecondary` * `retryButtonBackgroundColor` (Color) - Default: `MaterialTheme.colorScheme.onSecondaryContainer` * `textColor` (Color) - Default: `MaterialTheme.colorScheme.primary` * `labelColor` (Color) - Default: `MaterialTheme.colorScheme.primary` * `iconColor` (Color) - Default: `MaterialTheme.colorScheme.primary` * `submitButtonEnabledColor` (Color) - Default: `MaterialTheme.colorScheme.secondaryContainer` ### Returns An `AiAssistantColorScheme` object. ``` -------------------------------- ### DataProvider Interface Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.providers/index.html The DataProvider interface allows PSPDFKit to load a PDF document from any custom source. This is the core interface for defining how documents are accessed. ```APIDOC ## interface DataProvider ### Description A data provider is allows PSPDFKit to load a PDF document for any custom source (e.g. ``` -------------------------------- ### MainToolbar Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.jetpack.compose.components/index.html Composable that displays the Main tool bar for DocumentView. ```APIDOC ## MainToolbar ### Description Composable that displays the Main tool bar for [DocumentView](../com.pspdfkit.jetpack.compose.views/-document-view.html). ### Parameters - **modifier** ([Modifier](https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.html)) - Optional - Defaults to Modifier. - **documentState** ([DocumentState](../com.pspdfkit.jetpack.compose.interactors/-document-state/index.html)) - Required - The state of the document. - **colorScheme** ([UiColorScheme](../com.pspdfkit.compose.theme/-ui-color-scheme/index.html)) - Optional - Defaults to getUiColors(). - **windowInsets** ([WindowInsets](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/WindowInsets.html)) - Optional - Defaults to TopAppBarDefaults.windowInsets. - **customTitle** (@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) ([String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)?) - Optional - A composable lambda for a custom title. - **navigationIcon** (@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) (tintColor: [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html)) -> [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)) - Optional - A composable lambda for the navigation icon. - **actions** (@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) [RowScope](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/RowScope.html).(tintColor: [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html)) -> [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)) - Optional - A composable lambda for actions in the toolbar. - **overFlowActions** (@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) [ColumnScope](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/ColumnScope.html).(tintColor: [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html)) -> [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)?) - Optional - A composable lambda for overflow actions. - **showTitleBar** ([Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)) - Optional - Defaults to true. Whether to show the title bar. - **onHeightChanged** (([Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)) -> [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)?) - Optional - Callback for when the height of the toolbar changes. ``` -------------------------------- ### AnnotationNoteIconConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.configuration/index.html Configuration for note annotation icons ([NOTE_ICON](-annotation-property/-n-o-t-e_-i-c-o-n/index.html)). ```APIDOC ## Interface AnnotationNoteIconConfiguration ### Description Configuration for note annotation icons ([NOTE_ICON](-annotation-property/-n-o-t-e_-i-c-o-n/index.html)). ### Implements - [AnnotationConfiguration](-annotation-configuration/index.html) ### See Also - [AnnotationConfiguration](-annotation-configuration/index.html) ``` -------------------------------- ### ImagePicker Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.image/index.html A helper class for launching the gallery image picker or a camera for taking a picture. ```APIDOC class ImagePicker A helper class for launching gallery image picker or a camera for taking a picture. ``` -------------------------------- ### DocumentSharingProviderProcessor Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.sharing/index.html Prepares data in DocumentSharingProvider for sharing via Android's share framework. Handles the necessary data transformations before the share intent is invoked. ```APIDOC ## DocumentSharingProviderProcessor ### Description Prepares data in [DocumentSharingProvider] for sharing via Android's share framework. ### Class open class DocumentSharingProviderProcessor ``` -------------------------------- ### BookmarkProvider Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.bookmarks/index.html Handles all bookmark related operations on the owning document. This is an interface for managing bookmarks. ```APIDOC ## BookmarkProvider ### Description Handles all bookmark related operations on the owning document. This is an interface for managing bookmarks. ### Interface interface BookmarkProvider ### Type [BookmarkProvider](-bookmark-provider/index.html) ``` -------------------------------- ### SdkTheme Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.compose.theme/index.html Container class holding colors and icons for the SDK's UI. ```APIDOC ## SdkTheme ### Description Container class that holds colors as well as icons to be used in the app. ### Properties - `colors` (UiColorScheme) - The color scheme for the UI. - `icons` (UiIconScheme) - The icon scheme for the UI. ``` -------------------------------- ### SignatureCreationMode Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration.signatures/index.html The possible ways in which the user can input their signature. ```APIDOC ## enum SignatureCreationMode ### Description The possible ways in which the user can input their signature. ### Enum Constants This enum does not explicitly list its constants in the provided documentation. ``` -------------------------------- ### InstantDocumentDescriptor Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.client/index.html Descriptor/handle for InstantPdfDocument that provides methods for downloading/opening instant documents. ```APIDOC ## Class InstantDocumentDescriptor ### Description Descriptor/handle for [InstantPdfDocument](../com.pspdfkit.instant.document/-instant-pdf-document/index.html) that provides methods for downloading/opening instant documents. ### Type class ``` -------------------------------- ### getSettingsColorScheme Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.ui.theme/index.html Creates a SettingsColorScheme with the specified colors for settings UI components. Allows customization of primary, secondary, background, and text colors. ```APIDOC ## getSettingsColorScheme ### Description Creates a `SettingsColorScheme` with the specified colors for settings UI components. ### Signature ```kotlin fun getSettingsColorScheme( selectedColor: Color = MaterialTheme.colorScheme.primary, unselectedColor: Color = MaterialTheme.colorScheme.secondary, unselectedTextColor: Color = MaterialTheme.colorScheme.secondary, background: Color = MaterialTheme.colorScheme.background, dividerColor: Color = MaterialTheme.colorScheme.onPrimaryContainer, titleTextColor: Color = MaterialTheme.colorScheme.onBackground, labelTextColor: Color = MaterialTheme.colorScheme.onBackground ): SettingsColorScheme ``` ### Parameters * **selectedColor** (Color) - Optional - The primary selected color. * **unselectedColor** (Color) - Optional - The primary unselected color. * **unselectedTextColor** (Color) - Optional - The color for unselected text. * **background** (Color) - Optional - The background color for the settings UI. * **dividerColor** (Color) - Optional - The color for dividers. * **titleTextColor** (Color) - Optional - The color for title text. * **labelTextColor** (Color) - Optional - The color for label text. ### Returns * **SettingsColorScheme** - A `SettingsColorScheme` object configured with the provided colors. ``` -------------------------------- ### InstantPdfUiFragment Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.ui/index.html An experimental Fragment for displaying instant PDF documents, part of the UI. It extends PdfUiFragment and implements InstantDocumentListener. Note: This API is experimental and might change. ```APIDOC ## InstantPdfUiFragment ### Description **Experimental API - Might change in the future.** Fragment for displaying instant PDF documents as part of the UI. ### Class open class InstantPdfUiFragment : PdfUiFragment, InstantDocumentListener ``` -------------------------------- ### InstantDocumentListener Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.listeners/index.html Listener for com.pspdfkit.instant.document.InstantPdfDocument events. ```APIDOC interface InstantDocumentListener Listener for com.pspdfkit.instant.document.InstantPdfDocument events. ``` -------------------------------- ### SoundAnnotationConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.configuration/index.html Configuration for sound annotations. ```APIDOC ## SoundAnnotationConfiguration ### Description Configuration for sound annotations. ### Interface `SoundAnnotationConfiguration` ### Implements - `AnnotationConfiguration` ``` -------------------------------- ### PdfActivityConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration.activity/index.html Represents the configuration for displaying a PDF in an activity or fragment. It includes settings for UI elements, features, and behavior. ```APIDOC ## PdfActivityConfiguration ### Description Represents the configuration for displaying a PDF in an activity or fragment. It includes settings for UI elements, features, and behavior. ### Properties - **configuration** (PdfConfiguration) - The main PDF configuration. - **activityTitle** (String?) - The title for the activity. - **layout** (Int) - The layout resource ID. - **theme** (Int) - The theme resource ID for the activity. - **darkTheme** (Int) - The dark theme resource ID for the activity. - **isImmersiveModeEnabled** (Boolean) - Enables immersive mode. - **isShowPageNumberOverlay** (Boolean) - Shows the page number overlay. - **isSignatureButtonPositionForcedInMainToolbar** (Boolean) - Forces the signature button position in the main toolbar. - **isShowPageLabels** (Boolean) - Shows page labels. - **isShowDocumentTitleOverlayEnabled** (Boolean) - Enables the document title overlay. - **isShowNavigationButtonsEnabled** (Boolean) - Enables navigation buttons. - **thumbnailBarMode** (ThumbnailBarMode) - Controls the thumbnail bar mode. - **isThumbnailGridEnabled** (Boolean) - Enables the thumbnail grid. - **isDocumentEditorEnabled** (Boolean) - Enables the document editor. - **isSearchEnabled** (Boolean) - Enables search functionality. - **isSettingsItemEnabled** (Boolean) - Enables the settings item in the UI. - **settingsMenuItemShown** (EnumSet) - Specifies which settings menu items are shown. - **searchType** (SearchType) - The type of search to perform. - **isPrintingEnabled** (Boolean) - Enables printing functionality. - **userInterfaceViewMode** (UserInterfaceViewMode) - The view mode for the user interface. - **hideUserInterfaceWhenCreatingAnnotations** (Boolean) - Hides the user interface when creating annotations. - **isAnnotationListEnabled** (Boolean) - Enables the annotation list. - **isDefaultToolbarEnabled** (Boolean) - Enables the default toolbar. - **isAnnotationListReorderingEnabled** (Boolean) - Enables reordering of annotations in the list. - **listedAnnotationTypes** (EnumSet) - The types of annotations to list. - **isOutlineEnabled** (Boolean) - Enables the document outline. - **isEmbeddedFilesViewEnabled** (Boolean) - Enables the embedded files view. - **isBookmarkListEnabled** (Boolean) - Enables the bookmark list. - **isDocumentInfoViewEnabled** (Boolean) - Enables the document information view. - **isDocumentInfoViewSeparated** (Boolean) - Separates the document information view. - **page** (Int) - The starting page number (0-indexed). - **searchConfiguration** (SearchConfiguration?) - Optional search configuration. - **isAnnotationNoteHintingEnabled** (Boolean) - Enables hinting for annotation notes. - **tabBarHidingMode** (TabBarHidingMode) - Controls the tab bar hiding mode. - **isVolumeButtonsNavigationEnabled** (Boolean) - Enables navigation using volume buttons. - **isRedactionUiEnabled** (Boolean) - Enables the redaction UI. - **isReaderViewEnabled** (Boolean) - Enables the reader view. ### Usage Use `PdfActivityConfiguration.Builder.build()` to create an instance of this class. ``` -------------------------------- ### UiTheme Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.compose.theme/index.html Local theme object to access all custom color attributes and icons. ```APIDOC ## UiTheme ### Description Local theme object to access all custom color attributes and icons. Can be accessed as `UiTheme.colors...` or `UiTheme.icons...` within a Composable context. ### Usage ```kotlin // Accessing colors val toolbarColor = UiTheme.colors.mainToolbar.backgroundColor // Accessing icons val documentInfoIcon = UiTheme.icons.documentInfoIconScheme.documentInfoContentIcon ``` ``` -------------------------------- ### InstantAnnotationProvider Interface Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.instant.annotations/index.html The InstantAnnotationProvider interface provides methods for managing annotations within an Instant PDF document. It is accessible via the InstantPdfDocument. ```APIDOC ## Interface InstantAnnotationProvider ### Description Handles all annotation related operations on the owning Instant document. ### Retrieve Retrieve it with `com.pspdfkit.instant.document.InstantPdfDocument.getAnnotationProvider()`. ``` -------------------------------- ### WavWriter Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.sound/index.html Allows writing WAV files from audio data, with a constructor suitable for SoundAnnotations. ```APIDOC class WavWriter(audioData: ByteArray, sampleRate: Int, sampleSize: Int, channels: Int, audioDataByteOrder: ByteOrder = ByteOrder.BIG_ENDIAN) Allows you to write wav files from audio data. Comes with a handy constructor for [SoundAnnotation](../com.pspdfkit.annotations/-sound-annotation/index.html)s. ``` -------------------------------- ### Parameters Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.data.models/index.html Contains parameters associated with a suggestion from the AI Assistant, including input text and additional context. ```APIDOC ## Parameters ### Description Parameters associated with a suggestion from the AI Assistant. ### Fields - **input** (String?) - Optional input text for the suggestion. - **context** (AdditionalContext?) - Optional additional context for the suggestion. ``` -------------------------------- ### loadCertificateFromFile Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.signatures/index.html Convenience method to load a X.509 certificate from a File. ```APIDOC ## loadCertificateFromFile ### Description Convenience method to load a X.509 certificate from a [File](https://developer.android.com/reference/kotlin/java/io/File.html). ### Function Signature ```kotlin fun loadCertificateFromFile(file: File): X509Certificate ``` ### Parameters * `file` (File) - The file containing the X.509 certificate. ### Returns * `X509Certificate` - The loaded X509 certificate. ``` -------------------------------- ### ThumbnailBarTheme Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.ui.thumbnail/index.html Documentation for ThumbnailBarTheme, related to styling the thumbnail bar. ```APIDOC ThumbnailBarTheme (No further details provided in the source for this item.) ``` -------------------------------- ### standaloneAiAssistant Source: https://www.nutrient.io/api/android/nutrient/io.nutrient.domain.ai/index.html Factory function to create an instance of the AiAssistant. This function initializes and returns an AiAssistant object, which can be used to interact with AI-driven assistance features. It requires the Android Context, AI assistant configuration details, and a list of document identifiers. ```APIDOC ## standaloneAiAssistant ### Description Factory function to create an instance of the AiAssistant. ### Signature fun standaloneAiAssistant(context: Context, aiAssistantConfiguration: AiAssistantConfiguration, listOfDocumentIdentifiers: List): AiAssistant ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (AiAssistant) - Returns an instance of AiAssistant. #### Response Example None ``` -------------------------------- ### DownloadException Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.document.download.exceptions/index.html Exceptions thrown when there is an issue with downloading a document through DownloadJob or UrlDataProvider. ```APIDOC ## DownloadException ### Description Exceptions thrown when there is an issue with downloading a document through [DownloadJob](../com.pspdfkit.document.download/-download-job/index.html)/[UrlDataProvider](../com.pspdfkit.document.providers/-url-data-provider/index.html). ### Class Hierarchy sealed class DownloadException : [IOException](https://developer.android.com/reference/kotlin/java/io/IOException.html) ``` -------------------------------- ### AnnotationPreviewConfiguration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.annotations.configuration/index.html Configuration for the preview of annotations in the inspector. ```APIDOC ## AnnotationPreviewConfiguration ### Description Configuration for preview in annotation inspector. ### Interface `AnnotationPreviewConfiguration` ``` -------------------------------- ### Annotation Configuration Source: https://www.nutrient.io/api/android/nutrient/com.pspdfkit.configuration/index.html Configure various settings related to annotation behavior and display. ```APIDOC ## Annotation Configuration Properties This section details properties that control annotation behavior: ### `isMeasurementsEnabled` (Boolean) Controls whether measurement annotations are enabled. ### `isAnnotationLimitedToPageBounds` (Boolean) Determines if annotations are restricted to page boundaries. ### `useRectangleSelectionForMarkupAnnotations` (Boolean) Enables rectangle selection for markup annotations. ### `editableAnnotationTypes` (List) Specifies which annotation types are editable. ### `enabledAnnotationTools` (List) Defines the annotation tools that are enabled for user interaction. ### `selectedAnnotationResizeEnabled` (Boolean) Enables resizing of selected annotations. ### `selectedAnnotationResizeGuidesEnabled` (Boolean) Enables resize guides for selected annotations. ### `selectedAnnotationFontScalingOnResizeEnabled` (Boolean) Enables font scaling for selected annotations when resizing. ### `resizeGuideSnapAllowance` (Float) The snap allowance for resize guides. ### `guideLineIntervals` (List) Intervals for guideline display during resizing. ### `isAnnotationInspectorEnabled` (Boolean) Enables the annotation inspector. ### `excludedAnnotationTypes` (List) Specifies annotation types to be excluded from certain operations or displays. ### `isAutosaveEnabled` (Boolean) Enables automatic saving of annotations. ### `pagePadding` (Int) Padding around pages for annotation display. ### `isLastViewedPageRestorationEnabled` (Boolean) Enables restoration of the last viewed page upon opening. ### `isAutomaticLinkGenerationEnabled` (Boolean) Enables automatic generation of links from text. ### `isCopyPasteEnabled` (Boolean) Enables copy-paste functionality for annotations. ### `enabledCopyPasteFeatures` (EnumSet) Specifies which copy-paste features are enabled. ### `isUndoEnabled` (Boolean) Enables undo functionality for annotation actions. ### `isRedoEnabled` (Boolean) Enables redo functionality for annotation actions. ### `annotationReplyFeatures` (AnnotationReplyFeatures) Configuration for annotation reply features. ### `fixedFullPageRenderPixelCount` (Int?) Specifies a fixed pixel count for full-page rendering, if applicable. ### `isMultithreadedRenderingEnabled` (Boolean) Enables multithreaded rendering for improved performance. ### `signaturePickerOrientation` (SignaturePickerOrientation) Orientation of the signature picker. ### `signatureSavingStrategy` (SignatureSavingStrategy) Strategy for saving signatures. ### `signatureColorOptions` (SignatureColorOptions) Options for signature colors. ### `signatureCreationModes` (List) Supported modes for signature creation. ### `isNoteAnnotationNoZoomHandlingEnabled` (Boolean) Disables zoom handling for note annotations. ### `isJavaScriptEnabled` (Boolean) Enables JavaScript execution within the PDF. ### `isTextSelectionPopupToolbarEnabled` (Boolean) Enables the popup toolbar for text selection. ### `isAnnotationPopupToolbarEnabled` (Boolean) Enables the popup toolbar for annotations. ### `enabledShareFeatures` (EnumSet) Specifies which sharing features are enabled. ### `allowMultipleBookmarksPerPage` (Boolean) Allows multiple bookmarks to be placed on a single page. ### `scrollOnEdgeTapEnabled` (Boolean) Enables scrolling when tapping on the edge of the screen. ### `animateScrollOnEdgeTaps` (Boolean) Animates scrolling when tapping on screen edges. ### `scrollOnEdgeTapMargin` (Int) Margin for edge tap scrolling. ### `isMagnifierEnabled` (Boolean) Enables the magnifier tool. ```