Object API Changes in SDK Version 2.1 ESD #3

These are the changes in the Object API for SDK 2.1 ESD #3.

iOS Transition to Replication-Based Synchronization

iOS applications built with earlier versions of the SDK use messaging-based synchronization (MBS) for data delivery. Applications built using SDK version 2.1 ESD #3 use replication-based synchronization (RBS) for data delivery, to reduce synchronization time to iOS applications. Consequently, messaging-based synchronization has been removed from the 2.1 ESD #3 SDK. To use your existing messaging-based applications, you can continue to use an earlier version of the Sybase Mobile SDK. Installing Sybase Mobile SDK 2.1.3 does not overwrite an earlier version on the same workstation.

API changes related to the application transition include:

Documented in:

Datavault

New Datavault Methods
Methods Platform
New methods in the Datavault class:
  • The setPasswordPolicy and getPasswordPolicy methods allow you to configure or retrieve password policy settings for a data vault. When you call the createVault or changePassword APIs, the data vault checks the password for compliance to the password policy.
  • The isDefaultPasswordUsed method checks whether the default password is used by the data vault.
  • The changePassword (string, string, string, string) is an overloaded method that validates that a new password is compatible with the password policy, uses the current password to unlock the vault, and changes the password of the vault to a new password.
  • The getDataNames method provides support for iterating through data. The method returns an array of dataName objects.
  • The deleteValue method provides an intuitive way to delete data from the data vault. Previously, you had to set a value to null to delete it.
Android, BlackBerry, iOS, Windows, and Windows Mobile
Changed Datavault Methods
Method, Class, or Property Platform
Changed methods in the Datavault class:
  • The createVault and unlock methods now automatically compute a salt value when you pass a salt parameter with a null value, or with an empty string.
  • The createVault and changePassword methods now provide an option to automatically generate a vault password, by passing a null or empty string for the password or newPassword parameters. A default password is computed only if the defaultPasswordAllowedSetting in the password policy is set to true (the default is false).
Android, BlackBerry, iOS, Windows, and Windows Mobile
Removed Datavault Methods
Methods Platform
Methods removed from the Datavault class:
  • The setLockTimeout and getLockTimeout methods for setting and retrieving the length of time a vault remains unlocked have been removed. The control of this setting is now specified by the password policy.
  • The setRetryLimit and getRetryLimit methods for setting and retrieving the retry limit of the vault have been removed. The control of this setting is now specified by the password policy.
Android, BlackBerry, iOS, Windows, and Windows Mobile
Documented in:
  • Developer Guide: Android Object API Applications:
    • Datavault
    • SUPDatavault
  • Developer Guide: BlackBerry Object API Applications, and Developer Guide: Windows and Windows Mobile Object API Applications: Datavault
  • Security:
    • Encrypting Device Data
    • Securing Sensitive Data On-Device with Data Vault

Authentication

The following authentication methods are deprecated. Instead of using these methods, Sybase recommends that you store the user name and password in a data vault.

Deprecated Authentication Methods
Methods Platform
Deprecated methods from the generated package database class:
  • onlineLogin (string userName, string password)
  • offlineLogin
  • loginToSync
Android, BlackBerry, Windows Mobile, and Win32
Documented in:
  • Developer Guide: Android Object API Applications, Developer Guide: BlackBerry Object API Applications, and Developer Guide: Windows and Windows Mobile Object API Applications, search for:
    • Connecting to Unwired Server with a Certificate
    • Single Sign-On With X.509 Certificate Related Object API
    • Logging In
    • Check Network Connection Before Login
    • Synchronization APIs
    • subscribe
  • Troubleshooting, search for: iOS Device Cannot Sync