Skip to content

Commit 1334a65

Browse files
committed
[1.1.0] Add SMS version documentation
1 parent eb6b082 commit 1334a65

File tree

4 files changed

+27
-3
lines changed

4 files changed

+27
-3
lines changed

docs/content/developer/database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ At the moment, just one [server, user] pair is supported, so logging out and log
99
pair will delete the current database and create a new one.
1010

1111
## Encryption
12-
As of SDK version 1.1, it is possible to store the data in an encrypted database. The encryption key is generated randomly
12+
As of SDK version 1.1.0, it is possible to store the data in an encrypted database. The encryption key is generated randomly
1313
by the SDK and kept secure.
1414

1515
The encryption status (if the database is encrypted or not) can be configured at server level in the android-settings-app.

docs/content/developer/db-interaction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ d2.constantModule().constants().blockingGet() // List<Constant>
1414

1515
// Direct database interaction
1616
String query = "SELECT * FROM " + ConstantTableInfo.TABLE_INFO.name();
17-
try (Cursor cursor = Sdk.d2().databaseAdapter().query(query)) {
17+
try (Cursor cursor = Sdk.d2().databaseAdapter().rawQuery(query)) {
1818
List<Constant> constantList = new ArrayList<>();
1919
if (cursor.getCount() > 0) {
2020
cursor.moveToFirst();

docs/content/developer/modules-and-repositories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ System modules:
144144
- importModule
145145
- maintenanceModule
146146
- systemInfoModule
147-
- systemSettingModule
147+
- settingModule
148148
- wipeModule
149149

150150
Big block modules:

docs/content/developer/sms.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,30 @@ case.send().blockingSubscribe();
5050

5151
> *Important*: the app is responsible for asking the user for permissions (READ_PHONE_STATE, SEND_SMS, READ_SMS, RECEIVE_SMS). Otherwise, SMS module will fail.
5252
53+
## SMS version
54+
55+
SMSs are sent in a compressed format from/to the server. This task is done by the [SMS Compression library](https://github.com/dhis2/sms-compression), which is responsible for doing the conversion between the plain text and the compressed format.
56+
57+
The SDK includes the latest available version of the compression library, but there is no guarantee that the server is using it as well. For this reason, it is required to check the server version in order to enable/disable some functionalities. The SMS version in the server can be checked by:
58+
59+
```java
60+
d2.systemInfoModule().versionManager().getSmsVersion()
61+
```
62+
63+
Overview of versions - features:
64+
65+
Version 1:
66+
- Aggregated data.
67+
- Tracker / event data, but there are some known bugs. We recommend not to enable tracker SMS sync in version 1.
68+
69+
Version 2:
70+
- Add support for empty lists.
71+
- Add support for geometry in events (POINT).
72+
- Add missing properties in events (event data, due date) and enrollments (execution date, incident date).
73+
- Add support for sending enrollment + events in the same SMS submit case.
74+
75+
For more information, please check [SMS compression repository](https://github.com/dhis2/sms-compression).
76+
5377
## ConfigCase
5478

5579
<!--DHIS2-SECTION-ID:sms_module_config_case-->

0 commit comments

Comments
 (0)