Intercom class
Properties
hashCode → int
The hash code for this object.
no setter inherited
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
Methods
displayArticle (String articleId → Future <void >
To display an Article, pass in an articleId from your Intercom workspace.
displayCarousel (String carouselId → Future <void >
To display a Carousel, pass in a carouselId from your Intercom workspace.
displayConversation (String conversationId → Future <void >
To display a Conversation, pass in a conversationId from your Intercom workspace.
displayHelpCenter ()
→ Future <void >
To display an Activity with your Help Center content.
displayHelpCenterCollections (List <String collectionIds → Future <void >
To display an Activity with your Help Center content for specific collections.
displayHome ()
→ Future <void >
To display an Intercom Home space.
displayMessageComposer (String message → Future <void >
To open the Intercom messenger to the composer screen with message
field pre-populated.
displayMessages ()
→ Future <void >
To display an Activity with your Messages content.
displayMessenger ()
→ Future <void >
To open the Intercom messenger.
displaySurvey (String surveyId → Future <void >
To display a Survey, pass in a surveyId from your Intercom workspace.
displayTickets ()
→ Future <void >
To display an activity with all your tickets.
fetchLoggedInUserAttributes ()
→ Future <Map <String dynamic >
Retrieve the details of the currently logged in user.
getUnreadStream ()
→ Stream
You can check how many unread conversations a user has
even if a user dismisses a notification.
handlePush (Map <String dynamic > message → Future <void >
If the push message is for Intercom then use this method to let
Intercom handle that push.
handlePushMessage ()
→ Future <void >
When a user taps on a push notification Intercom hold onto data
such as the URI in your message or the conversation to open.
hideMessenger ()
→ Future <void >
To close the Intercom messenger.
initialize (String appId , {String ?androidApiKey , String ?iosApiKey → Future <void >
Function to initialize the Intercom SDK.
isIntercomPush (Map <String dynamic > message → Future <bool
To check if the push message is for Intercom or not.
This is useful when your app is also configured to receive push messages
from third parties.
isUserLoggedIn ()
→ Future <bool
Determine if a user is currently logged in to Intercom.
logEvent (String name , [Map <String dynamic > ?metaData → Future <void >
To log events in Intercom that record what users do in your app and when they do it.
For example, you can record when user opened a specific screen in your app.
You can also pass metaData about the event.
loginIdentifiedUser ({String ?userId , String ?email , IntercomStatusCallback ?statusCallback → Future <void >
Function to create a identified user in Intercom.
You need to register your users before you can talk to them and
track their activity in your app.
loginUnidentifiedUser ({IntercomStatusCallback ?statusCallback → Future <void >
Function to create a unidentified user in Intercom.
You need to register your users before you can talk to them and
track their activity in your app.
logout ()
→ Future <void >
To logout a user from Intercom.
This clears the Intercom SDK's cache of your user's identity.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendTokenToIntercom (String token → Future <void >
The token to send to the Intercom to receive the notifications.
setAuthTokens (Map <String String tokens → Future <void >
Set up the authentication (user-defined token) to secure your Data
connectors. These tokens can be used for functionality such as Fin Actions.
You can provide multiple tokens at once. Please ensure you have created
the correct keys here
setBottomPadding (int padding → Future <void >
This method allows you to set a fixed bottom padding for in app messages and the launcher.
setInAppMessagesVisibility (IntercomVisibility visibility → Future <void >
To allow or prevent in app messages from popping up in certain parts of your app.
setLauncherVisibility (IntercomVisibility visibility → Future <void >
To hide or show the standard launcher on the bottom right-hand side of the screen.
setUserHash (String userHash → Future <void >
To make sure that conversations between you and your users are kept private
and that one user can't impersonate another then you need you need to setup
the identity verification.
setUserJwt (String jwt → Future <void >
JWT (JSON Web Token) is the recommended method to secure your Messenger.
With JWT, you can ensure that bad actors can't impersonate your users,
see their conversation history, or make unauthorized updates to data.
toString ()
→ String
A string representation of this object.
inherited
unreadConversationCount ()
→ Future <int
You can check how many unread conversations a user has
even if a user dismisses a notification.
updateUser ({String ?email , String ?name , String ?phone , String ?company , String ?companyId , String ?userId , int ?signedUpAt , String ?language , Map <String dynamic > ?customAttributes , IntercomStatusCallback ?statusCallback → Future <void >
Updates the attributes of the current Intercom user.
