Show Menu
SUJETS×

Android methods

Méthodes Android pour les composants Xamarin pour le SDK 4.x des solutions Experience Cloud.

Configuration methods

  • DebugLogging
    Returns the current debug logging preference, and the default is false.
    • Voici la syntaxe de cette méthode :
      public static Boolean DebugLogging;
      
      
    • Voici l’exemple de code pour cette méthode :
      getter: var debuglog = Config.DebugLogging;
      setter: Config.DebugLogging = (Java.Lang.Boolean)true;
      
      
  • LifetimeValue
    Renvoie la valeur du cycle de vie de l’utilisateur actuel.
    • Voici la syntaxe de cette méthode :
      public static BigDecimal LifetimeValue; 
      
      
    • Voici l’exemple de code pour cette méthode :
       var lifetimeValue = Config.LifetimeValue;
      
      
  • PrivacyStatus
    Renvoie la représentation d’énumération de l’état de confidentialité pour l’utilisateur actuel.
    • ADBMobilePrivacyStatus.OptIn - les accès sont envoyés immédiatement.
    • ADBMobilePrivacyStatus.OptOut - les accès sont ignorés.
    • ADBMobilePrivacyStatus.Unknown  : si le suivi hors ligne est activé, les accès sont enregistrés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (les accès sont envoyés) ou sur exclusion (les accès sont ignorés). Si le suivi hors ligne n’est pas activé, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (opt-in). La valeur par défaut est définie dans le fichier ADBMobileConfig.json .
    • Voici la syntaxe de cette méthode :
      public static MobilePrivacyStatus PrivacyStatus; 
      
      
    • Voici l’exemple de code pour cette méthode :
      getter: var privacyStatus = Config.PrivacyStatus; 
      setter: Config.PrivacyStatus = MobilePrivacyStatus.MobilePrivacyStatusUnknown;
      
      
  • UserIdentifier
    If a custom identifier has been set, returns this identifier. Si aucun identifiant personnalisé n’est défini, renvoie null. La valeur par défaut est null .
    • Voici la syntaxe de cette méthode :
      public static UserIdentifier();
      
      
    • Voici l’exemple de code pour cette méthode :
      getter: var userId = Config.UserIdentifier;
      setter: Config.UserIdentifier = "imBatman";
      
      
  • Version
    Obtient la version de la bibliothèque.
    • Voici la syntaxe de cette méthode :
      public static string Version;
      
      
    • Voici l’exemple de code pour cette méthode :
      var version = ADBMobile.Version;
      
      
  • PauseCollectingLifecycleData
    Indique au SDK que l’application est suspendue, de sorte que les mesures de cycle de vie sont correctement calculées. Par exemple, en cas de suspension, collecte un horodatage afin de déterminer la durée de la session précédente. Ceci définit également un indicateur de sorte que le cycle de vie sache correctement que l’application n’a pas planté. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void PauseCollectingLifecycleData (); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.PauseCollectingLifecycleData();
      
      
  • CollectLifecycleData (activité Activity)
    (4.2 ou version ultérieure) Indique au SDK que les données du cycle de vie doivent être collectées pour être utilisées à l’échelle de toutes les solutions dans le SDK. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void collectLifecycleData(Activity activity); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.CollectLifecycleData (this);
      
      
  • CollectLifecycleData (activité Activity)
    (4.2 ou version ultérieure) Indique au SDK que les données du cycle de vie doivent être collectées pour être utilisées à l’échelle de toutes les solutions dans le SDK. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void collectLifecycleData(Activity activity, IDictionary<string, Object> context));
      
      
    • Voici l’exemple de code pour cette méthode :
      IDictionary<string, Java.Lang.Object> context = new Dictionary<string, 
      Java.Lang.Object> ();
      context.Add ("key", "value");
      Config.CollectLifecycleData (this, context);
      
      
  • OverrideConfigStream
    (4.2 or later) Lets you load a different ADBMobile JSON config file when the application starts. Cette autre configuration est utilisée jusqu’à la fermeture de l’application.
    • Voici la syntaxe de cette méthode :
      public static void OverrideConfigStream (Stream stream);
      
      
    • Voici l’exemple de code pour cette méthode :
      Stream st1 = Assets.Open ("ADBMobileConfig-2.json"); 
      Config.OverrideConfigStream (st1); 
      
      
  • SetLargeIconResourceId(int resourceId)
    (4.2 or later) Sets the large icon that is used for notifications created by the SDK. Cette icône est l’image principale qui s’affiche lorsque l’utilisateur voit la notification complète dans le centre de notification.
    • Voici la syntaxe de cette méthode :
      public static void SetLargeIconResourceId( int resourceId);
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.SetLargeIconResourceId(R.drawable.appIcon);
      
      
  • SetSmallIconResourceId(int resourceId)
    (4.2 ou version ultérieure) Définit la petite icône utilisée pour les notifications créées par le SDK. This icon displays in the status bar and is the secondary image shown when the user sees the complete notification in the notification center.
    • Voici la syntaxe de cette méthode :
      public static void SetSmallIconResourceId( int resourceId); 
      
      
    • Voici l’exemple de code pour cette méthode :
       Config.SetSmallIconResourceId(R.drawable.appIcon);
      
      

Analytics methods

  • TrackingIdentifier
    Renvoie l’identifiant automatiquement généré pour Analytics. Il s’agit d’un identifiant unique spécifique à l’application qui est généré au lancement initial et stocké et utilisé à partir de ce moment. Cet ID est conservé entre les mises à niveau de l’application et supprimé lors de la désinstallation.
    • Voici la syntaxe de cette méthode :
      public static string TrackingIdentifier;
      
      
    • Voici l’exemple de code pour cette méthode :
      Var trackingId = Analytics.TrackingIdentifier
      
      
  • TrackState
    Contrôle l’état d’une application avec les données contextuelles facultatives. States sont les vues disponibles dans l’application, par exemple « écran de titre », « niveau 1 », « pause », etc. Ces états sont semblables aux pages d’un site web ; les appels TrackState incrémentent les pages vues. Si l’état est vide, il est présenté comme « nom d’application version d’application (compilation) » dans les rapports. Si vous voyez cette valeur dans les rapports, veillez à définir state dans chaque appel TrackState .
    Il s’agit du seul appel de suivi qui incrémente les pages vues.
    • Voici la syntaxe de cette méthode :
      public static void TrackState (string state, IDictionary<string, Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var cdata = new Dictionary<string, Java.Lang.Object>(); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackState ("stateName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
      
  • TrackAction
    Effectue le suivi d’une action dans l’application. Les actions sont les événements qui se produisent dans l’application et que vous souhaitez mesurer, par exemple « décès », « niveau atteint », « abonnements aux flux » et autres mesures.
    If you have code that might run while the app is in the background (for example, a background data retrieval), use trackActionFromBackground instead.
    • Voici la syntaxe de cette méthode :
      public static void TrackAction(string action, IDictionary<string,Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var cdata = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value");
      Analytics.TrackAction ("actionName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
      
  • TrackLocation
    Envoie les coordonnées de latitude et de longitude actuelles. Also uses points of interest defined in the ADBMobileConfig.json file to determine whether the location that was provided as a parameter is in any of your POIs. Si les coordonnées actuelles se trouvent dans un point ciblé défini, une variable de données contextuelles est renseignée et envoyée avec l’appel TrackLocation .
    • Voici la syntaxe de cette méthode :
      public static void TrackLocation(Location location, IDictionary<string, Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
       Location loc = new Location(LocationManager.GpsProvider);;
       loc.Latitude = 111; 
       loc.Longitude = 44; 
       loc.Accuracy = 5; 
       Analytics.TrackLocation (loc, null);
      
      
  • TrackBeacon
    Effectue un suivi quand un utilisateur entre à proximité d’une balise.
    • Voici la syntaxe de cette méthode :
      public static void TrackBeacon (string uuid, string major, string minor,  Analytics.BEACON_PROXIMITY prox, IDictionary<string, Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.TrackBeacon ("UUID", "1", "2", 
      Analytics.BEACON_PROXIMITY.ProximityImmediate, null); 
      
      
  • ClearBeacon
    Efface les données de balise une fois qu’un utilisateur n’est plus à proximité de la balise.
    • Voici la syntaxe de cette méthode :
      public static void TrackingClearCurrentBeacon();
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.ClearBeacon(); 
      
      
  • TrackLifetimeValueIncrease
    Ajoute une quantité à la valeur de durée de vie de l’utilisateur.
    • Voici la syntaxe de cette méthode :
      public static void TrackLifetimeValueIncrease (double amount, IDictionary<string,Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.TrackLifetimeValueIncrease(5,null);
      
      
  • TrackTimedActionStart
    Commence une action minutée par l’action du nom. Si vous appelez cette méthode pour une action qui a déjà commencé, l’action minutée précédente est écrasée.
    Cet appel n’envoie pas d’accès.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionStart(string action,IDictionary<string, Object> cdata); 
      
      
    • Here is code sample for this method:
      Analytics.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    Transmet des données afin de mettre à jour les données contextuelles associées à l’action donnée. Les données transmises sont annexées aux données existantes pour l’action donnée et remplacent les données si la même clé est déjà définie pour l’action.
    Cet appel n’envoie pas d’accès.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionUpdate(string action, IDictionary<string, Object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var updatedData = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackTimedActionUpdate("level2", updatedData); 
      
      
  • TrackTimedActionEnd
    Termine une action minutée.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionEnd(string action,
        Analytics.ITimedActionBlock block);
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.TrackTimedActionEnd ("level2", new TimedActionBlock()); 
           class TimedActionBlock: Java.Lang.Object, 
      Analytics.ITimedActionBlock{ 
           public Java.Lang.Object Call (long inAppDuration, long 
      totalDuration IDictionary<string, Java.Lang.Object> contextData){ 
           return Java.Lang.Boolean.True; 
        } 
      }
      
      
  • TrackingTimedActionExists
    Renvoie si une action minutée est ou non en cours.
    • Voici la syntaxe de cette méthode :
      public static bool TrackingTimedActionExists(string action); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var level2InProgress = Analytics.TrackingTimedActionExists("level2"); 
      
      
  • SendQueuedHits
    Force la bibliothèque à envoyer tous les accès dans la file d’attente hors ligne, quel que soit le nombre d’accès en file d’attente.
    • Voici la syntaxe de cette méthode :
      public static void SendQueuedHits();
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.SendQueuedHits(); 
      
      
  • ClearQueue
    Efface tous les accès de la file d’attente hors ligne.
    • Voici la syntaxe de cette méthode :
      public static void ClearQueue(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Analytics.ClearQueue(); 
      
      
  • QueueSize
    Récupère le nombre d’accès actuellement dans la file d’attente hors ligne.
    • Voici la syntaxe de cette méthode :
      public static long QueueSize(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var queueSize = Analytics.QueueSize();
      
      

Experience Cloud ID methods

  • MarketingCloudId
    Récupère l’Experience Cloud ID du service d’identification.
    • Voici la syntaxe de cette méthode :
      public static string MarketingCloudId;
      
      
    • Voici l’exemple de code pour cette méthode :
      var mcid = Visitor.MarketingCloudId;
      
      
  • SyncIdentifiers
    Avec l’identifiant Experience Cloud, vous pouvez définir d’autres identifiants de client à associer à chaque visiteur. L’API visiteur accepte plusieurs identifiants de client pour le même visiteur, ainsi qu’un identifiant de type Client, afin de séparer la portée des différents identifiants de client. Cette méthode correspond aux identifiants setCustomerIDs dans la bibliothèque JavaScript.
    • Voici la syntaxe de cette méthode :
      public static void SyncIdentifiers((IDictionary<string> identifiers);
      
      
    • Voici l’exemple de code pour cette méthode :
      IDictionary<string,string> ids = new Dictionary<string, string> ();
      ids.Add ("pushID", ;"value2");
      Visitor.SyncIdentifiers (ids);
      
      

Méthodes Target

  • LoadRequest
    Sends a request to your configured Target server and returns the string value of the offer generated in a Action<NSDictionary> callback.
    • Voici la syntaxe de cette méthode :
      public static void LoadRequest (TargetLocationRequest request, Target.ITargetCallback callback); 
      
      
    • Voici l’exemple de code pour cette méthode :
      class TargetBlock: Java.Lang.Object, Target.ITargetCallback{ 
          public void Call (Java.Lang.Object content) 
         { 
          Console.WriteLine (content.ToString()); 
         } 
      } 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
           Target.LoadRequest (req, new TargetBlock()); 
      
      
  • CreateRequest
    Constructeur de commodité permettant de créer un objet ADBTargetLocationRequest avec les paramètres donnés.
    • Voici la syntaxe de cette méthode :
      public static TargetLocationRequest TargetCreateRequest(string name,string defaultContent,IDictionary<string,string> parameters); 
      
      
    • Voici l’exemple de code pour cette méthode :
      IDictionary<string, Java.Lang.Object> parameters = new Dictionary> string, Java.Lang.Object> (); 
          parameters.Add ("key1", "value2"); 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
      
      
  • CreateOrderConfirmRequest
    Creates an ADBTargetLocationRequest .
    • Voici la syntaxe de cette méthode :
      public static TargetLocationRequest TargetCreateRequest (string name, string defaultContent, IDictionary<;string, string> parameters);
      
      
    • Voici l’exemple de code pour cette méthode :
      var orderConfirm = Target.CreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
      
  • ClearCookies
    Clears Target cookies from your app.
    • Voici la syntaxe de cette méthode :
      public static void ClearCookies(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Target.ClearCookies (); 
      
      

Audience Manager

  • VisitorProfile
    Renvoie le dernier profil du visiteur obtenu. Renvoie nul si aucun signal n’a encore été envoyé. Le profil du visiteur est enregistré dans NSUserDefaults pour un accès facile à l’échelle de plusieurs lancements de votre application.
    • Voici la syntaxe de cette méthode :
      public static IDictionary<string, Object> VisitorProfile; 
      
      
    • Voici l’exemple de code pour cette méthode :
      NSDictionary profile = AudienceManager.VisitorProfile; 
      
      
  • Dpid
    Returns the current DPID .
    • Voici la syntaxe de cette méthode :
      public static string Dpuuid; 
      
      
    • Voici l’exemple de code pour cette méthode :
      string currentDpid = AudienceManager.Dpid;
      
      
  • Dpuuid
    Returns the current DPUUID .
    • Voici la syntaxe de cette méthode :
      public static string AudienceDpuuid; 
      
      
    • Voici l’exemple de code pour cette méthode :
      string currentDpuuid = AudienceManager.Dpuuid;
      
      
  • AudienceSetDpidAndDpuuid
    Sets the and . dpid``dpuuid If dpid and dpuuid are set, they are sent with each signal.
    • Voici la syntaxe de cette méthode :
      public static void AudienceSetDpidAndDpuuid (string Dpid, String Dpuuid);
      
      
    • Voici l’exemple de code pour cette méthode :
      AudienceManager.SetDpidAndDpuuid ("testDpid", "testDpuuid");
      
      
  • SignalWithData
    Sends audience management a signal with traits and get the matching segments returned in a Action<NSDictionary> callback.
    • Voici la syntaxe de cette méthode :
      public static void SignalWithData (IDictionary<string, Object> audienceData, AudienceManager.IAudienceManagerCallback callback); 
      
      
    • Voici l’exemple de code pour cette méthode :
      class AudienceManagerCallback: Java.Lang.Object, 
       AudienceManager.IAudienceManagerCallback{ 
         public void Call (Java.Lang.Object content) 
        {
          Console.WriteLine (content.ToString()); 
        }
      }
      IDictionary<string, Java.Lang.Object> traits = new Dictionary<string, 
      Java.Lang.Object> (); 
         traits.Add ("trait", "b");
      AudienceManager.SignalWithData (traits, new AudienceManagerCallback());
      
      
  • Réinitialiser
    Réinitialise l’ UUID du gestionnaire d’audience et purge le profil du visiteur en cours.
    • Voici la syntaxe de cette méthode :
      public static void Reset ();
      
      
    • Voici l’exemple de code pour cette méthode :
       AudienceManager.Reset ();
      
      

Vidéo

For more information about Video Analytics, see Video Analytics. Chemin
  • MediaSettings
    Renvoie un objet MediaSettings avec les paramètres spécifiés.
    • Voici la syntaxe de cette méthode :
      public static MediaSettings SettingsWith (string name, double length, string playerName, string playerID);  
      
      
    • Voici l’exemple de code pour cette méthode :
      MediaSettings settings = Media.SettingsWith("name1", 10, "playerName1", "playerID1");
      
      
  • AdSettingsWith
    Renvoie un objet MediaSettings à utiliser pour le suivi d’une vidéo publicitaire.
    • Voici la syntaxe de cette méthode :
      public static MediaSettings AdSettingsWith ( string name, double length, 
        string playerName, string parentName, string parentPod, 
      double parentPodPosition, string CPM); 
      
      
    • Voici l’exemple de code pour cette méthode :
      MediaSettings adSettings = Media.AdSettingsWith ("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1"); 
      
      
  • Open (Ouvrir)
    Ouvre un objet ADBMediaSettings pour le suivi.
    • Voici la syntaxe de cette méthode :
      public static void Open (MediaSettings settings, Media.IMediaCallback callback);
      
      
    • Voici l’exemple de code pour cette méthode :
      MediaSettings settings = Media.SettingsWith ("name1", 10, "playerName1", "playerID1"); 
         Media.Open (settings, new MediaCallback()); 
         class MediaCallback: Java.Lang.Object, Media.IMediaCallback{ 
      public void Call (Java.Lang.Object content) 
      {
      }
      }
      
      
  • Fermer
    Ferme le nom nommé de l’élément multimédia.
    • Voici la syntaxe de cette méthode :
      public static void Close(string name);
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Close (settings.Name); 
      
      
  • Lire
    Lit le nom nommé de l’élément multimédia au décalage donné (en secondes).
    • Voici la syntaxe de cette méthode :
      public static void Play ( string name, double offset); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Play (settings.Name, 0); 
      
      
  • Complete
    Marque manuellement l’élément multimédia comme terminé au décalage donné (en secondes).
    • Voici la syntaxe de cette méthode :
      public static void Complete (string name, double offset); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Complete (settings.Name, 5); 
      
      
  • Stop
    Avertit le module multimédia que la vidéo a été interrompue ou suspendue au décalage donné.
    • Voici la syntaxe de cette méthode :
      public static void Stop ( string name, double offset); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Stop (settings.Name, 3);
      
      
  • Cliquez sur
    Avertit le module multimédia qu’un utilisateur a cliqué sur l’élément multimédia.
    • Voici la syntaxe de cette méthode :
      public static void Click ( string name, double offset); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Click (settings.Name, 3); 
      
      
  • Piste
    Envoie un appel d’action de suivi (aucune page vue) pour l’état multimédia en cours.
    • Voici la syntaxe de cette méthode :
      public static void Track ( string name, NSDictionary data); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Media.Track (settings.Name, null);