EN |
EN |
advanced guide to configuring the React Native SDK
In this section you will find a series of more advanced functionalities that require a more complex development. We recommend that a developer be in charge of this configuration.
The indigitall SDK can manage the user's location. This allows you to use the location filters on the send push campaign screen ( Campaigns> Push> New push campaign > Filters> Geographical filters)
Once we have enabled this functionality, the end user will have to give their consent to the location permission and enable the location services of their smartphone, so that the application can obtain the exact location of the user.
Include the requestLocation parameter to your initialization.
...
Indigitall.init({
appKey: "<YOUR_APP_KEY>",
senderId: "<YOUR_SENDER_ID>",
requestLocation: true });
...You can associate your own ID to each device. In this way it will be easier and more intuitive for you to work with our tool. For example:
To make this association between your custom ID (externalId), and the identifier handled by indigitall (deviceId), you have to invoke the logIn method:
Indigitall.logIn("YOUR_EXTERNAL_ID", (device) => {
//DO SOMETHING
},(error) => {
//LOG ERROR
});Do not you worry about anything. Your IDs are irreversibly encrypted on the phone itself and sent securely to our servers. Not even the indigitall team can know this information.
If it is required to collect the user's WiFi information, in addition to the Indigitall panel configuration, you must add the parameter wifiFilterEnabled when the SDK is initialized:
Indigitall.init({
appKey: "<YOUR_APP_KEY>",
senderId: "<YOUR_SENDER_ID>",
wifiFilterEnabled: true
});The location permission must be accepted by the user
In order to obtain the Wi-Fi information in android, the following permissions and services declared in the manifest are needed:
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION"/>
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
// ANDROID 12 WIFI
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
//WiFi service
<service
android:name="com.indigitall.android.services.WifiStatusService"
android:permission="android.permission.BIND_JOB_SERVICE" >
</service>
<receiver android:name="com.indigitall.android.receivers.WifiWakeLockReceiver">
<intent-filter>
<action android:name="AlarmReceiver.Action.NETWORK_ALARM" />
</intent-filter>
</receiver>Likewise, you must add in the project options in Xcode, in Signing & Capabilities the option Access WiFi Information :
if you are ENTERPRISE CUSTOMER you have to add this parameter in the configuration so that the SDK points to the correct environment:
Indigitall.init({
appKey: "YOUR_APPKEY",
...
urlDeviceApi: "YOUR_DEVICE_API_DOMAIN",
urlInappApi: "YOUR_INAPP_API_DOMAIN",
urlInboxApi: "YOUR_INBOX_API_DOMAIN",}Our SDK offers various callbacks that help you have greater control of the execution flow and implement custom behaviors.
Indigitall.init({
appKey: "YOUR_APPKEY",
senderId: "YOUR_SENDER_ID",
requestLocation: true
}, (device)=> {
//LOG device
}, (errorMessage)=>{
//LOG ERROR
});The device object that returns the callback will be executed when the device has been registered for the first time, that is, in the first execution of the app after being installed. and when the SDK finishes initializing and the device is ready to receive notifications from indigitall.
It receives as a parameter the Device object with the information associated with the device.
Indigitall.init({
appKey: "YOUR_APPKEY",
senderId: "YOUR_SENDER_ID",
requestLocation: true
}, (device)=> {
console.log("Device: ", Object.values(device));
});The error method will run only if an error occurs during the initialization of the SDK.
It receives the description of the error as a parameter.
Indigitall.init({
appKey: "YOUR_APPKEY",
senderId: "YOUR_SENDER_ID",
requestLocation: true
}, (device)=> {
//LOG device
}, (errorMessage)=>{
console.log("Error: ", errorMessage;
});This section describes the different actions that could be performed on an indigitall device. The device model would have this structure:
device = {
deviceId: "string",
pushToken: "string",
browserPublicKey: "string",
browserPrivateKey: "string",
platform: "string",
version: "string",
productName: "string",
productVersion: "string",
browserName: "string",
browserVersion: "string",
osName: "string",
osVersion: "string",
deviceType: "string",
enabled: "boolean",
externalCode: "string"
};It returns a DeviceCallback and if the operation is successful it returns a Device object.
Indigitall.deviceGet((device) => {
// Do something with device in success function
}, (error) => {
// Do something in error function
});You can choose to disable the device to block the receipt of notifications. It is a very useful method to:
To do this, you have the deviceEnable and deviceDisable methods.
You must instantiate a _Device Callback object and pass it as the second parameter. This callback will receive as a parameter the device object that contains all the information associated with the device.
Indigitall.deviceEnable((device) => {
// Do something with device in success function
}, (error) => {
// Do something in error function
});
Indigitall.deviceDisable((device) => {
// Do something with device in success function
}, (error) => {
// Do something in error function
});Our SDK allows you to classify users into different customizable groups. This is very useful for:
Remember that you must first define the groups you want to work with in the indigitall console ( Tools> Interest groups ). See our user manual for more info.
Use the topicsList method to get the list of groups that are configured in your indigitall project. The callback of this method receives as a parameter an array of Topics, which contains the information of all the available groups, as well as a flag that indicates whether the user is included in any of them.
Indigitall.topicsList((topics) => {
// Do something with topics in success function
}, (error) => {
// Do something in error function
});To manage the device subscription to one or more groups, there are two methods: topicsSubscribe and topicsUnsubscribe .
Optionally, both receive a TopicsCallback object as the third parameter, which will return the list of all Topic in the project.
// topics is typeof String[]
Indigitall.topicsSubscribe(topics, (topics) => {
// Do something with topics in success function
}, (error) => {
// Do something in error function
});
// topics is typeof String[]
Indigitall.topicsUnsubscribe(topics, (topics) => {
// Do something with topics in success function
}, (error) => {
// Do something in error function
});Your app can send information to indigitall's servers to identify the actions and events that happen in it. This allows you to automate retargeting actions.
To register these events you have to call the sendCustomEvent method, passing a descriptive ID as a parameter (you can invent the one you like best) and set data you need on JSON object.
Indigitall.sendCustomEvent({event: "YOUR_CUSTOM_EVENT", customData:{}, () => {
// Do something in success function
},(error) => {
// Do something in error function
});If you want to integrate the In-App messages in your application, you can do it with several complementary formats:
Next we tell you how to instantiate an In-App message in banner format.
Remember that you should first have them defined in the indigitall console. See our user manual for more info.
Create an InAppComponent component on your page. You must add the size in width and height and the corresponding code in the inAppCode property. The size must match what you have defined in the indigitall console ( Tools> In-App / In-Web Schemas ).
<InAppComponent inAppCode={'YOUR_INAPP_CODE'} width={400} height={600} />If we want to have several InApp, the previous step has to be carried out for each component that we want to show.
Here we tell you how to instantiate an In-App message in popup format.
Remember that you should first have it defined in the indigitall console. See our user manual for more info.
InApp.showPopUp(
{
inAppCode: 'YOUR_INAPP_CODE',
closeIconDisabled: false,
},
(state, inApp) => {
//DO SOMETHING
},
(error) => {
//DO SOMETHING
}
);If you want to customize the icon to close the Popup, you can do it with the following method to which you can pass the name of the image or icon that you must attach in the native versions. In the case of android in the drawable folder and in the case of iOS in assets , if you wanted to use our icon, it would be enough to pass a null. The parameter closeIconDisabled is in case you don't want to show any icon, setting it to true to hide it or false to show it.
InApp.showPopUp(
{
inAppCode: 'YOUR_INAPP_CODE',
closeIconDisabled: false,
imageCloseButtonName: 'YOUR_ICON_BUTTON_NAME'
},
(state, inApp) => {
//DO SOMETHING
},
(error) => {
//DO SOMETHING
}
);In the event that you want to obtain the push object of type json to perform checks and / or when the user clicks on the notification and is with the action of open app.
We leave you this code that will help to obtain it:
For Android, by calling the following method and once the notification is clicked, the push object will be received with the corresponding information:
Indigitall.getPush(push => {
//DO SOMETHING
},(error) => {
// Do something in error function
});In the case of iOS, you have to import the Indigitall library and add the following methods in the application's AppDelegate:
import Indigitall
@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
Indigitall.handle(with: response ,withCompletionHandler: { (push, action) in
print("Push object:", push)
print("Push action app:", action.app)
})
}
#import <Indigitall/Indigitall.h>
- (void) userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler{
[Indigitall handleWithResponse:response withCompletionHandler:^(INPush * _Nonnull push, INPushAction * _Nonnull action) {
NSLog(@"Push object: %@", push);
NSLog(@"Push object app: %@", action.app);
}];
}In this section you will find a series of more advanced functionalities that require a more complex development. We recommend that a developer be in charge of this configuration.
In order to get notifications from Indigitall's Inbox, the user must identify himself. First you have to initialize the SDK of Indigitall so that it generates our identifier (deviceId) and be able to associate it to the custom ID that you associate to the device, similar to how is explained here .
To perform the registration tasks, these two methods are used:
//Identificación de usuario
Indigitall.logIn("YOUR_ID",(device)=>{
//DO SOMETHING
}, (error)=>{
//LOG ERROR
});
Indigitall.logOut(device=>{
//DO SOMETHING
}, (error)=>{
//LOG ERROR
});In this section you will see how to generate a validation token for an application that has configured authentication with webhook. To generate this token, you need to add the JSON with the configuration.
To do this, you will have to add a JSON with the corresponding configuration in each Inbox call.
Once the device has been successfully registered, you can start making the Inbox requests. The following characteristics of the Inbox must be taken into account, which are optionally configurable.
The Inbox notifications will have the following statuses:
Each notification will be assigned with an integer and unique sendingId, to be able to differentiate them and use them for some of the functionalities.
As explained previously, the following method is used to obtain the notifications:
Indigitall.getInbox({"YOUR_AUTH_CONFIG_MAP:IF_NEED"}, (inbox) => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});
Once the Inbox request has been started and launched, we can request the following page, which is carried out with the following method:
Indigitall.getNextPage(inbox) => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});Keep in mind that the Inbox callback, apart from returning the updated Inbox, returns an array called newNotifications , in which the new notifications to be added to the Inbox will be displayed, so that, if necessary, be able to use this array to move between the pages without depending on the Inbox calls.
To get the information of a particular notification, you have to make the following call with the sendingId of each notification:
Indigitall.getInfoFromNotificationWithSendingId({sendingId:SENDING_ID}, (inboxNotification) => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});To edit the status of one or more notifications at the same time, it is done with the following method in which you must indicate the sendingIds of the notifications to edit and the status to which you want to change:
//Modificar una notificación
Indigitall.modifyStatusFromNotificationWithSendingId({
IndigitallParams.PARAM_SENDING_ID:SENDING_ID,
IndigitallParams.PARAM_STATUS:STATUS
}, (inboxNotification) => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});
//Modificar masivamente
Indigitall.massiveEditNotificationsWithSendingIdsList({
IndigitallParams.PARAM_SENDING_ID_LIST:[SENDING_IDS],
IndigitallParams.PARAM_STATUS:STATUS
}, () => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});To know the number of notifications that are in the Inbox according to their status, this method is carried out:
Indigitall.getMessageCount({"YOUR_AUTH_CONFIG_MAP_IF_NEED"}, (counters) => {
//DO SOMETHING
},(error) => {
//LOG IndigitallErrorModel
});