Procedure di aggiornamento di Azure Mobile Engagement SDK per WebAzure Mobile Engagement Web SDK upgrade procedures

Se nell'applicazione Web è già stata integrata una versione precedente di Azure Mobile Engagement SDK per Web, è necessario considerare i seguenti punti quando si aggiorna l'SDK.If you have already integrated an earlier version of the Azure Mobile Engagement Web SDK into your web application, you need to consider the following points when you upgrade the SDK.

Se si sono superate numerose versioni di Mobile Engagement SDK per Web, potrebbe essere necessario completare diverse procedure durante il processo di aggiornamento.If you skipped multiple versions of the Mobile Engagement Web SDK, you might need to complete several procedures during the upgrade process. Ad esempio, se si esegue la migrazione dalla versione 1.4.0 alla 1.6.0, seguire innanzitutto le procedure per l'aggiornamento dalla versione 1.4.0 alla 1.5.0.For example, if you migrate from 1.4.0 to 1.6.0, first follow the procedures to upgrade from 1.4.0 to 1.5.0. Seguire quindi le procedure per l'aggiornamento dalla versione 1.5.0 alla 1.6.0.Then, follow the procedures to upgrade from 1.5.0 to 1.6.0.

Indipendentemente dalla versione dell'aggiornamento, sostituire qualsiasi versione precedente del file azure-engagement.js con la versione più recente dello stesso file.Whichever version you upgrade from, replace any earlier version of the file azure-engagement.js with the latest version of the file.

Aggiornamento da 1.2.1 a 2.0.0Upgrade from 1.2.1 to 2.0.0

Questa sezione illustra come eseguire la migrazione di un'integrazione di Mobile Engagement SDK per Web dal servizio Capptain offerto da Capptain SAS a un'app di Azure Mobile Engagement.This section describes how to migrate a Mobile Engagement Web SDK integration from the Capptain service, offered by Capptain SAS, to an Azure Mobile Engagement app. Se si esegue la migrazione da una versione precedente, visitare il sito Web di Capptain per eseguire prima la migrazione alla versione 1.2.1 e quindi applicare la procedura seguente.If you are migrating from an earlier version, please consult the Capptain website to first migrate to 1.2.1, and then apply the following procedures.

Questa versione di Mobile Engagement SDK per Web non supporta Samsung Smart TV, OperaTV, webOS o la funzionalità Reach.This version of the Mobile Engagement Web SDK doesn't support Samsung Smart TV, Opera TV, webOS, or the Reach feature.

Importante

Capptain e Azure Mobile Engagement non costituiscono lo stesso servizio.Capptain and Azure Mobile Engagement are not the same service. La procedura seguente illustra solo come eseguire la migrazione dell'applicazione client.The following procedure highlights only how to migrate the client app. La migrazione di Mobile Engagement SDK per Web nell'app non comporta la migrazione dei dati dai server di Capptain a un server di Mobile Engagement.Migrating the Mobile Engagement Web SDK in the app will not migrate your data from a Capptain server to a Mobile Engagement server.

File JavaScriptJavaScript files

Sostituire il file capptain-sdk.js con il file azure-engagement.js e aggiornare di conseguenza le importazioni degli script.Replace the file capptain-sdk.js with the file azure-engagement.js, and then update your script imports accordingly.

Rimuovere Capptain ReachRemove Capptain Reach

Questa versione di Mobile Engagement SDK per Web non supporta la funzionalità Reach.This version of the Mobile Engagement Web SDK doesn't support the Reach feature. Se nell'applicazione è integrata la funzione Capptain Reach,rimuoverla.If you integrated Capptain Reach into your application, you need to remove it.

Rimuovere l'importazione di CSS Reach dalla pagina ed eliminare il relativo file con estensione css (per impostazione predefinita, capptain-reach.css).Remove the Reach CSS import from your page and delete the related .css file (capptain-reach.css, by default).

Eliminare le risorse di Reach seguenti: l'immagine di chiusura (per impostazione predefinita, capptain-close.png) e l'icona del marchio (per impostazione predefinita, capptain-notification-icon).Delete the following Reach resources: the close image (capptain-close.png, by default) and the brand icon (capptain-notification-icon, by default).

Rimuovere l'interfaccia utente di Reach per le notifiche in-app.Remove the Reach UI for in-app notifications. Il layout predefinito è simile al seguente:The default layout looks like this:

<!-- capptain notification -->
<div id="capptain_notification_area" class="capptain_category_default">
  <div class="icon">
    <img src="capptain-notification-icon.png" alt="icon" />
  </div>
  <div class="content">
    <div class="title" id="capptain_notification_title"></div>
    <div class="message" id="capptain_notification_message"></div>
  </div>
  <div id="capptain_notification_image"></div>
  <div>
    <button id="capptain_notification_close">Close</button>
  </div>
</div>

Rimuovere l'interfaccia utente di Reach per gli annunci Web, per gli annunci di testo e per i sondaggi.Remove the Reach UI for text and web announcements and polls. Il layout predefinito è simile al seguente:The default layout looks like this:

<div id="capptain_overlay" class="capptain_category_default">
  <button id="capptain_overlay_close">x</button>
  <div id="capptain_overlay_title"></div>
  <div id="capptain_overlay_body"></div>
  <div id="capptain_overlay_poll"></div>
  <div id="capptain_overlay_buttons">
    <button id="capptain_overlay_exit"></button>
    <button id="capptain_overlay_action"></button>
  </div>
</div>

Rimuovere l'oggetto reach dalla configurazione, se esiste.Remove the reach object from your configuration, if it exists. L'aspetto sarà simile al seguente:It looks like this:

window.capptain = {
  [...]
  reach: {
    [...]
  }
}

Rimuovere eventuali altre personalizzazioni di Reach, ad esempio le categorie.Remove any other Reach customization, such as categories.

Rimuovere API deprecateRemove deprecated APIs

Alcune delle API da Capptain sono deprecate in Mobile Engagement SDK per Web.Some APIs from Capptain are deprecated in the Mobile Engagement Web SDK.

Rimuovere eventuali chiamate alle API seguenti: agent.connect, agent.disconnect, agent.pause e agent.sendMessageToDevice.Remove any calls to the following APIs: agent.connect, agent.disconnect, agent.pause, and agent.sendMessageToDevice.

Rimuovere qualsiasi istanza dei callback seguenti dalla configurazione di Capptain: onConnected, onDisconnected, onDeviceMessageReceived e onPushMessageReceived.Remove any instances of the following callbacks from your Capptain configuration: onConnected, onDisconnected, onDeviceMessageReceived, and onPushMessageReceived.

ConfigurazioneConfiguration

Mobile Engagement usa ora una stringa di connessione per configurare gli identificatori dell'SDK, ad esempio l'identificatore dell'applicazione.Mobile Engagement uses a connection string to configure SDK identifiers, for example, the application identifier.

Sostituire l'ID dell'applicazione con la stringa di connessione.Replace the application ID with your connection string. Tenere presente che l'oggetto globale per le modifiche alla configurazione dell'SDK cambia da capptain a azureEngagement.Note that the global object for the SDK configuration changes from capptain to azureEngagement.

Prima della migrazione:Before migration:

window.capptain = {
  appId: ...,
  [...]
};

Dopo la migrazione:After migration:

window.azureEngagement = {
  connectionString: 'Endpoint={appCollection}.{domain};AppId={appId};SdkKey={sdkKey}',
  [...]
};

La stringa di connessione per l'applicazione viene visualizzata nel portale di Azure.The connection string for your application is displayed in the Azure Portal.

API JavaScriptJavaScript APIs

L'oggetto JavaScript globale window.capptain è stato rinominato window.azureEngagement, ma è possibile usare l'alias window.engagement per le chiamate API.The global JavaScript object window.capptain has been renamed window.azureEngagement but you can use the window.engagement alias for API calls. Non è possibile usare l'alias per definire la configurazione dell'SDK.You can't use the alias to define the SDK configuration.

Ad esempio, capptain.deviceId diventa engagement.deviceId, capptain.agent.startActivity diventa engagement.agent.startActivity e così via.For instance, capptain.deviceId becomes engagement.deviceId, capptain.agent.startActivity becomes engagement.agent.startActivity, and so on.