. . .

Deprecations and Migration

We're listing any method, function or configuration option (as column "Method") on this page, its replacement, version of deprecation (column "Version) and the corresponding "date of removal", which is generally two years after deprecation for changes that will affect the code for a running system, and one year for changes that will affect SDK code (your app with an old code should stay working over the two years, but if you update the SDK, methods may have been removed after one year ). If we deprecate a method/function/configuration in one version, it will stay deprecated in the following versions for one year and will be removed in the next major version that is released after that "date of removal". This will give you the possibility to have enough time to change your code and gives you an overview about what has changed over time.

We'll leave this page independent from any version, which means that you'll find the same information in the documentation of, for example, an ApiOmat hotfix version 2.2.6 as in version 2.4.4 - provided that they're both released at same time. This gives you the possibility to see what will be deprecated in future versions, even when you haven't installed the latest major version.

As we've already deprecated a lot of stuff in the early versions of ApiOmat, we're also giving you one year to remove these old deprecations.

SDK

#

SDK name

Replacement

Version

Date of Removal

Version of Removal

1

C#

C# SQLite

3.1.3, 3.2.0

11.2019

 

2

Xamarin

Xamarin SQLite

3.1.3, 3.2.0

11.2019

 

3

Titanium

-

3.1.3, 3.2.0

11.2019

 

4

Backbone

Typescript

3.2.0

11.2019

 

Android

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

User: requestNewPassword()

User: resetPassword oder resetPasswordAsync

2.2.6, 2.3.2

03.2018

3.0.0

2

User: requestNewPasswordAsync(AOMCallback)

User: resetPasswordAsync(AOMCallback)

2.2.6, 2.3.2

03.2018

3.0.0

3

User: resetPassword(String)

User: changePassword(String)

2.2.6, 2.3.2

03.2018

3.0.0

4

User: resetPasswordAsync(String, AOMEmptyCallback)

User: changePasswordAsync(String, AOMEmptyCallback)

2.2.6, 2.3.2

03.2018

3.0.0

5

User: requestSessionToken()

User: requestTokenContainer()

< 1.13

03.2018

3.0.0

6

User: requestSessionToken(boolean)

User: requestTokenContainer(boolean)

< 1.13

03.2018

3.0.0

7

User: requestSessionTokenAsync(AOMCallback)

User: requestTokenContainerAsync(AOMCallback)

< 1.13

03.2018

3.0.0

8

User: requestSessionTokenAsync(boolean, AOMCallback)

User: requestTokenContainerAsync(boolean, AOMCallback)

< 1.13

03.2018

3.0.0

9

User: requestSessionToken(String, boolean)

User: requestTokenContainer(String, boolean)

< 1.13

03.2018

3.0.0

10

User: requestSessionTokenAsync(String, boolean, AOMCallback)

User: requestTokenContainerAsync(String, boolean, AOMCallback)

< 1.13

03.2018

3.0.0

11

FBUser: getOrCreateUser(String)

FBUser: loginFacebookUser(String)

< 1.13

03.2018

3.0.0

12

FBUser: getOrCreateUser(String, boolean)

FBUser: loginFacebookUser(String)

< 1.13

03.2018

3.0.0

13

FBUser: getOrCreateUserAsync(String, AOMCallback)

FBUser: loginFacebookUserAsync(String, AOMCallback)

< 1.13

03.2018

3.0.0

14

FBUser: getOrCreateUserAsync(String, AOMCallback, boolean)

FBUser: loginFacebookUserAsync(String, AOMCallback)

< 1.13

03.2018

3.0.0

15

load{capAttrName}Async(String, AOMEmptyCallback)

load{capAttrName}Async(String, AOMCallback)

< 1.13

03.2018

3.0.0

16

post{capAttrName}Async({refClassName}, AOMEmptyCallback)

post{capAttrName}Async($refClassName, AOMCallback)

< 1.13

03.2018

3.0.0

17

AOMCallback isDone(T, ApiomatRequestException)

isDone(T, boolean, ApiomatRequestException)

2.0.0

03.2018

3.0.0

18

AOMCallback isDone(T, boolean, ApiomatRequestException)

will be marked as abstract, implementation removed

2.0.0

03.2018

3.0.0

19

AOMEmptyCallback isDone(Void, ApiomatRequestException)

isDone( boolean, ApiomatRequestException)

2.0.0

03.2018

3.0.0

20

AOMEmptyCallback isDone(ApiomatRequestException exception)

isDone( boolean, ApiomatRequestException)

2.0.0

03.2018

3.0.0

21

ApiomatRequestException(int int, String, String)

ApiomatRequestException(int, int, String)

1.13

03.2018

3.0.0

22

ApiomatRequestException(Status)

ApiomatRequestException(Status, int)

1.13

03.2018

3.0.0

23

ApiomatRequestException getReason()

getMessage()

1.13

03.2018

3.0.0

24

Datastore configure(String, String, String, String)

configureWithCredentials(User)

1.15

03.2018

3.0.0

25

Datastore configure(User)

configureWithCredentials(User)

1.13

03.2018

3.0.0

26

Datastore configure(String, String, String, String, String, String)

configureWithCredentials(User)

1.13

03.2018

3.0.0

27

Datastore configure(String, String, String)

configureAsGuest(String, String, String)

1.13

03.2018

3.0.0

28

Datastore setOfflineStrategy (AOMOfflineStrategy, Context, AOMOfflineListener)

setCachingStrategy(AOMCacheStrategy, Context)

1.16

03.2018

3.0.0

29

Datastore AOMOfflineStrategy

AOMCacheStrategy

1.16

03.2018

3.0.0

30

Datastore requestSessionToken()

requestTokenContainer()

1.15

03.2018

3.0.0

31

Datastore requestSessionTokenAsync(AOMCallback)

related methods in User class

1.15

03.2018

3.0.0

32

Datastore requestSessionToken(String)

requestTokenContainer(String)

1.15

03.2018

3.0.0

33

Datastore requestSessionTokenAsync(String, AOMCallback)

related methods in User class

1.15

03.2018

3.0.0

34

Datastore getOrCreateUser(String, boolean)

loginFacebookUser(String)

1.15

03.2018

3.0.0

35

Datastore getOrCreateUser(String)

loginFacebookUser(String)

1.15

03.2018

3.0.0

Java

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

User requestNewPassword()

User resetPassword() oder resetPasswordAsync(AOMCallback)

2.2.6, 2.3.2

03.2018

3.0.0

2

User requestNewPasswordAsync(AOMCallback)

User resetPasswordAsync(AOMCallback)

2.2.6, 2.3.2

03.2018

3.0.0

3

User resetPassword(String)

User changePassword(String)

2.2.6, 2.3.2

03.2018

3.0.0

4

User resetPasswordAsync(String, AOMEmptyCallback)

User changePasswordAsync(String, AOMEmptyCallback)

2.2.6, 2.3.2

03.2018

3.0.0

5

User requestSessionToken()

User requestTokenContainer()

1.15

03.2018

3.0.0

6

User requestSessionToken(boolean)

User requestTokenContainer(boolean)

1.15

03.2018

3.0.0

7

User requestSessionTokenAsync(AOMCallback)

User requestTokenContainerAsync(AOMCallback)

1.15

03.2018

3.0.0

8

User requestSessionTokenAsync(boolean, AOMCallback)

User requestTokenContainerAsync(boolean, AOMCallback)

1.15

03.2018

3.0.0

9

User requestSessionToken(String, boolean)

User requestTokenContainer(String, boolean)

1.15

03.2018

3.0.0

10

User requestSessionTokenAsync(String, boolean, AOMCallback)

User requestTokenContainerAsync(String, boolean, AOMCallback)

1.15

03.2018

3.0.0

11

FBUser getOrCreateUser(String)

FBUser loginFacebookUser(String)

1.15

03.2018

3.0.0

12

FBUser getOrCreateUserAsync(String, AOMCallback)

FBUser loginFacebookUserAsync(String, AOMCallback)

1.15

03.2018

3.0.0

13

load{capAttrName}Async(String, AOMEmptyCallback)

load{capAttrName}Async(String, AOMCallback)

1.12

03.2018

3.0.0

14

post{capAttrName}Async({refClassName}, AOMEmptyCallback)

post{capAttrName}Async($refClassName, AOMCallback)

1.12

03.2018

3.0.0

15

ApiomatRequestException(int int, String, String)

ApiomatRequestException(int, int, String)

1.13

03.2018

3.0.0

16

ApiomatRequestException(Status)

ApiomatRequestException(Status, int)

1.13

03.2018

3.0.0

17

ApiomatRequestException getReason()

getMessage()

1.13

03.2018

3.0.0

18

Datastore configure(String, String, String, String, String, String, int)

configureWithCredentials(String, String, String, String, String, String, int)

1.13

03.2018

3.0.0

19

Datastore configure(String, String, String, String, int)

configureAsGuest(String, String, String, String, int)

1.13

03.2018

3.0.0

20

Datastore configure(String, String, String, String, String, String)

configureWithCredentials(String, String, String, String, String)

1.13

03.2018

3.0.0

21

Datastore configure(String, String, String, String)

configureAsGuest(String, String, String, String)

1.13

03.2018

3.0.0

22

Datastore configure(String, String, String, String, String)

configureWithCredentials(String, String, String, String, String, String)

1.13

03.2018

3.0.0

23

Datastore requestSessionToken()

requestTokenContainer()

1.15

03.2018

3.0.0

24

Datastore requestSessionTokenAsync(AOMCallback)

related methods in User class

1.15

03.2018

3.0.0

25

Datastore requestSessionToken(String)

requestTokenContainer(String)

1.15

03.2018

3.0.0

26

Datastore requestSessionTokenAsync(String, AOMCallback)

related methods in User class

1.15

03.2018

3.0.0

JavaScript

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

User requestNewPassword(boolean, callback)

User resetPasswordAsync(callback, boolean)

2.2.6, 2.3.2

03.2018

3.0.0

2

User resetPassword(string, callback, boolean)

User changePassword(string, callback)

2.2.6, 2.3.2

03.2018

3.0.0

3

FBUser getOrCreateUser(string, callback, boolean)

FBUser loginFacebookUser(String, callback, boolean)

2.4.0

03.2018

3.0.0

4

Datastore configure(User)

configureWithCredentials(User)

1.13

03.2018

3.0.0

5

Datastore configurePlain(String, String, String, String)

configureAsGuest(String, String, String, String, String)

1.13

03.2018

3.0.0

C#

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

<ClassName>.DeleteAllFromStorage(string query = null)

<ClassName>.RemoveFromStorage(string query = null)

2.4.7, 2.5.1, 3.0.0

05.2019

 

Objective C

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

ProgrammingLanguage, deprecated Objective C Headers

new headers

1.15

03.2018

3.0.0

2

AOMDatastore configureAsGuestWithUrl(NSString, NSString, id<AOMModelStoreProtocol>)

configureWithUser

1.3

03.2019

 

3

AOMDatastore configureWithSessionToken(NSString, NSString, NSString, NSString, BOOL)

configureWithUser:andLoadWithLinks

1.3

03.2018

3.0.0

4

AOMDatastore postStaticDataOnServer: asImage:UsePersistentStorage:

postStaticDataOnServer: asImage: withName: UsePersistentStorage:

2.6.6

05.2019

 

5

AOMDatastore

postStaticDataOnServer: onModel: refName: asImage: UsePersistentStorage:

postStaticDataOnServer: onModel: refName: asImage: withName: UsePersistentStorage:

2.6.6

05.2019

 

6

AOMDatastore postStreamOnServer: asImage: UsePersistentStorage:

postStreamOnServer: asImage: withName: UsePersistentStorage:

2.6.6

05.2019

 

7

AOMDatastore

postStreamOnServer: onModel: refName asImage: UsePersistentStorage:

postStreamOnServer: onModel: refName: asImage: withName: UsePersistentStorage:

2.6.6

05.2019

 

8

AOMDatastore

postStaticDataOnServerAsync: asImage: UsePersistentStorage: andFinishingBlock:

postStaticDataOnServerAsync asImage: UsePersistentStorage: andFinishingBlock:

2.6.6

05.2019

 

9

AOMDatastore

postStaticDataOnServerAsync: onModel: refName: asImage: UsePersistentStorage: andFinishingBlock:

postStaticDataOnServerAsync: onModel: refName: asImage: withName: UsePersistentStorage: andFinishingBlock:

2.6.6

05.2019

 

10

AOMDatastore

postStreamOnServerAsync: asImage: UsePersistentStorage: andFinishingBlock:

postStreamOnServerAsync: asImage: withName: UsePersistentStorage: andFinishingBlock:

2.6.6

05.2019

 

11

AOMDatastore

postStreamOnServerAsync: onModel: refName: asImage: UsePersistentStorage: andFinishingBlock:

postStreamOnServerAsync: onModel: refName: asImage: withName: UsePersistentStorage: andFinishingBlock:

2.6.6

05.2019

 

Swift

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

DataStoreConfiguration useDeltaSync Property

deltaSyncStrategy property

2.4.0

03.2018

3.0.0

2

DataStore

postStaticData(rawData data:

DataStore

postStaticData(rawData data: , name:

2.6.6

05.2019

 

3

DataStore

postStaticDataStream(dataStream stream:

DataStore

postStaticDataStream(dataStream stream:, name:

2.6.6

05.2019

 

PHP

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

Datastore configureWithMember(User)

configureWithUser(User)

1.3

03.2018

3.0.0

Python

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

Datastore configureWithMember(self,User)

configureWithUser(User)

1.3

03.2018

3.0.0

Backbone

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

load${capAttrName}(options)

load${capAttrName}AsByteArray(options)

2.5.6

10.2019

 

2

post${capAttrName}(data, options)

post${capAttrName}AsByteArray(data, options)

2.5.6

10.2019

 

Non-SDK related

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

Module getManagedByCustomerHref()

-

1.15

03.2018

3.0.0

2

Module getManagedByClientName(), json-field “managedByClientName”

getAdminName(), json-field “adminName”

1.15

03.2018

3.0.0

Modules

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

Basics Module: MemberModel

User

 

03.2019

 

2

WordPress Module: Category (Class)

Taxonomy (Class)

 

03.2019

 

3

WordPress Module: MetiaItemDTO/MediaItem getType() / setType(String)

getMediaType() / setMediaType()

2.3.0

03.2019

 

4

WordPress Module: Page (Class)

Post (with post_type=”page”)

 

03.2019

 

5

WordPress Module: PostDTO (Post) getType() / setType(String)

getPostType() /setPostType(String)

2.3.0

03.2019

 

6

FacebookModule: authCode

authToken?

 

03.2019

 

7

Chat Module

GroupChat Module

2.6.0

11.2019

 

NativeModule

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

StaticWrapper: findByForeignId(String, String)

findByForeignId(String, String, Request)

 

03.2019

 

2

StaticWrapper: findByForeignId(String, String, String)

findByForeignId(String, String, String, Request)

 

03.2019

 

3

StaticWrapper: createObject(String, String)

createObject(String, String, Request)

2.4.0

03.2019

 

4

StaticWrapper: findById(String, String)

findById(String, String, Request)

 

03.2019

 

5

StaticWrapper: findById(String, String, String)

findById(String, String, String, Request)

 

03.2019

 

6

StaticWrapper: findByNames(String, String)

findByNames(String, String, Request)

 

03.2019

 

7

StaticWrapper: findByNames(String, String, String)

findByNames(String, String, String, Request)

 

03.2019

 

8

StaticMethods: createObject(String, String, String)

createObject(String, String, String, Request)

 

03.2019

 

9

IModelHooks

IModelHooksCommon/IModelHooksTransient/IModelHooksNonTransient

2.2.0

03.2019

 

10

IModelHooksNonTransient beforeGet(Object, Request)

afterGet(Object, Request)

2.5.0

03.2019

 

11

IModelMethods: createObject(String)

createObject(String, Request)

 

03.2019

 

12

IModelMethods: createObject(String, String)

createObject(String, String, Request)

2.1.0

03.2019

 

13

IStaticMethods: createObject(String, String, String)

createObject(String, String, String, Request)

2.4.0

03.2019

 

14

IStaticMethods: log(String, String)

log(String, String, boolean)

2.5.0

03.2019

 

15

IStaticMethods: logError(String, String)

logError(String, String, boolean)

2.5.0

03.2019

 

16

IStaticMethods: logError(String, Throwable)

logError(String, Throwable, boolean)

2.5.0

03.2019

 

17

IStaticMethods: logModel(String, String, IModel<?>)

logModel(String, String, IModel<?>, boolean)

2.5.0

03.2019

 

18

IStaticMethods: logModel(String, String, IModel<?>[])

logModel(String, String, IModel<?>[], boolean)

2.5.0

03.2019

 

19

IStaticMethods: logModel(String, String, Object)

logModel(String, String, Object, boolean)

2.5.0

03.2019

 

20

Request(String, String, String,String, String, String)

Request(String, String,String, String, String,String, String)

1.16

03.2019

 

21

Request(String, String, String,String, String)

Request(String, String,String, String, String,String, String)

1.16

03.2019

 

22

Request(String, String, String, String)

Request(String, String,String, String, String,String, String )

1.15

03.2019

 

23

AbstractClientDataModel findByNames(String, Request)

findByNames(String, String, Request)

2.1.0

03.2019

 

24

AbstractClientDataModel.saveResource( byte[ ], boolean, String, String )

AbstractClientDataModel.saveResource( InputStream, boolean, String, String )

2.5.0

03.2019

 

25

Request.isUseDeltaSyncDeletedInResponse( )

Request.isUseDeltaSyncInResponse( )

2.5.5

09.2019

 

26

Request.setUseDeltaSyncDeletedInResponse( boolean )

Request.setUseDeltaSyncInResponse( boolean )

2.5.5

09.2019

 

27

IModelHooksCommon.auth(String, String, String, String, String, Request)

IModelHooksTransient/IModelHooksNonTransient.auth(String, String, String, String, String, String, Request

2.6.0

10.2019

 

28

IModelMethods: loadResource( String href )

IModelMethods: getData(com.apiomat.nativemodule.IResourceMethods.ResourceType, String)

2.5.7

11.2019

 

29

AbstractClientDataModel: loadResource( String href )

AbstractClientDataModel: getData(com.apiomat.nativemodule.IResourceMethods.ResourceType, String)

2.5.7

11.2019

 

30

obj.load<attrName>( String apiKey, String system )

obj.load<attrName>( )

2.5.7

11.2019

 

31

obj.post<attrName>( byte[] data , String fileName, String format )

obj.post<attrName>( java.io.InputStream data , String fileName, String format )

2.5.7

11.2019

 

32

IStaticMethods: log( String applicationName, String message, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, boolean logAsync)

3.1

07.2020

 

33

IStaticMethods: logError( String applicationName, String message, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, boolean logAsync)

3.1

07.2020

 

34

IStaticMethods: logError( String applicationName, Throwable e, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Throwable e, boolean logAsync)

3.1

07.2020

 

35

IStaticMethods: logModel( String applicationName, String message, com.apiomat.nativemodule.IModel<?>[ ] messageArray,
boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

36

IStaticMethods: logModel( String applicationName, String message, com.apiomat.nativemodule.IModel<?> messageModel,
boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

37

IStaticMethods: logModel( String applicationName, String message, Object messageModel, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

38

IModelMethods: log( String message, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, boolean logAsync)

3.1

07.2020

 

39

IModelMethods: logError( String message, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, boolean logAsync)

3.1

07.2020

 

40

IModelMethods: logError( Throwable e, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Throwable e, boolean logAsync)

3.1

07.2020

 

41

IModelMethods: logModel( String message, com.apiomat.nativemodule.IModel<?>[ ] messageArray, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

42

IModelMethods: logModel( String message, com.apiomat.nativemodule.IModel<?> messageModel, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

43

IModelMethods: logModel( String message, Object messageModel, boolean logAsync )

log(com.apiomat.nativemodule.Level logLevel, String message, Object messageModel, boolean logAsync)

3.1

07.2020

 

44

IModule: onCronHourly()

@Cron( cronExpression = "0 0 * * * ?", executeOnAllNodes = false )
public void onCronHourly( final com.apiomat.nativemodule.Request request )
{ /* custom module method that gets called every hour */ }

3.1.1

07.2020

 

45

IModule: onCronDaily()

@Cron( cronExpression = "0 0 3 ? * *", executeOnAllNodes = false )
public void onCronDaily( final com.apiomat.nativemodule.Request request )
{ /* custom module method that gets called every day on 03:00 AM */ }

3.1.1

07.2020

 

46

IModule: onCronWeekly()

@Cron( cronExpression = "0 0 3 ? * ", executeOnAllNodes = false )
public void onCronWeekly( final com.apiomat.nativemodule.Request request )
{ /* custom module method that gets called every Monday on 03:00 AM */ }

3.1.1

07.2020

 

47

IModule: onCronMonthly()

@Cron( cronExpression = "0 0 3 1 * ?", executeOnAllNodes = false )
public void onCronMonthly( final com.apiomat.nativemodule.Request request )
{ /* method that gets called every first day of each month on 03:00 */ }

3.1.1

07.2020

 

RESTful API

#

Endpoint

Replacement

Version

Date of Removal

Version of Removal

1

/customers/customersForApp/{appName}

/customers/accountsForApp/{appName}

3.0.0

12.2019

 

2

/customers/customersForModule/{moduleName}

/customers/accountsForModule/{moduleName}

3.0.0

12.2019

 

3

/organizations/customersForApp/{appName}

/organizations/accountsForApp/{appName}

3.0.0

12.2019

 

4

/organizations/customersForModule/{moduleName}

/organizations/accountsForModule/{moduleName}

3.0.0

12.2019

 

5

POST /modules/{moduleName}/gitinit

POST /modules/{moduleName}/gitData

3.0.0

03.2019

 

Misc

#

Method

Replacement

Version

Date of Removal

Version of Removal

1

classBasedAuth property in config file

-

2.4.1, 2.5.0

03.2019

 

2

strictChecks property in config file

-

2.2.1, 2.3.0, 2.5.6

10.2019

 

3

old yambas.config file

apiomat.yaml

2.4.0

03.2019

 

4

yambas.useOldClassloader

-

2.5.2

05.2019

 

5

mongo.userName

mongo.userName.default

3.0.0

09.2019

 

6

PHP 5 for dashboard installation

PHP 7

3.0.0

09.2019