Cordova/Phonegap
Configuring Intercom for Mobile on Cordova/Phonegap
Track who your users are and what they do in your mobile app and customize the Intercom Messenger. Here’s how to configure Intercom for Cordova/Phonegap:
Update a user
You can send any data you like to Intercom from standard user attributes that are common to all Intercom users to custom user attributes that are unique to your app.
Standard user attributes such as a user's name or email address can be updated by calling:
intercom.updateUser({ email: "[email protected]", name: "Bob" });
Typically our customers see a lot of value in sending custom data that relates to customer development, such as price plan, value of purchases, etc. Custom user attributes can be created and modified by passing a custom_attributes map. A detailed description of the user model is available here.
intercom.updateUser({
custom_attributes: {
paid_subscriber : true,
monthly_spend: 155.5,
team_mates: 3
}
});
You don’t have to create attributes in Intercom beforehand. If a custom attribute hasn't been seen before, it will be created for you automatically.
You can also set company data by submitting an attribute map, like:
intercom.updateUser({
companies: [{
name : "My company",
company_id: "abcd1234"
}]
});
- company_id is a required field for adding or modifying a company.
- A detailed description of the company model is available here.
Submit an event
You can log events in Intercom that record what users do in your app and when they do it. For example, you could record the item a user ordered from your mobile app, and when they ordered it.
intercom.logEvent("ordered_item", {
order_date: 1392036272,
stripe_invoice: "inv_3434343434",
order_number: 123,
value: "3434-3434",
url: "https://example.org/orders/3434-3434"
});
You’ll find more details about how events work and how to submit them here.
Customize the Intercom Messenger
We definitely recommend that you customize the Intercom Messenger so that it feels completely at home on your product, site or mobile app. Here’s how:
- Select the color and language of the Messenger and how personalize your profiles.
- Follow the below steps to choose how the launcher appears and opens for your users.
Choose how the launcher appears and opens for your users
If you’d like the standard launcher to appear on the bottom right-hand side of your screen, just call:
intercom.setLauncherVisibility('VISIBLE');
Create a custom launcher
However, if you’d like the Messenger to open from another location in your mobile app, you can create a custom launcher. This allows you to specify a button, link or element that opens the Messenger. For example, you can trigger the launcher to open when a customer clicks on your ‘Help and Support’ button.
If you have a custom launcher, you can call intercom.displayMessenger();
and we’ll ensure the Messenger opens in the best place for each user. For example:
- If a user has one unread conversation, we open that conversation.
- If a user has no conversations, we open the composer.
- If a user has more than one unread conversation, we open the conversations list.
- If a user has no unread conversations, we open the last screen they were on when they closed it.
Show your user’s unread message count
Now you can show how many unread conversations your user has on your custom launcher. Even if a user dismisses a notification, they’ll still have a persistent indicator of unread conversations.
Just grab the current count with this method:
intercom.unreadConversationCount();
Temporarily hide notifications
You can prevent in app messages from popping up in certain parts of your app by calling:
intercom.setInAppMessageVisibility('GONE');
You can hide the Intercom Messenger in your app by calling:
intercom.hideMessenger();
What's next?
Now that you have Intercom configured you can:
- Enable Secure Mode for Cordova.
- Configure Push Notifications for Cordova/Phonegap
Updated over 6 years ago