SAP Cloud Platform SDK for iOS API Reference

The SAP Cloud Platform SDK for iOS includes layers of components separated into frameworks: generic infrastructure components (SAPFoundation framework), common components used by other framework components (SAPCommon), data access and manipulation components (SAPOData and SAPOfflineOData frameworks), and app-specific UI and data presentation components (SAPFiori framework).

This reference contains usage information for all SAP Cloud Platform SDK for iOS APIs. The Getting Started Guide provides additional information and guidance.

Tip: SAP recommends that you begin developing your application by using the SAP Cloud Platform SDK for iOS Assistant, which creates an initial application that is integrated with SAP Cloud Platform mobile service for development and operations. You can configure various aspects of the application: enable logging, enable remote notifications, define OData endpoints, and so on.

Tip: Use the release frameworks as follows:

  • Release_fat - use this framework for development. It allows your app to run on real devices and simulators. SAP Cloud Platform for SDK iOS Assistant uses these as well.
  • Release_iphoneos - use this framework to prepare the .ipa (iOS App Store Package) file.

Xcode blocks you from preparing a real application archive (IPA) file with Release_fat frameworks included because these contain simulator slices which are not needed on real devices.


Includes general purpose components that integrate with both device and SAP Cloud Platform mobile service for development and operations features and capabilities, such as authentication, connectivity, caching, security, and so on.


Includes commonly used service and logging components.


Enables SAP Fiori for iOS as a design language to unify iOS and SAP Fiori features to optimize the user experience in enterprise applications.


Includes existing SAPFoundation, SAPCommon, and SAPFiori capabilities into a higher level framework that allows you to develop complex onboarding processes using just a few lines of code. SAPFioriFlows supports most typical application onboarding scenarios. See On-boarding Flow Recommendations if you choose not to use SAPFioriFlows to implement the onboarding process.


Provides online access to exposed back-end OData services without any caching or local storage of data. This is best suited when the application requires up to date back-end data and has reliable connectivity.


The Offline OData framework retrieves back-end OData services when the app is online, then creates an Offline OData store which is initialized and populated with a list of defining queries. The store is persisted on the device (offline). Device users manipulate the local data (query, update, create, delete, and so on), then later upload the offline changes to the back-end. SAPOfflineOData provides additional functions required for Offline OData: creating the offline store, sending pending modification requests to SAP Cloud Platform mobile service for development and operations/back-end, refreshing the offline store as needed, removing data from and deleting the offline store and releasing resources after the last use of the offline store, and so on. An offline application is well suited when connectivity may become unreliable, or requires infrequent updates of back-end data.



Privacy Statement


Terms of Use