1
2
3
4
5
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

1
2
3
4
5
6
7
8
apply plugin: 'com.android.application'
android {
// ...
}
dependencies {
// ...
   implementation 'com.github.freshworks:freshchat-android:{{latest-version}}'
}

1
2
3
4
5
6
7
8
9
<provider
     android:name="androidx.core.content.FileProvider"
     android:authorities="com.example.demoapp.provider"
     android:exported="false"
     android:grantUriPermissions="true">
     <meta-data
         android:name="android.support.FILE_PROVIDER_PATHS"
         android:resource="@xml/freshchat_file_provider_paths" />
</provider>

1
<string name="freshchat_file_provider_authority">com.example.demoapp.provider</string>

1
2
3
4
5
6
7
8
FreshchatConfig config = new FreshchatConfig("YOUR-APP-ID","YOUR-APP-KEY");
config.setDomain("YOUR-DOMAIN");
config.setCameraCaptureEnabled(true);
config.setGallerySelectionEnabled(true);
config.setResponseExpectationEnabled(true);
config.setTeamMemberInfoVisible(true);
config.setUserEventsTrackingEnabled(true);
Freshchat.getInstance(getApplicationContext()).init(config);

1
2
3
4
{
    "freshchat_uuid": "6bc903d6-12ba-11eb-adc1-0242ac120002",
    "reference_id": "sample_user"
}

1
Freshchat.getInstance(getContext()).restoreUser("JWT_TOKEN");

1
2
3
4
5
6
7
8
9
{
    "first_name": "Duraivel",
    "last_name" : "P",
    "custom_prop1": "value1",
    "freshchat_uuid": "6bc903d6-12ba-11eb-adc1-0242ac120002",
    "reference_id": "refId123456"
}

Freshchat.getInstance(getContext()).setUser("JWT_TOKEN");

1
2
3
{
    "freshchat_uuid": "6bc903d6-12ba-11eb-adc1-0242ac120002"
}

1
Freshchat.getInstance(getContext()).setUser("JWT_TOKEN");

1
2
3
4
5
6
7
8
{
    "first_name": "Duraivel",
    "last_name" : "P",
    "custom_prop1": "value1",
    "freshchat_uuid": "6bc903d6-12ba-11eb-adc1-0242ac120002"
}

Freshchat.getInstance(getContext()).setUser("JWT_TOKEN");

1
Freshchat.getInstance(getContext()).getUserIdTokenStatus();

1
2
IntentFilter freshchatEventsIntentFilter = new IntentFilter(Freshchat.FRESHCHAT_EVENTS);
LocalBroadcastManager.getInstance(getApplicationContext()).registerReceiver(freshchatEventsReceiver, freshchatEventsIntentFilter);

1
2
3
4
5
6
7
8
9
10
BroadcastReceiver freshchatEventsReceiver = new BroadcastReceiver() {

    @Override
    public void onReceive(Context context, Intent intent) {
         Event event = Freshchat.getEventFromBundle(intent.getExtras());
         if (event.getEventName() == Event.EventName.FCEventIdTokenStatusChange) {
              Log.e("FreshchatTest", "Token status - " + Freshchat.getInstance(getApplicationContext()).getUserIdTokenStatus());
         }
    }
};

1
LocalBroadcastManager.getInstance(getApplicationContext()).unregisterReceiver(freshchatEventsReceiver);

1
2
3
4
5
[[NSNotificationCenter defaultCenter]
     addObserver:self
     selector:@selector(userActionEvent:)       
     name:FRESHCHAT_EVENTS     
     object:nil];

1
2
3
4
5
6
(void) userActionEvent:(NSNotification *)notif {
    FreshchatEvent *fcEvent = notif.userInfo[@"event"];
         if(fcEvent.name == FCEventIdTokenStatusChange){
              NSString *tokenStatus = [[Freshchat sharedInstance] getUserIdTokenStatus];
         }
}

1
2
3
4
[[NSNotificationCenter defaultCenter]
     removeObserver:self
     name:FRESHCHAT_EVENTS
     object:nil];

1
2
3
4
5
6
7
8
9
// Get the user object for the current installation
FreshchatUser freshchatUser = Freshchat.getInstance(getApplicationContext()).getUser();
freshchatUser.setFirstName("John");
freshchatUser.setLastName("Doe");
freshchatUser.setEmail("john.doe.1982@mail.com");
freshchatUser.setPhone("+91", "9790987495");

// Call setUser so that the user information is synced with Freshchat's servers
Freshchat.getInstance(getApplicationContext()).setUser(freshchatUser);

1
2
3
4
5
6
7
8
9
10
11
/* Set any custom metadata to give agents more context, and for segmentation for marketing or pro-active messaging */
Map<String, String> userMeta = new HashMap<String, String>();
userMeta.put("userLoginType", "Facebook");
userMeta.put("city", "SpringField");
userMeta.put("age", "22");
userMeta.put("userType", "premium");
userMeta.put("numTransactions", "5");
userMeta.put("usedWishlistFeature", "yes");
                              
//Call setUserProperties to sync the user properties with Freshchat's servers
Freshchat.getInstance(getApplicationContext()).setUser(userMeta);

1
Freshchat.getInstance(getApplicationContext()).identifyUser(externalId, null);

1
2
IntentFilter intentFilter = new IntentFilter(Freshchat.FRESHCHAT_USER_RESTORE_ID_GENERATED);
LocalBroadcastManager.getInstance(getApplicationContext()).registerReceiver(broadcastReceiver, intentFilter);

1
2
3
4
5
6
BroadcastReceiver broadcastReceiver = new BroadcastReceiver() { 
   @Override
   public void onReceive(Context context, Intent intent) {
      String restoreId = Freshchat.getInstance(getApplicationContext()).getUser().getRestoreId();
   }
};

1
LocalBroadcastManager.getInstance(getApplicationContext()).unregisterReceiver(broadcastReceiver);

1
saveRestoreIdForUser(restoreId);

1
Freshchat.getInstance(getApplicationContext()).identifyUser(externalId, restoreId);

1
Freshchat.resetUser(getApplicationContext());

1
2
3
4
5
6
7
8
9
10
String eventName = "Visited Order Details page";

// Create a map and set required properties like below 
HashMap<String, Object> properties = new HashMap<>();
properties.put("Order Id", 3223232332);
properties.put("Order Date", "24 Jan 2020");
properties.put("Order Status ", "In-Transit");

// Call trackEvent by passing eventName and a map of properties
Freshchat.trackEvent(getContext(), eventName, properties);

1
2
String token = FirebaseInstanceId.getInstance().getToken();
Freshchat.getInstance(this).setPushRegistrationToken(token);

1
2
3
4
5
6
7
8
public void onMessageReceived(RemoteMessage remoteMessage)
{  
   if (Freshchat.isFreshchatNotification(remoteMessage)) { 
      Freshchat.handleFcmMessage(context, remoteMessage);    
   } else {    
      // Handle notifications with data payload for your app  
   }
}

1
<color name="freshchat_notification_accent_color">@color/red</color>

1
<string name="freshchat_campaign_notification_channel_name">Campaign messages</string>

1
2
3
4
5
6
7
FreshchatNotificationConfig notificationConfig = new FreshchatNotificationConfig()    
.setNotificationSoundEnabled(true)    
.setSmallIcon(R.drawable.ic_notif_small_icon)    
.setLargeIcon(R.drawable.ic_notif_large_icon)
.launchActivityOnFinish(MainActivity.class.getName()) 
.setPriority(NotificationCompat.PRIORITY_HIGH);
Freshchat.getInstance(getApplicationContext()).setNotificationConfig(notificationConfig);

1
2
3
4
5
6
myFAQButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View view) {
        Freshchat.showFAQs(getApplicationContext());
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
myFAQButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View view) {
  
        FaqOptions faqOptions = new FaqOptions()
            .showFaqCategoriesAsGrid(true) //To display the FAQ categories as list, set the value as false.
            .showContactUsOnAppBar(true) // To hide Contact us from the app bar, set the value as true.
            .showContactUsOnFaqScreens(false) //To show Contact us on FAQ screen, set the value as true.
            .showContactUsOnFaqNotHelpful(false); //To show Contact us on FAQ feedback, set the value as true
  
        Freshchat.showFAQs(MainActivity.this, faqOptions);
    }
 });

1
2
3
4
5
6
7
List<String> tags = new ArrayList<>();
tags.add("premium");
     
FaqOptions faqOptions = new FaqOptions()
    .filterByTags(tags, "FAQs", FaqOptions.FilterType.CATEGORY);//tags, filtered screen title, type
    
Freshchat.showFAQs(MainActivity.this, faqOptions);

1
2
3
4
5
6
7
List<String> tags = new ArrayList<>();
tags.add("payment_failure");
    
FaqOptions faqOptions = new FaqOptions()
    .filterByTags(tags, "payment_failure", FaqOptions.FilterType.ARTICLE);//tags, filtered screen title, type
    
Freshchat.showFAQs(MainActivity.this, faqOptions);

1
2
3
4
5
6
7
8
List<String> tags = new ArrayList<>();
tags.add("payment_failure");

FaqOptions faqOptions = new FaqOptions()
    .filterContactUsByTags(tags, "Payments");

//tags, filtered screen title
Freshchat.showFAQs(MainActivity.this, faqOptions);

1
2
3
4
5
6
myConversationsButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View view) {
        Freshchat.showConversations(getApplicationContext());
    }
});

1
2
3
4
5
List<String> tags = new ArrayList<>();
tags.add("order_queries");
ConversationOptions options = new ConversationOptions()
    .filterByTags(tags, "Order Queries");
Freshchat.showConversations(MainActivity.this, options);

1
2
3
4
5
6
7
Freshchat.getInstance(getApplicationContext()).getUnreadCountAsync(new UnreadCountCallback() {
    @Override
    public void onResult(FreshchatCallbackStatus freshchatCallbackStatus, int unreadCount) {
        //Assuming "badgeTextView" is a text view to show the count on
        badgeTextView.setText(Integer.toString(unreadCount));
    }
});

1
2
IntentFilter intentFilter = new IntentFilter(Freshchat.FRESHCHAT_UNREAD_MESSAGE_COUNT_CHANGED);
getLocalBroadcastManager(getApplicationContext()).registerReceiver(unreadCountChangeReceiver, intentFilter);

1
2
3
4
5
6
7
8
9
10
11
12
BroadcastReceiver unreadCountChangeReceiver = new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        Freshchat.getInstance(getApplicationContext()).getUnreadCountAsync(new UnreadCountCallback() {
            @Override
            public void onResult(FreshchatCallbackStatus freshchatCallbackStatus, int unreadCount) {
                //Assuming "badgeTextView" is a text view to show the count on
                badgeTextView.setText(Integer.toString(unreadCount));
            }
        });
    }
 }

1
getLocalBroadcastManager(getApplicationContext()).unregisterReceiver(unreadCountChangeReceiver);

1
2
3
4
5
6
7
8
List<String> tags = new ArrayList<>();
tags.add("premium"); // Tags to filter conversations by
Freshchat.getInstance(getApplicationContext()).getUnreadCountAsync(new UnreadCountCallback() {
    @Override
    public void onResult(FreshchatCallbackStatus FreshchatCallbackStatus, int unreadCount) {
        badgeTextView.setText(Integer.toString(unreadCount));
    }
}, tags);

1
<string name="freshchat_activity_title_channel_list">Conversations</string>

1
Freshchat.notifyAppLocaleChange(activityContext);

1
2
3
4
5
6
7
8
9
10
11
12
private FreshchatWebViewListener webviewListener = new FreshchatWebViewListener() {

    @Override
    public void onLocaleChangedByWebView(@NonNull WeakReference<Context> activityContext) {
      if (activityContext.get() == null) {
        return;
      }
      
      // Reset the run time locale here
      changeLocale(activityContext, appLocale);
    }
  };

1
Freshchat.getInstance(this).setWebviewListener(webviewListener);

1
<style name="Theme.Freshchat.SelectedTheme" parent="@style/Theme.Freshchat.Light.DarkActionBar" />

1
<item name="colorPrimary">@color/my_awesome_color</item>

1
2
3
4
5
6
7
8
<style name="MyCustomTextAppearance" parent="TextAppearance.AppCompat.Medium">
   <item name="android:textColor">@color/textColorPrimary</item>
   <item name="android:textColorHighlight">@color/textColorHighlight</item>
   <item name="android:textColorHint">@color/textColorHint</item>
   <item name="android:textColorLink">@color/textColorLink</item>
   <item name="android:textSize">16sp</item>
   <item name="android:textStyle">bold</item>
</style>

1
2
3
4
5
6
<style name="MyCustomTheme" parent="Theme.Freshchat.Light.DarkActionBar">
    <item name="freshchatChannelNameTextStyle">@style/CustomChannelNameTextStyle</item>
</style>
<style name="CustomChannelNameTextStyle" parent="Widget.Freshchat.ChannelName">    
    <item name="android:textAppearance">@style/MyCustomTextAppearance</item>
</style>

1
<style name="Theme.Freshchat.SelectedTheme" parent="MyCustomTheme" />

1
2
<activity android:name="com.freshchat.consumer.sdk.activity.ChannelListActivity"   android:theme="@style/MyCustomTheme"  tools:replace="android:theme" />
<activity android:name="com.freshchat.consumer.sdk.activity.ConversationDetailActivity"   android:theme="@style/MyAlternateTheme"   tools:replace="android:theme" />

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!-- Action Icons -->
<item name="freshchatSendIcon">@drawable/freshchat_ic_send</item>
<item name="freshchatCancelIcon">@drawable/freshchat_ic_cancel</item>
<item name="freshchatAttachIcon">@drawable/freshchat_ic_attach</item>

<!-- ActionBar Menu Icons-->
<item name="freshchatSearchIcon">@drawable/freshchat_ic_action_search_light</item>

<!-- Misc Icons-->
<item name="freshchatTeamMemberAvatarIcon">@null</item>
<item name="freshchatContactUsIcon">@drawable/freshchat_ic_action_contact_us</item>

<!-- Chat Bubbles -->
<item name="freshchatChatBubbleLeft">@drawable/freshchat_chat_bubble_left</item>
<item name="freshchatChatBubbleRight">@drawable/freshchat_chat_bubble_right</item>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class CustomImageLoader implements FreshchatImageLoader {
@Override
 public void load(@NonNull FreshchatImageLoaderRequest request, @NonNull ImageView imageView) {
    // your code to download image and set to imageView
  }

  @Nullable
  @Override
  public Bitmap get(@NonNull FreshchatImageLoaderRequest request) {
    // code to download and return bitmap image
  }

  @Override
  public void fetch(@NonNull FreshchatImageLoaderRequest request) {
    // code to download image
  }
}

1
2
3
4
5
6
7
public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Freshchat.setImageLoader(new CustomImageLoader());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
private LinkHandler linkHandler = new LinkHandler() {
    @Override
    public boolean handleLink(@NonNull String url, @Nullable Bundle bundle) {
        if (urlHandledByApp) {
            return true; // true, if handled by app
        } else {
            return false; // false, to let Freshchat SDK handle the link
        }
    }
};

// Set link handler to override links

Freshchat.getInstance(context).setCustomLinkHandler(linkHandler);