Etapas de integração do SDK Android do Freshchat

// 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);

3.2 Atualizando Propriedades do Usuário (Metadados)

Você pode capturar e enviar metadados adicionais sobre o usuário e os eventos no aplicativo, o que também se torna uma forma de segmentar seus usuários para posteriormente enviar mensagens para eles.  

/* 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()).setUserProperties(userMeta);

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);

Observação: 
1. O Freshchat permite apenas 121 eventos exclusivos por conta 

2. O nome do evento aceita valor de string (máximo de 32 caracteres) 

3. O nome da chave de propriedade deve ser do tipo string (máximo de 32 caracteres) 

4. O valor da propriedade pode ser de qualquer tipo de objeto primitivo (max 256 chars) 

4. O Freshchat permite enviar no máximo 20 propriedades por evento

Freshchat.resetUser(getApplicationContext());

Observação: 
a ID de restauração para um usuário geralmente é gerada apenas quando o usuário envia uma mensagem. 
As notificações são suportadas em apenas um dispositivo móvel a qualquer momento e é atualmente o último dispositivo restaurado ou dispositivo com o último token push atualizado.

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

Para recuperar o id de restauração

String restoreId = Freshchat.getInstance(getApplicationContext()).getUser().getRestoreId();
saveRestoreIdForUser(restoreId);

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

Para ouvir o evento gerado pelo ID de restauração

A geração de ID de restauração é um processo assíncrono. Portanto, você precisa registrar um receptor de transmissão para ser notificado quando o ID de restauração for gerado. Este receptor pode ser registrado no onCreate e não registrado no onTerminate da sua classe de aplicação.

Registre-se para o receptor de transmissão

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

Ouça o receptor de transmissão

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

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

Observação: somente tópicos com visibilidade definida como "Visível para todos os usuários" serão exibidos ao usar a API showConversations()

myConversationsButton.setOnClickListener(new OnClickListener() {    @Override    public void onClick(View view) {        Freshchat.showConversations(getApplicationContext());    }
}); 

4.1.1 Filtrando tópicos de conversa

Para filtrar e exibir apenas tópicos marcados com um termo específico, use a API filterByTags na instância ConversationOptions passada para a API showConversations() conforme abaixo.

Por exemplo: Para vincular e exibir apenas tópicos específicos da página de pedidos em seu aplicativo, esses tópicos específicos podem ser marcados com o termo "order_queries".

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

Nota: 
Se nenhum Tópico correspondente for encontrado, o usuário será redirecionado para o Tópico padrão. 

Os tópicos que normalmente não são visíveis ao usar a API showConversations() também serão exibidos quando marcados e a tag específica for passada para a API filterByTags da instância ConversationOptions passada para a API showConversations().

Por favor, consulte este vídeo para mais informações

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));        }    });

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

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));            }        });    }
}

Cancelar o registro do broadcast receiver

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

4.1.3 Contagem de mensagens não lidas em conversas filtradas por tags

Se você deseja obter o número de mensagens não lidas para o usuário em conversas específicas filtradas por tags, use a API getUnreadCountAsync.

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);

myFAQButton.setOnClickListener(new OnClickListener() {    @Override    public void onClick(View view) {        Freshchat.showFAQs(getApplicationContext());    }
});

// Launching FAQ from click of a button in your app's screen
myFAQButton.setOnClickListener(new OnClickListener() {    @Override    public void onClick(View view) {
        FaqOptions faqOptions = new FaqOptions()            .showFaqCategoriesAsGrid(true)            .showContactUsOnAppBar(true)            .showContactUsOnFaqScreens(false)            .showContactUsOnFaqNotHelpful(false);
        Freshchat.showFAQs(MainActivity.this, faqOptions);    }
});

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);

Observação: as perguntas frequentes também herdam as tags da categoria principal de perguntas frequentes

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);

Observação: o comportamento padrão para "Fale conosco" no fluxo de perguntas frequentes é o mesmo que invocar showConversations(), ou seja, exibirá todos os tópicos marcados como "Visíveis para todos os usuários", exceto quando a filtragem de tópicos estiver habilitada passando tags para filterContactUsByTags API.

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);

Observação: esta API enviaria silenciosamente uma mensagem e não iniciaria a interface do usuário do Freshchat SDK

String tag = "premium";
String msgText = "User has trouble with order #1234";
FreshchatMessage FreshchatMessage = new FreshchatMessage().setTag(tag).setMessage(msgText);
Freshchat.sendMessage(getContext(), FreshchatMessage);

Consulte este vídeo para obter mais informações.

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

public void onMessageReceived(RemoteMessage remoteMessage) {    if (Freshchat.isFreshchatNotification(remoteMessage)) {        Freshchat.handleFcmMessage(context, remoteMessage);    } else {        // Handle notifications with data payload for your app    }
}

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

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

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);

7. Localização de idioma

7.1 Alteração dos textos padrão do SDK

Todas as strings no SDK podem ser modificadas substituindo-as em strings.xml.

Todos os textos do Freshchat podem ser encontrados  aqui .

7.2 Localização

7.2.1  Localização de idioma dos textos padrão do Freshchat

Todas as strings no SDK podem ser modificadas substituindo-as no respectivo arquivo strings.xml de localidade.

Todos os textos do Freshchat podem ser encontrados  aqui .

Para obter mais detalhes, consulte a documentação do desenvolvedor do Android  aqui .

7.2.2  Localização do idioma de perguntas frequentes e tópicos

Depois que as perguntas frequentes e os tópicos forem localizados no aplicativo da web Freshchat, o SDK atualizará automaticamente o conteúdo com base na localidade do aplicativo/dispositivo do usuário.

7.3 Suporte a idiomas da direita para a esquerda

O Freshchat SDK oferece suporte a idiomas RTL. 

7.4 Mudança de localidade do aplicativo em tempo de execução

Se seu aplicativo puder oferecer suporte a diferentes localidades (idiomas) além da localidade padrão do dispositivo, siga as etapas abaixo para atualizar a localidade em seu SDK do Freshchat.

1. Depois que o aplicativo mudar de localidade, notifique o sdk sobre a mudança de localidade do aplicativo usando o método abaixo,

Freshchat.notifyAppLocaleChange(activityContext);

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);    }  };

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

8. Personalizações

8.1 Opções de personalização da interface do usuário

Consulte a documentação do tema  aqui .

8.2 Carregador de imagens personalizado

O padrão do SDK é incluir a biblioteca Picasso 2.5.2 para baixar imagens. Se quiser usar qualquer outra versão do Picasso ou qualquer outra biblioteca de download de imagens, você pode definir seu downloader de imagem personalizado com o Freshchat SDK usando a API setImageLoader().

Exemplos

Implemente seu carregador de imagem personalizado

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  }
}

public class MyApp extends Application {
  @Override  public void onCreate() {    super.onCreate();    Freshchat.setImageLoader(new CustomImageLoader());  }
}

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);

1. Certifique-se de inicializar o SDK no onCreate do aplicativo ou atividade de suporte.
2. Verifique se você está usando a versão mais recente do SDK.
3. Verifique se as notificações por push estão funcionando desde o primeiro lançamento e se os ícones de notificação corretos estão configurados.
4. Certifique-se de que o nome do aplicativo esteja definido corretamente para suas notificações.
5. Configure o nome do tópico padrão e a mensagem de boas-vindas, mesmo se você não estiver usando outros tópicos.
6. Capture o identificador exclusivo do usuário, e-mail, número de telefone ou qualquer outro identificador exclusivo do cliente com o SDK para garantir o uso tranquilo das APIs, bem como para o melhor uso do nosso recurso "Smart Plugs" no painel.
7. Certifique-se de que as notificações por push estejam funcionando para novas instalações, bem como atualizações de suas versões anteriores.
   
   

9.2 Permissões

O SDK do Freshchat é criado com suporte para o modelo de tempo de execução/permissões dinâmicas introduzido no Marshmallow, desde que o aplicativo seja criado com targetSdk como Marshmallow ou posterior.

9.3 Configuração do Proguard (se o Proguard estiver ativado em seu aplicativo)

O Freshchat Android SDK é configurado imediatamente para oferecer suporte ao proguard. O Proguard selecionará automaticamente a configuração para o SDK, nenhuma configuração manual é necessária.