Show Menu
TÓPICOS×

Métodos de configuração

Esta é uma lista de métodos do fornecida pela biblioteca do Android.

Configuração inicial

O método a seguir deve ser chamado uma vez no método onCreate da atividade principal:
  • setContext Esta é a amostra de código para este método:
     @Override
     public void onCreate(BundlesavedInstanceState){
       super.onCreate(savedInstanceState)
       setContentView(R.layout.main);
       Config.setContext(this.getApplicationContext());
     }
    
    

Configurações do SDK (Classe de configuração)

  • registerAdobeDataCallback
    • Registra um objeto que implementa a interface do AdobeDataCallback . O método "call" substituído será chamado com um valor Config.MobileDataEvent e os dados referentes em uma Map<String, Object> para o evento de acionamento. Para obter mais detalhes sobre quais eventos acionarão esse retorno de chamada, consulte MobileDataEventEnum no final deste tópico.
      Este método exige a versão 4.9.0 ou posteriores.
    • Esta é a sintaxe para este método:
      public static void registerAdobeDataCallback(final AdobeDataCallback&amp;nbsp;callback);
      
      
    • Esta é a amostra de código para este método:
        Config.registerAdobeDataCallback(new Config.AdobeDataCallback() {
          @Override
          public void call(Config.MobileDataEvent event, Map<String, Object> contextData) {
              // handle each event type accordingly 
              if (event == Config.MobileDataEvent.MOBILE_EVENT_ACQUISITION_INSTALL) {
                   // do something with acquisition data found in contextData parameter
                   HashMap<String, Object> acquisitionData = new HashMap<String, Object>(contextData);
              }
          }
      });
      
      
  • getVersion
    • Retorna a versão atual da biblioteca do Adobe Mobile.
    • Esta é a sintaxe para este método:
      public static String getVersion();
      
      
    • Este é um exemplo de código para este método:
      String libraryVersion = Config.getVersion(); 
      
      
  • getPrivacyStatus
    • Retorna a representação de enumeração do status de privacidade do usuário atual.
      Estes são os valores do status de privacidade:
      • MOBILE_PRIVACY_STATUS_OPT_IN , em que as ocorrências são enviadas imediatamente.
      • MOBILE_PRIVACY_STATUS_OPT_OUT , em que as ocorrências são descartadas.
      • MOBILE_PRIVACY_STATUS_UNKNOWN , se o conjunto de relatórios tiver um carimbo de hora e data, as ocorrências serão salvas até que o status de privacidade seja alterado para “aceitar” (as ocorrências são enviadas) ou “recursar”(as ocorrências são descartadas).
        Se o conjunto de relatórios não tiver carimbo de hora e data, as ocorrências são descartadas até o status de privacidade ser alterado para opt in. O valor padrão está definido no arquivo ADBMobileConfig.json .
    • Esta é a sintaxe para este método:
      public static MobilePrivacyStatus getPrivacyStatus(); 
      
      
    • Esta é uma amostra de código para este método:
      MobilePrivacyStatus privacyStatus Config.getPrivacyStatus();
      
      
  • setPrivacyStatus
    • Define o de privacidade do usuário atual como status status.
      E possível definir o status de privacidade para um dos valores a seguir:
      • MOBILE_PRIVACY_STATUS_OPT_IN , em que as ocorrências são enviadas imediatamente. Essas ocorrências são enviadas imediatamente.
      • MOBILE_PRIVACY_STATUS_OPT_OUT , em que as ocorrências são descartadas. Essas ocorrências são descartadas.
      • MOBILE_PRIVACY_STATUS_UNKNOWN , se o conjunto de relatórios tiver um carimbo de hora e data, as ocorrências serão salvas até que o status de privacidade seja alterado para opt-in (as ocorrências são enviadas) ou opt-out (as ocorrências são descartadas). Se o conjunto de relatórios não tiver carimbo de hora e data, as ocorrências são descartadas até o status de privacidade ser alterado para opt in.
    • Esta é a sintaxe para este método:
      public static void setPrivacyStatus(MobilePrivacyStatus status); 
      
      
    • Esta é uma amostra de código para este método:
      Config.setPrivacyStatus(MobilePrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN); 
      
      
  • getLifetimeValue
    • Retorna o valor do tempo de vida do usuário atual. O valor padrão é 0 .
    • Esta é a sintaxe para este método:
      public static BigDecimal getLifetimeValue();
      
      
    • Esta é uma amostra de código para este método:
      BigDecimal currentLifetimeValue Config.getLifetimeValue(); 
      
      
  • getUserIdentifier
    • Se um identificador personalizado do usuário foi definido, ele é retornado. Se um identificador personalizado não foi definido, retorna null . O valor padrão é null .
      Se seu aplicativo for atualizado do SDK 3.x da Experience Cloud para o 4.x, a ID anterior de visitante, personalizada ou gerada automaticamente, será recuperada e armazenada como o identificador personalizado do usuário. Isso preserva os dados dos visitantes entre as atualizações de SDK. Para novas instalações do SDK 4.x, até que seja definido, o identificador do usuário é null .
    • Esta é a sintaxe para este método:
      public static String&amp getUserIdentifier();
      
      
    • Esta é a amostra de código para este método:
      String userId = Config.getUserIdentifier();
      
      
  • setUserIdentifier
    • Define o identificador do usuário para identifier .
    • Esta é a sintaxe para este método:
      public static void setUserIdentifer(String identifier);
      
      
    • Esta é a amostra de código para este método:
      Config.setUserIdentifier("billybob"); 
      
      
  • getDebugLogging
    • Retorna a preferência de log para a depuração atual. O valor padrão é false .
    • Esta é a sintaxe para este método:
      public static Boolean getDebugLogging(); 
      
      
    • Esta é a amostra de código para este método:
      Boolean debugging = Config.getDebugLogging(); 
      
      
  • setDebugLogging
    • Define a preferência do log de depuração como debugLogging .
    • Esta é a sintaxe para este método:
      public static void setDebugLogging(Boolea debugLogging);
      
      
    • Esta é a amostra de código para este método:
      Config.setDebugLogging(true);
      
      
  • collectLifecycleData
    • Indica ao SDK que os dados do ciclo de vida devem ser coletados para uso em todas as soluções no SDK. Para obter mais informações, consulte Medições de ciclo de vida .
    • Esta é a sintaxe para este método:
      public static void collectLifecycleData(final Activity activity,final Map<String, Object>contextData); 
      
      
    • Esta é a amostra de código para este método:
      @Override
      protectedvoid  onResume()  {
        super.onResume();
        Config.collectLifecycleData(this);
        } 
      
      
      Com dados de contexto extras:
      @Override
      public  void  onResume()  {
        HashMap<String, Object> contextData = new HashMap<String, Object>();
        contextData.put("myapp.category", "Game");        Config.collectLifecycleData(this, contextData);} 
      
      
  • collectLifecycleData (atividade Activity)
    • ( Versão 4.2 ou superior ) Indica ao SDK que os dados do ciclo de vida devem ser coletados para uso em todas as soluções no SDK. Para obter mais informações, consulte Medições de ciclo de vida .
    • Esta é a sintaxe para este método:
      public static void collectLifecycleData(final Activity activity);
      
      
    • Esta é a amostra de código para este método:
      @Overrideprotected void onResume() {
        super.onResume()
        // assume being called in an Activity class Config.collectLifecycleData(this);
        } 
      
      
  • pauseCollecting​LifecycleData
    • Indica ao SDK que o aplicativo está pausado, a fim de calcular corretamente as medições de ciclo de vida. Por exemplo, o onPause coleta um carimbo de data e hora para determinar a duração da sessão anterior. Isso também define um sinalizador para que o ciclo de vida saiba que o aplicativo não parou de funcionar. Para obter mais informações, consulte Medições de ciclo de vida .
    • Esta é a sintaxe para este método:
      public static void pauseCollectingLifecycleData(); 
      
      
    • Esta é a amostra de código para este método:
      @Override
      protected void onPause() {
        super.onPause();
        Config.pauseCollectingLifecycleData();
      } 
      
      
  • setSmallIconResourceId(int resourceId)
    • ( Versão 4.2 ou superior ) Define o ícone pequeno que será usado nas notificações criadas pelo SDK. Este ícone aparecerá na barra de status e será a imagem secundária exibida quando o usuário visualizar a notificação completa na central de notificações.
    • Esta é a sintaxe para este método:
      public static void setSmallIconResourceId(final int resourceId); 
      
      
    • Esta é a amostra de código para este método:
      Config.setSmallIconResourceId(R.drawable.appIcon);
      
      
  • setLargeIconResourceId(int resourceId)
    • ( Versão 4.2 ou superior ) Define o ícone grande que será usado nas notificações criadas pelo SDK. Este ícone será a principal imagem exibida quando o usuário visualizar a notificação completa na central de notificações.
    • Esta é a sintaxe para este método:
      public static void setLargeIconResourceId(final int  resourceId);
      
      
    • Esta é a amostra de código para este método:
      Config.setLargeIconResourceId(R.drawable.appIcon);
      
      
  • overrideConfigStream(InputStream configInput)
    • ( Versão 4.2 ou superior ) Permite carregar um arquivo de configuração ADBMobile JSON diferente quando o aplicativo é iniciado. A configuração diferente é utilizada até o aplicativo ser fechado.
    • Esta é a sintaxe para este método:
      public static void overrideConfigStream(final InputStream configInput);
      
      
    • Esta é a amostra de código para este método:
       try {
          InputStream configInput = getAssets().open("ExampleJSONFile.json") 
          Config.overrideConfigStream(configInput)
          } catch (IOException ex) { 
          //do something with the exception if needed
      }
      
      
  • setPushIdentifier
    • Define o token do dispositivo para notificações por push.
    • Esta é a sintaxe para este método:
      public static void setPushIdentifier(final String registrationId); 
      
      
    • Esta é a amostra de código para este método:
      ...// note the code to retreive the push token must run in the background
      InstanceID instanceID= InstanceID.getInstance(getApplicationContext());String token=instanceID.getToken("835015092242", GoogleCloudMessaging.INSTANCE_ID_SCOPE null);Config.setPushIdentifier(token);
      ...
      
      
  • submitAdvertisingIdentifierTask
    • Fornece um Callable ao SDK que retorna a string do Identificador de anúncio retornado do Google Play Services. O SDK executa esta tarefa em um encadeamento em segundo plano e define uma variável interna para o Identificador de anúncio baseada no valor retornado do Callable.
      Caso queira usar o Identificador de anúncio na Aquisição ou Ciclo de vida, é necessário chamá-lo antes de fazer uma chamada Config.collectLifecycleData .
      • Esta é a sintaxe para este método:
        public static void submitAdvertisingIdentifierTask(final Callable<String> task); 
        
        
      • Esta é a amostra de código para este método:
        @Override
        public void  onResume() {
            super.onResume();
            final  Callable<String>; task = new Callable<String>(){
                @Override
                public String call() throws Exception {
                   AdvertisingIdClient.Info idInfo;
                   String adid = null;
                   Context appContext = CLASSNAME.this.getApplicationContext();
                   try {
                        idInfo = AdvertisingIdClient.getAdvertisingIdInfo(appContext);
                        if (idInfo != null) { 
                            adid = idInfo.getId();
                        } 
                   } catch  (Exception ex) {
                       Log.e("Error",  ex.getLocalizedMessage());
                   }
                   return  adid;
                }
          };
          Config.submitAdvertisingIdentifierTask(task); 
          Config.collectLifecycleData(this);
        }
        
        

Interface do AdobeDataCallback

public interface AdobeDataCallback {  
    void call(MobileDataEvent event, Map<String, Object> contextData);  
} 

MobileDataEvent Enum

public enum MobileDataEvent {  
    MobileDataEvent.MOBILE_EVENT_LIFECYCLE, // triggers on a lifecycle hit  
    MobileDataEvent.MOBILE_EVENT_ACQUISITION_INSTALL, // triggers on a app install that has acquisition data  
    MobileDataEvent.MOBILE_EVENT_ACQUISITION_LAUNCH // triggers on launch when the device previously installed via acquisition  
}