Add or update a related CRM entity. This is only available for customers who have enabled CRM integration.
Add pdf document to microsite
Show a native alert popup
the message to be shown
the title of the popup
Choose content sharing option
Close current publication
Combine multiple pdf files into a single pdf file
Delete a CRM entity. This is only available for customers who have enabled CRM integration.
Delete a file, only available in beta versions
Delete a local file - which is a file owned by a publication
is the key of the publication or an empty string (=current publication)
is the name of the file in the local database
Trigger the sending of data to the server
Take a screenshot and save it as a file
Save an image as a pdf
Get an authentication token, only available in apps that work with SSO
Get CRM configuration. This is only available for customers who have enabled CRM integration.
Get current meeting. This is only available for customers who have enabled CRM integration.
Get current meeting preparation. This is only available for customers who have enabled CRM integration.
Get info about the current customer session
Retrieve enterprise details of the enterprise to which the user belongs
Get CRM entities. This is only available for customers who have enabled CRM integration.
Get CRM entities by query. This is only available for customers who have enabled CRM integration.
Search for CRM entities. This is only available for customers who have enabled CRM integration.
Get documents related to an entity This is only available for customers who have enabled CRM integration.
Get a file, only available in beta versions
Get file contents, only available in beta versions. For .png, .jpg, .txt and .json files only.
Get info about the last time a publication was visited
Get a local file - which is a file owned by a publication
is the key of the publication or an empty string (=current publication)
is the name of the file in the local database
Retrieve details about file transactions
is an array of local keys of the transactions that you wish to know more about
Get a list of available pdf files
Get metadata for a CRM entity. This is only available for customers who have enabled CRM integration.
Get entities that have not been synced. This is only available for customers who have enabled CRM integration.
Get picture by url.
Get specific meeting preparation. This is only available for customers who have enabled CRM integration.
Get cover of specific publication
Retrieve details about the publication
is an identifier for the publication, pass in empty string to retrieve current publication
Get queries for a CRM entity. This is only available for customers who have enabled CRM integration.
Get related CRM entities. This is only available for customers who have enabled CRM integration.
getState will retrieve the recorded publication state
is an identifier for the publication, usually the publication name
is the namespace in which the data is stored
is the key which will enable you to look up the data
Retrieve the user profile
Get visit analytics reports of CRM entity. This is only available for customers who have enabled CRM integration.
Mail a list of pdf files
Open a url in a browser
Open a kiosk from within the current publication
Open another publication from within the current publication
Pick files that you want to add to a visit report.
Register events identified by an eventString and associate them with an optional payload
recordState will save the desired publication state
is an identifier for the publication, usually the publication name
is the namespace in which you want to store your data
is the key which will enable you to look up the data
should be a json stringified object
recordStats will gather stats per page.
should be a json stringified IVisit object.
Register a listener that will be called when the network status changes.
Register a listener that will be called when the queue size changes. This is only available for customers who have enabled CRM integration.
Save a file by using a file picker
Send an email with pdf files as attachments
Store a CRM entity for offline usage. This is only available for customers who have enabled CRM integration.
Decide if the CRM will fetch online data or just local, offline data. This is only available for customers who have enabled CRM integration.
Show a local pdf document in a pdf viewer
indicates if file can be added to account hub, default value will depend on publication from which the document is opened
indicates if annotations option needs to be available, default value is true
Show a remote pdf document in a pdf viewer
Start meeting. This is only available for customers who have enabled CRM integration.
Start preparation of meeting. This is only available for customers who have enabled CRM integration.
Stop meeting. This is only available for customers who have enabled CRM integration.
Stop active meeting preparation. This is only available for customers who have enabled CRM integration.
Store a file (without picker)
Store a local file
is the key of the publication or an empty string (=current publication)
is the name of the file in the local database
is the type of file
is the content of the file
determines when the local file should be removed - pass in 0 if it shouldn't be removed
Store a pdf as a local file - which is a file owned by a publication
Creates a transaction containing multiple files
is an array of strings (the fileIdentifiers passed into storeLocalFile)
is the url that will be called after all data is ready
indicates if files have to be removed after syncing
Generated using TypeDoc
DKPlugin is the API offered to communicate from Javascript to native code