Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DKPlugin

DKPlugin is the API offered to communicate from Javascript to native code

Hierarchy

  • DKPlugin

Index

Methods

addOrUpdateRelatedEntity

addPdfToMicroSite

alert

  • alert(message: string, title?: string): void
  • Show a native alert popup

    Parameters

    • message: string

      the message to be shown

    • Optional title: string

      the title of the popup

    Returns void

closeCurrentPublication

concatPdf

deleteEntity

deleteFile

deleteLocalFile

  • Delete a local file - which is a file owned by a publication

    Parameters

    • publicationKey: string

      is the key of the publication or an empty string (=current publication)

    • fileIdentifier: string

      is the name of the file in the local database

    • successCallbackFn: IDeleteLocalFileSuccessFn
    • failureCallbackFn: IDeleteLocalFileFailureFn
    • callbackIdentifier: string

    Returns void

executeLocalFileTransactions

generateImageFromScreenCapture

generatePdfFromImage

getAuthToken

getCredentials

getCrmConfiguration

getCurrentMeeting

getCurrentPreparation

getCurrentSession

getEnterpriseDetails

getEntities

getEntitiesFromQuery

getEntitiesFromSearch

getEntityRelatedDocuments

getFile

getFileContents

getLocalFile

  • Get a local file - which is a file owned by a publication

    Parameters

    • publicationKey: string

      is the key of the publication or an empty string (=current publication)

    • fileIdentifier: string

      is the name of the file in the local database

    • successCallbackFn: IGetLocalFileSuccessFn
    • failureCallbackFn: IGetLocalFileFailureFn
    • callbackIdentifier: string

    Returns void

getLocalFileTransactions

getLocalPdfDocuments

getMetaDataForEntity

getNonSyncedEntities

getPictureByUrl

getPreparation

  • Get specific meeting preparation. This is only available for customers who have enabled CRM integration.

    Parameters

    Returns void

getPublicationCover

getPublicationDetails

getQueriesForEntity

getRelatedEntities

getState

  • getState will retrieve the recorded publication state

    Parameters

    • publicationReference: string

      is an identifier for the publication, usually the publication name

    • storyKey: string

      is the namespace in which the data is stored

    • magjetName: string

      is the key which will enable you to look up the data

    • successCallbackFn: IGetStateSuccessFn
    • failureCallbackFn: IGetStateFailureFn

    Returns void

getUserProfile

getVisitAnalyticsReports

mailLocalPdfDocuments

openBrowser

openKiosk

openPublication

pickAdditionalFilesForVisitReport

recordAnalyticEventV2

recordState

  • recordState will save the desired publication state

    Parameters

    • publicationReference: string

      is an identifier for the publication, usually the publication name

    • storyKey: string

      is the namespace in which you want to store your data

    • magjetName: string

      is the key which will enable you to look up the data

    • state: string

      should be a json stringified object

    • successCallbackFn: IRecordStateSuccessFn
    • failureCallbackFn: IRecordStateFailureFn

    Returns void

recordStats

registerNetworkStatusChangeListener

registerQueueSizeChangeListener

sendEmail

setCrmOfflineEntity

setIsCrmOnlineSearch

  • Decide if the CRM will fetch online data or just local, offline data. This is only available for customers who have enabled CRM integration.

    Parameters

    Returns void

showPdfDocument

  • Show a local pdf document in a pdf viewer

    Parameters

    • pdfName: string
    • pageNumber: number
    • successCallbackFn: IShowPdfDocumentSuccessFn
    • failureCallbackFn: IShowPdfDocumentFailureFn
    • Optional canBeShared: boolean

      indicates if file can be added to account hub, default value will depend on publication from which the document is opened

    • Optional canBeAnnotated: boolean

      indicates if annotations option needs to be available, default value is true

    Returns void

showRemotePdfDocument

startMeeting

startPreparation

stopMeeting

stopPreparation

storeFile

storeLocalFile

  • Store a local file

    Parameters

    • publicationKey: string

      is the key of the publication or an empty string (=current publication)

    • fileIdentifier: string

      is the name of the file in the local database

    • fileType: LocalFileType

      is the type of file

    • fileContent: string

      is the content of the file

    • daysUntilExpiration: number

      determines when the local file should be removed - pass in 0 if it shouldn't be removed

    • successCallbackFn: IStoreLocalFileSuccessFn
    • failureCallbackFn: IStoreLocalFileFailureFn
    • callbackIdentifier: string

    Returns void

storePdfAsLocalFile

syncLocalFiles

  • Creates a transaction containing multiple files

    Parameters

    • ids: string[]

      is an array of strings (the fileIdentifiers passed into storeLocalFile)

    • notificationUrl: string

      is the url that will be called after all data is ready

    • deleteAfterSync: boolean

      indicates if files have to be removed after syncing

    • successCallbackFn: ISyncLocalFilesSuccessFn
    • failureCallbackFn: ISyncLocalFilesFailureFn
    • callbackIdentifier: string

    Returns void

Generated using TypeDoc