Métodos do SDK

Classes e métodos fornecidos pela biblioteca da loja de aplicativos universal do Windows 8.1.

DICA

Ao consumir métodos winmd do winJS (JavaScript), todos os métodos passam a ter a primeira letra em minúsculas automaticamente.

  • GetVersion (winJS: getVersion)

    Retorna a versão atual da biblioteca do Adobe Mobile.

    • Esta é a sintaxe para este método:

      static Platform::String ^GetVersion();
      
    • Esta é a amostra de código para este método:

      varADB = ADBMobile;var libVersion = ADB.Config.getVersion(); 
      
  • GetPrivacyStatusAsync (winJS: getPrivacyStatusAsync)

    Retorna a representação de enumeração do status de privacidade do usuário atual.

    • ADBMobilePrivacyStatusOptIn - as ocorrências são enviadas imediatamente.

    • ADBMobilePrivacyStatusOptOut - as ocorrências serão descartadas.

    • ADBMobilePrivacyStatusUnknown - Se o conjunto de relatórios estiver habilitado para mostrar o carimbo de data e hora, as ocorrências serão salvas até o status de privacidade ser alterado para aceitar (e então as ocorrências são enviadas) ou rejeitar (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 config.

    • Esta é a sintaxe para este método:

      static Windows::Foundation::IAsyncOperation<ADBMobilePrivacyStatus> ^getPrivacyStatusAsync(); 
      
    • Estas são as amostras de código para este método:

      public enum class ADBMobilePrivacyStatus : int  {
        ADBMobilePrivacyStatusOptIn = 1, 
        ADBMobilePrivacyStatusOptOut =  2,
        ADBMobilePrivacyStatusUnknown = 3
      };
      
      var ADB = ADBMobile;
      var status;
      ADB.Config.getPrivacyStatusAsync.then(function(privacyStatus) {
      status = privacyStatus;
      }); 
      
  • SetPrivacyStatus (winJS: setPrivacyStatus)

    Define o de privacidade do usuário atual como status status. É definido como um dos valores abaixo:

    • ADBMobilePrivacyStatusOptIn - as ocorrências são enviadas imediatamente.

    • ADBMobilePrivacyStatusOptOut - as ocorrências serão descartadas.

    • ADBMobilePrivacyStatusUnknown - Se o conjunto de relatórios estiver habilitado para mostrar o carimbo de data e hora, as ocorrências serão salvas até o status de privacidade ser alterado para aceitar (e então as ocorrências são enviadas) ou rejeitar (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:

      static void SetPrivacyStatus(ADBMobilePrivacyStatus status);
      
    • Esta é a amostra de código para este método:

      public enum class ADBMobilePrivacyStatus : int {
        ADBMobilePrivacyStatusOptIn = 1,
        ADBMobilePrivacyStatusOptOut = 2,
        ADBMobilePrivacyStatusUnknown = 3
        }; 
      
      var ADB = ADBMobile;
      ADB.Config.setPrivacyStatus(ADB.ADBMobilePrivacyStatus.adbmobilePrivacyStatusOptIn); 
      
  • GetLifetimeValue (winJS: getLifetimeValue)

    Retorna o valor do tempo de vida do usuário atual. O padrão é 0.

    • Esta é a sintaxe para este método:

      static float GetLifetimeValue();
      
    • Esta é a amostra de código para este método:

       var ADB = ADBMobile;
       var ltv = ADB.Config.getLifetimeValue(); 
      
  • GetUserIdentifier (winJS: getUserIdentifier)

    Retorna o identificador do usuário personalizado se algum identificador personalizado estiver configurado. Retorna null se um identificador personalizado não estiver configurado. O valor padrão é null.

    DICA

    Se seu aplicativo for atualizado do SDK 3.x do Experience Cloud para o 4.x, a ID anterior (personalizada ou gerada automaticamente) será recuperada e armazenada como o identificador de usuário personalizado. Isso preserva os dados do visitante entre as atualizações de SDK. Para novas instalações no SDK 4.x, o identificador do usuário é null até que seja definido.

    • Esta é a sintaxe para este método:

      static Platform::String^GetUserIdentifier();
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      var userId = ADB.Config.getUserIdentifier(); 
      
  • SetUserIdentifier (winJS: setUserIdentifier)

    Define o identificador do usuário para identifier.

    • Esta é a sintaxe para este método:

      static void SetUserIdentifier(Platform::String ^userIdentifier);
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      ADB.Config.setUserIdentifier("someUserId"); 
      
  • GetDebugLogging (winJS: getDebugLogging)

    Retorna a preferência de log para a depuração atual. O valor padrão é false.

    • Esta é a sintaxe para este método:

      static bool GetDebugLogging(); 
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      var logging = ADB.Config.getDebugLogging(); 
      
  • SetDebugLogging (winJS: setDebugLogging)

    Define a preferência do log de depuração como debugLogging. O log de depuração funciona somente ao usar a versão de depuração da biblioteca, a versão de lançamento ignora essa configuração.

    • Esta é a sintaxe para este método:

      static void SetDebugLogging(bool debugLogging); 
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      ADB.Config.setDebugLogging(true); 
      
  • CollectLifecycleData (winJS: 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.

    DICA

    Chame esse método no método onResume() em cada Atividade dentro do aplicativo, conforme mostrado no exemplo a seguir. Também recomendamos transmitir a Atividade ou o Serviço como o objeto de contexto em vez do contexto de Aplicativo global.

    • Esta é a sintaxe para este método:

      static void CollectLifecycleData();
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      ADB.Config.collectLifecycleData(); 
      
  • PauseCollecting ​ LifecycleData (winJS: pauseCollecting ​ LifecycleData)

    Indica ao SDK que o aplicativo está pausado, a fim de calcular corretamente as medições de ciclo de vida. Por exemplo, ao pausar, um carimbo de data e hora é coletado 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.

    DICA

    Chame esse método nos métodos onPause() em cada Atividade dentro do aplicativo, conforme mostrado no exemplo. Também recomendamos transmitir a Atividade ou o Serviço como o objeto de contexto em vez do contexto de Aplicativo global.

    • Esta é a sintaxe para este método:

      static void PauseCollectingLifecycleData();
      
    • Esta é a amostra de código para este método:

      var ADB = ADBMobile;
      ADB.Config.pauseCollectingLifecycleData();
      

Nesta página