REST.BaaS ToDo Sample

From RAD Studio Code Examples
Jump to: navigation, search

This sample project demonstrates the use of Kinvey as a BaaS (Backend as a Service) provider to post and get data from your data collection.

Location

You can find the BaaS_ToDo sample project at:

  • Start | Programs | Embarcadero RAD Studio Athens | Samples and navigate to:
    • Object Pascal\Multi-Device Samples\Cloud\BaaS
    • CPP\Multi-Device Samples\Cloud\BaaS
  • Subversion Repository:
    • You can find Delphi and C++ code samples in GitHub Repositories. Search by name into the samples repositories according to your RAD Studio version.

Description

The BaaS_ToDo sample uses Kinvey as a BaaS provider to post and get data from a data collection. This demo requires that you sing up for an account with Kinvey.

This sample demonstrates the use of the TKinveyProvider and TBackendStorage components.

Sing up with Kinvey

To use the sample, you need to create an app backend at Kinvey:

  1. Go to Kinvey website and create an account if you do not have one.
  2. Once you are logged in at Kinvey, go to your console and click the button to create a New App.
    • Enter the name of the project.
    • Select REST API as platform and click Create App.
  3. When the app is created, click on Development.
  4. In this screen, you can find the App ID, App Secret, and Master Secret that are required for the TKinveyProvider component.

How to Use the Sample

  1. Navigate to one of the locations given above and open:
    • Delphi: BaaS_ToDo.dproj.
    • C++: BaaS_ToDoCpp.cbproj.
  2. In the Projects Window, expand the DataModuleUnit1 node and double-click DataModuleUnit1.dfm (Delphi) or DataModuleUnit1.fmx (C++) to open the Data Module where the nonvisual components are located.
  3. Select the KinveyProvider1 component and in the Object Inspector set the AppKey, AppSecret, and MasterSecret to the values provided by Kinvey as commented in step 4 of the previous section (the Kinvey App ID corresponds with the App Key property).
  4. Select the wanted target Platform from the Project Manager.
  5. Only for C++: Go to Project > Options > C++ Linker and set Link with SSL and Crypto to True under iOS Device - 32 bit platform or iOS Device - 64 bit platform.
  6. Press F9 or choose Run > Run.
    Note: The device where you run the application must have access to the Internet.
  7. You can click the plus button to add an item, write the title and description of the item and click Save to save your item. This sends the information to Kinvey.
  8. To view the information in the Kinvey Console, you can refresh the Kinvey page and see how “Data” has new sub-section named ToDos.
  9. You can update the information in the BaaS ToDo Sample App. Click Refresh in the ToDos collection at Kinvey, to see how the information you change in the BaaS ToDo Sample App gets updated.
    Note: If you run the application and the data collection is not empty, you may have to click the RefreshList TButton to update the information and populate the ListView with the existing items.

Using a Different BaaS Provider

This sample uses Kinvey as BaaS (Backend as a Service) Provider. You can also use Parse as a BaaS provider. To use Parse, you must delete the TKinveyProvider component, add a TParseProvider component and select the Parse Provider in the Provider property of the TBackendStorage component.

As done with the Kinvey provider, if you use Parse as a BaaS provider you must register in the Parse page and add the Parse details to the TParseProvider component.

Files

File in Delphi File in C++ Contains

BaaS_ToDo.dproj

BaaS_ToDoCpp.cbproj

The project itself.

BaaS_ToDoForm.fmx

BaaS_ToDoForm.fmx

The main form where the components are located.

DataModuleUnit1.dfm

DataModuleUnit1.fmx

Data Module that contains the nonvisual components: TKinveyProvider and TBackendStorage.

ToDoItemTypes.pas

ToDoItemTypes.h, ToDoItemTypesData.cpp

Used to define and implement TToDo class and the TToDoNames explained in the Classes section.

BaaS_ToDo_Readme.txt

BaaS_ToDo_Readme.txt

Information about this sample.

Classes

One new class and one new record are developed in ToDoItemTypes:

  • The TToDo class represents the information that is stored in the ToDos Kinvey collection. This class has the Title and Content properties that corresponds with the title and content collection elements.
  • The TToDoNames record holds information such as TitleProperty, ContentProperty, BackendClassname, TitleElement, and ContentElement.

Implementation

The Sample Project

The sample is divided in 3 parts:

  • BaaS_ToDoForm: Implements the graphical interface. Calls to the DataModuleFormUnit1 are done from here in order to connect and manage data from the backend.
  • DataModuleFormUnit1: Implements the backed connection.
  • ToDoItemTypes: Defines and implements the TToDo class and the TToDoNames record.

BaaS Components

  • This sample uses the TBackendStorage component to post and get data from your data collection.
  • The TKinveyProvider is used to set up the Kinvey connection to use Kinvey as a BaaS provider. The TBackendStorage and the TKinveyProvider components are connected as Kinvey is set in the Provider property of the TBackendStorage component.

Other Components

  • TTabControl component holds the TTabItems used to create the four different views of the application: List, Details, Add, and Edit.
  • TListView component is used to present the data collection as a list of items in the Details view. TEdits and TMemos display the data in the rest of the views.
  • TActionList holds the list of actions used by the components in response to user actions.
  • TPrototypeBindSource has the two fields Title and Content, available in an item of the data collection.
  • TBindingsList is used to create managed binding among the different components.

Uses

See Also

Retrieved from "https://docwiki.embarcadero.com/CodeExamples/Athens/e/index.php?title=REST.BaaS_ToDo_Sample&oldid=31645"