SDK Single Mode

With the SDK Single Mode you can transform a contentApp directly into a single native app. You can integrate a version of your contentApp directly into your source project, so that a download of the contentApp is not necessary after the first app start. If you create a new version of your contentApp with the contentDock Management System, it is automatically updated in the App as soon as it is active. In this next section, the special features of the SDK Single Mode are explained.


Activation a Single Mode project

  1. Activate an SDK key in your contentDock project settings. Make sure that the SDK key is not given to unauthorized third parties.
  2. Create or use the file "CDockSettings.plist" and set the SDK key there.


CDockSettings.plist Single Mode

Create the following CDockSettings.plist file if you want to use Single Mode
<plist version="1.0">
    <dict>
        <key>SDKMode</key>
        <string>single</string>
        <key>Key</key>
        <string>Your Projekt SDK Key</string>
        <key>Account</key>
        <string>Your contentDock webaddress</string>
        <key>projectId</key>
        <string>The contentApp ID</string>
        <key>isLocalSync</key>
        <false/>
        <key>localSyncVersion</key>
	<string>The version number of your contentdock.caap file</string>
	<key>localSyncUpdate</key>
	<true/>
        <key>useLocationService</key>
        <false/>
        <key>buttonSitemap</key>
        <string>topRight</string>
        <key>buttonImprint</key>
        <string>topRight</string>
        <key>buttonComment</key>
        <string>bottomLeft</string>
        <key>buttonAudio</key>
        <string>topLeft</string>
    </dict>
</plist>

Parameters

  • SDKMode: for the single mode the value `single` must be set here.
  • Key: set the SDK key that you have activated in your project.
  • Account: set your contentDock web address here. Please do NOT set '.contentdock.com'.
  • projectId: set the contentDock contentApp ID here. You can find it in the contentApp Settings in the SDK area in the contentDock Management System.
  • isLocalSync: true=After the first start of the app your contentApp will be installed with the contentApp saved in your source code (see [Local installation of your contentApp](#local-installation-of-your-contentapp) in this documentation). false=After the first start of the app, your contentApp is synchronized directly with the contentDock system. This ensures that the latest version of the contentApp is always installed.
  • localSyncVersion: if isLocalSync = true, the version number of the contentdock.caap file must be entered here (e.g.: 1.42). See also Local installation of your contentApp.
  • localSyncUpdate: if isLocalSync = true and this value is alsotrue, then the contentApp will be updated to the new version, which will be published in the contentDock management system. If the value is false, then a new published version will not be installed.
  • useLocationService: true= the GEO position of the user is determined when starting the contentApp. The user have to agree to this actively. The GEO position is saved anonymously for your contentDock app and is displayed in the statistics area of your contentDock Account. Attention: If your contentDock app should to be placed in the Apple App Store, please comply your App with the Apple App Store location service guidelines. If you use the app in your Apple Enterprise Account as an in-house app, you can use the Location Service without hesitation.
    If the value is false, then the GEO position is not determined.
  • buttonSitemap: contentDock automatically generates the sitemap of your contentApp and displays it via tap on the "Sitemap" button. You can set this button to the positions: topLeft / topRight / bottomLeft / bottomRight for your users. Default is topLeft. You can hide the button with notShow.
  • buttonImprint: contentDock automatically generates a imprint layer of your contentApp and displays it via tap on the "Imprint" button. You can set this button to the positions: topLeft / topRight / bottomLeft / bottomRight for your users. Default is topLeft. You can hide the button with notShow.
  • buttonComment: contentDock provides a notice board for your users, with which they can write or draw comments per page. This notice board is opened by tap on the button "Notice board". You can set this button to the positions: topLeft / topRight / bottomLeft / bottomRight for your users. Default is topLeft. You can hide the button with notShow.
  • buttonAudio: One audio file can be stored per page, which starts automatically as soon as the page is opened. With the Audio Buttons the user can control the audio. You can set these buttons to the following positions for your users: topLeft / topRight / bottomLeft / bottomRight. Default is topLeft. These buttons can be hidden with notShow.

Local installation of your contentApp

If you have set the parameter isLocalSync in the CDockSettings.plist to true, you have to integrate the contentApp into your source project. Please follow the next steps:

  1. Open your project in the contentDock Management System.
  2. Click on the "Publish" button and activate the checkbox "Create contentApp for your SDK Source Project". Now start the publishing process.
  3. When the publishing process is finished, you can load the contentApp with the link "Save contentApp for SDK Source Project locally".
  4. Copy the loaded file into your source project.

More information


Feedback or Questions

We are always happy to help you with questions about the code or other questions.

Was this page helpful? Yes No

Topics on this page