Over the Air (Strings)

Avec le SDK, l'application vérifie régulièrement les traductions mises à jour et les télécharge en arrière-plan.

Vérifiez régulièrement les dernières sorties du SDK Android, en particulier en envisageant des mises à niveau.

Si les traductions ne sont pas mises à jour :

Si la mauvaise version d'une traduction est utilisée, assurez-vous qu'elle est publiée avec les dernières traductions et que la version actuelle de l'application est disponible ainsi que la versionName pour l'application définie et qu'elle utilise le format <Majeure.Mineure.point>..

Exigences

Inclure le SDK

Ajouter un nouveau référentiel à la racine build.gradle :

allprojects {
    repositories {
        ...
        maven { url "https://maven.download.phrase.com" }
    }
}

Ajouter la bibliothèque comme dépendance :

dependencies {
    implementation "com.phrase.android:ota-sdk:3.5.0"
    ...
}

Jetpack Composer le support

Pour activer la prise en charge de Jetpack Compose pour les traductions OTA, procédez comme suit :

Configuration

Initialisez le SDK dans la classe application et ajoutez l'Identifiant de diffusion et le secret d'environnement. Les classes héritant de l'Application devraient remplacer attachBaseContext pour activer les traductions en dehors du contexte d'activité:

public class MainApplication extends Application {
  @Override
  public void onCreate() {
      super.onCreate();
      Phrase.setup(this, "DISTRIBUTION_ID", "ENVIRONMENT_TOKEN");
      Phrase.updateTranslations();
  }

  @Override
  protected void attachBaseContext(Context newBase) {
    super.attachBaseContext(Phrase.wrapApplicationContext(newBase));
  }  
}

J’injecte le SDK dans chaque activité, par exemple en créant une activité de base dont toutes les autres activités héritent :

public class BaseActivity extends AppCompatActivity {
  @NonNull
  @Override
  public AppCompatDelegate getDelegate() {
    return Phrase.getDelegate(this, super.getDelegate());
  }
}

Les traductions peuvent être utilisées comme d'habitude dans les mises en page :

<TextView android:text="@string/translation_key" />

Et le code interne :

TextView text = (TextView) findViewById(R.id.text_id);
text.setText(R.string.translation_key);

Certaines bibliothèques ne prennent pas en charge le déballage automatique du contexte et attendent une classe spécifique. Dans ce cas, l’habillage contextuel des composants Jetpack Compose peut être désactivé avec :

Phrase(contextWrapping = false) {
    Text( text = phraseString(R.string.test) )
}

Configurations pour les niveaux de log :

Modifier langue

Si vous n'utilisez pas la langue système, une langue différente peut être définie dans la méthode setLocaleCode . Le code de langue (paramètres régionaux) doit être présent dans une version.

Phrase.setLocaleCode("fr");
Phrase.updateTranslations();

Version de l'application personnalisée

Le SDK utilise la version de l'application par défaut pour renvoyer une version qui correspond aux contraintes de publication pour les versions min et max. La version de l'application doit utiliser la version sémantique sinon aucune mise à mettre à jour de la traduction n'est renvoyée. Dans le cas où l'application n'utilise pas la version sémantique, il est possible de remplacer manuellement la version de l'application utilisée.

Exemple :

Phrase.setAppVersion("3.2.4");

La version doit être définie avant d'appeler updateTranslations( ).

Définir le délai d'expiration

Le délai d'expiration par défaut pour les téléchargements de traduction est défini sur 10s.

La valeur par défaut peut être modifiée avec :

Phrase.setTimeout(10000); // Timeout in milliseconds

Mettre à jour le rappel

Si la gestion de mises à jour de traduction réussies est nécessaire, joignez un gestionnaire de rappel :

Phrase.updateTranslations(new TranslationsSyncCallback() {
    @Override
    public void onSuccess(boolean translationsChanged) {
    }

    @Override
    public void onFailure() {
    }
});

Les mises à jour de la traduction peuvent également être déclenchées manuellement. Les traductions nouvellement récupérées sont affichées au lancement de l’application Suivante.

Pour rendre les dernières traductions immédiatement disponibles, utilisez la méthode Phrase.applyPendingUpdates(). Cela peut être combiné à l’écoute des mises à jour de la traduction :

Phrase.updateTranslations(new TranslationsSyncCallback() {
    @Override
    public void onSuccess(boolean translationsChanged) {
      if(translationsChanged) {
         Phrase.applyPendingUpdates()
        // Custom logic to refresh UI
      }
    }

    @Override
    public void onFailure() {
    }
});

L'interface utilisateur n'affiche pas automatiquement les traductions et doit être recréée.

Configurer centre de données américain

centre de données américain Phrase est également pris en charge. Le centre de données américain peut être configuré en appelant :

Phrase.setHost("https://ota.us.phrase.com/")

Repli

Dans le cas où il n'est pas possible de joindre Phrase en raison d'une connexion réseau manquante du client ou d'une interruption de service, le SDK utilise les traductions groupées à partir du fichier de ressource. La mise à jour régulière des traductions groupées dans l'application est recommandée. Le SDK met également les traductions en cache localement sur l'appareil. Si un tel cache existe, il est utilisé jusqu'à la Suivant mise à mettre à jour de la traduction.

Le SDK utilise la version la plus récente pour les traductions. Si la versionName de l'application est définie, la version la plus récente qui satisfait aux restrictions de version sera utilisée.

Ajouter une nouvelle langue

Création de la nouvelle langue dans Phrase et créer une nouvelle version. Le SDK va chercher la langue lorsqu'il s'agit de la langue périphérique d'un utilisateur. Il est recommandé d’ajouter régulièrement un nouveau strings.xml pour les nouveaux fichiers de langue lors de la publication d’une nouvelle version de l’application ou les utilisateurs ne verront les traductions de secours déterminées par Android qu’au premier démarrage de l’application.

Audit

Le SDK est source fermée et ne peut pas être consulté ou modifié. Si c'est une exigence de l'organisation, des audits peuvent être fournis. Contactez-nous pour plus de détails si nécessaire.

Assistance en vue personnalisée

Les vues personnalisées peuvent être traduites à l'aide d'attributs de style. TypedArray ne permettant pas d'écraser les ressources, de légères modifications de la vue personnalisée sont nécessaires :

Exemple d'application

https://github.com/phrase/android-sdk-example

Avec le SDK, l'application vérifie régulièrement les traductions mises à jour et les télécharge en arrière-plan.

Exigences

Cette bibliothèque dépend de la version 0.18.0 de la bibliothèque intl de Flutter.Suivez leur guide pour ajouter la prise en charge des localisations à l'application.

Installation

Ajouter Phrase au pubspec.yaml :

dependencies:
  phrase: ^2.5.1 
  ...
  intl: ^0.18.0
  flutter_localizations:
    sdk: flutter
  ...

flutter:
  generate: true
  ...

Comme dans la bibliothèque intl, la génération de code est utilisée pour traiter les fichiers ARB. Exécutez cette commande pour mettre à jour :

flutter pub run phrase

Utilisation de build_runner :

flutter pub run build_runner watch

Utilisation

Initialisez Phrase dans le fichier main.dart :

import 'package:flutter/material.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_gen/gen_l10n/phrase_localizations.dart';
import 'package:phrase/phrase.dart';

void main() {
  Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]");
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      //..
      localisationsDélégués : PhraseLocalizations.localizationsDelegates,
      supportedLocales : PhraseLocalizations.supportedLocales,
    );
  }
}

Accéder aux messages avec :

Text(AppLocalizations.of(context)!.helloWorld);

Personnalisation

Mettre à jour le comportement

Les traductions OTA sont mises à jour à chaque lancement de l'application. Pour désactiver cela :

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", 
    checkForUpdates: false);

À mettre à jour manuellement :

Phrase.updateTranslations(context).then((_) => print("Done!"));

Version de l'application personnalisée

Le SDK utilise la version de l'application par défaut pour renvoyer une version qui correspond aux contraintes de publication pour les versions min et max. La version de l'application doit utiliser la version sémantique sinon aucune mise à mettre à jour de la traduction ne sera renvoyée. Dans le cas où l'application n'utilise pas la version sémantique, la version de l'application peut être manuellement écrasée : il est possible d'écraser manuellement la version de l'application :

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]",
    customAppVersion: "1.2.3");

Configurer centre de données américain

centre de données américain Phrase est également pris en charge. La sélection du centre de données américain peut se faire en passant le paramètre API hostname concerné dans la configuration du SDK :

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", hôte : PhraseHost.us);

Exemple d'application

https://github.com/phrase/flutter_sdk_example

Avec le SDK, l'application vérifie régulièrement les traductions mises à jour et les télécharge en arrière-plan.

Mac Catalyst est également pris en charge.

Le SDK peut être installé manuellement ou via le gestionnaire de paquets Swift, Carthage ou les dosettes de cacao.

Si les traductions ne sont pas mises à jour :

Si la mauvaise version d'une traduction est utilisée, assurez-vous qu'une version contenant les dernières traductions et la version actuelle de l'application est disponible.

Gestionnaire de paquets rapide

Ajoutez l’adresse URL du référentiel public (https://github.com/Phrase/ios-sdk/). Xcode se charge automatiquement du reste de l’installation.

Carthage

Ajoutez la ligne suivante dans votre Cartfile :

binary "https://raw.githubusercontent.com/phrase/ios-sdk/master/PhraseSDK.json" ~> 3.0.0

Lance carthage mise à jour et ajoute le PhraseApp.framework à ton projet comme desribed dans la documentation Carthage.

Doses de cacao

Ajoutez la ligne suivante dans votre Podfile :

pod 'PhraseSDK'

Lancez l’installation de la nacelle. Si vous êtes nouveau sur CocoaPods, consultez leur documentation.

Installation manuelle

Suis les étapes suivantes :

Configuration

Il est recommandé d’appeler les deux fonctions au sein de l’AppDelegate dans la méthode applicationDidFinishLaunchingWithOptions.

Objectif C

Intégrez le SDK dans l’application Objective-C :

@import PhraseSDK;

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  [[Phrase shared] setDebugMode:true]; // Optional

  [[Phrase shared] setupWithDistributionID:@"Your Distribution ID"
                         environmentSecret:@"Your Environment Secret"];

  // OR:
  //
  //  [[Phrase shared] setupWithDistributionID:@"Your Distribution ID"
  //                         environmentSecret:@"Your Environment Secret"
  //                                   timeout:10];

  // Update translations using callback block:
  [[Phrase shared] updateTranslationsWithCompletionHandler:^(BOOL updated, NSError* error){
    NSLog(@"Updated: %@", updated ? @"true" : @"false");

    if (error) {
      NSLog(@"Domain: %@ Code: %ld Message: %@", error.domain, (long)error.code, error.localizedDescription);
    } else {
      NSLog(@"No error");
    }

    // Translate via bundle proxy:
    NSString *translation = NSLocalizedString(@"layouts.application.about", @"");
    NSLog(@"NSLocalizedString via bundle proxy: %@", translation);

    // OR:
    //
    // Translate using fallback method:
    NSString *otherTranslation = [[Phrase shared]
                                  localizedStringForKey:@"layouts.application.about" value:NULL table:NULL];
    NSLog(@"Phrase.shared localizedStringForKey: %@", otherTranslation);
  }];

  // OR:
  //
  // [[Phrase shared] updateTranslationsWithCompletionHandler:NULL]; // ignore result and errors (not recommended)

  // [...] Your other code
  
  return YES;
}

Désactiver le swizzling

Pour désactiver le swizzling, définissez PhraseSDKMainBundleProxyDisabled sur YES dans le fichier Info.plist .

Lorsque le swizzling est désactivé, les traductions mises à jour ne sont plus affichées. La traduction sera toujours synchronisée si updateTranslation est appelée et peut être accédée avec la méthode Phrase.localizedString().

Gestion des versions de l'application

Pour déterminer quelle version doit être renvoyée, le SDK nécessite une version sémantique de l'application afin que les traductions soient mises à jour.

Le SDK essaie d'obtenir une version sémantique de la manière suivante :

Si CFBundleShortVersionString est manquant ou ne peut pas être créé avec une version sémantique associée à CFBundleVersion, le SDK lance le message PhraseSetupError.appVersionNotSemantic.

Désactiver la traduction pour plusieurs tableaux

Pour empêcher OTA de traduire des tableaux du paquet iOS principal autres que le tableau Localizable par défaut, définissez l'option suivante :

Phrase.shared.configuration.ignoreOtherTables = true

Rappels

Joindre un gestionnaire de rappel pour gérer les mises à jour de traduction réussies :

Phrase.shared.updateTranslation { result in
            switch result {
            case .success(let updated):
            case .failure:
            }
        }

Debug mode

Si des informations complémentaires sont nécessaires, activez le mode Debug pour obtenir une connexion supplémentaire du PhraseSDK.framework à la console:

Phrase.shared.configuration.debugMode = true

Définir le délai d'expiration pour les demandes

Définissez un délai d'expiration pour les demandes contre Phrase en appelant :

Phrase.shared.configuration.timeout = TimeInterval(20)

Le délai par défaut est de 10 secondes et les connexions prenant plus de 10 secondes seront fermées.

Prise en charge manuelle de la langue

Si vous n'utilisez pas la langue système comme paramètres régionaux, un paramètre régional différent peut être défini dans l'appel d'initialisation. Le code des paramètres régionaux doit être présent dans une version de phrase:

Phrase.shared.configuration.localeOverride = "en-US"

Repli

Dans le cas où il est impossible de récupérer de nouvelles traductions depuis Phrase via le SDK, les derniers fichiers de traduction reçus par l’installation sont utilisés. Si l’application n’a jamais reçu de nouveaux fichiers de Phrase, elle utilise les fichiers de traduction compilés de l’application. Cela permet d’éviter les erreurs en cas de difficultés techniques ou d’erreurs de mise en réseau. Il est recommandé de maintenir à jour vos fichiers de traduction compilés dans l’application à chaque publication.

Audit

Le SDK est source fermée et ne peut pas être consulté ou modifié. Si c'est une exigence de l'organisation, des audits peuvent être fournis. Contactez-nous pour plus de détails si nécessaire.

Avec le SDK, l'application vérifie régulièrement les traductions mises à jour et les télécharge en arrière-plan.

La bibliothèque pour les traductions OTA ne fonctionne qu'avec la bibliothèque react-i18next .

Pour installer le SDK React Native, procédez comme suit :

Exemple de fichier i18next.js

import i18n from "i18next";
import { initReactI18next } from "react-i18next";
import ChainedBackend from "i18next-chained-backend";
import resourcesToBackend from "i18next-resources-to-backend";
import translationEN from "./locales/en/translation.json";
import translationRU from "./locales/ru/translation.json";
import Phrase from "react-native-phrase-sdk";

const localResources = {
  en: {
    translation: translationEN,
  },
  ru: {
    translation: translationRU,
  },
};

let phrase = new Phrase(
    "YOUR_DISTRIBUTION_ID",
    "YOUR_ENVIRONMENT_ID",
    require('./package.json').version,
    "i18next"
);

const backendPhrase = resourcesToBackend((language, namespace, callback) => {
    phrase.requestTranslation(language)
        .then((remoteResources) => {
            callback(null, remoteResources);
        })
        .catch((error) => {
            callback(error, null);
        });
});

const backendFallback = resourcesToBackend(localResources)

i18n
  .use(ChainedBackend)
  .use(initReactI18next)
  .init({
    backend: {
        backends: [backendPhrase, backendFallback]
    },
    debug: true,
    lng: "en",
    fallbackLng: "en",
    interpolation: {
      escapeValue: false, // not needed for react as it escapes by default
    }
  });

Exemple d'application

https://github.com/phrase/react_native_sdk_example

La bibliothèque i18next Phrase backend implémente un exemple de backend pour i18next qui récupère les traductions des versions OTA.

Pour créer une nouvelle version, la plateforme i18next doit être configurée pour la diffusion et faire partie d'une version.

Utilisation

Pour initialiser phrase:

import i18n from "i18next";
import { I18nextPhraseBackend } from "@phrase/i18next-backend";

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      Diffusion : 'DISTRIBUTION_ID',
      secret : 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0', '1.0.0',
    }
  });

Mise en cache

La bibliothèque met les traductions en cache et ne vérifiera pas les nouvelles traductions pendant 5 minutes. La mise en cache peut être configurée en définissant l'option cacheExpirationTime dans la configuration backend à des fins de test.

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      Diffusion : 'DISTRIBUTION_ID',
      secret : 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0', '1.0.0',
      cacheExpirationTime : 60 * 5, // temps en secondes
    }
  });

Exemple d'application

https://github.com/phrase/ota-web-demo

La bibliothèque Phrase-ota-i18n implémente un exemple de backend pour la gemme I18n qui récupère les traductions des versions OTA. Avec la bibliothèque, l'application vérifie régulièrement les traductions mises à jour et les télécharge en arrière-plan.

La bibliothèque est valide pour toute application Ruby utilisant la gemme i18n.

Pour créer une nouvelle version, la plateforme Rails doit être configurée pour la diffusion et faire partie d ' une version.

Installation

Utilisation

Pour générer la configuration :

bundle exec rails generate phrase_ota:install --distribution-id <DISTRIBUTION_ID> --secret-token <SECRET>

Débogage

La gemme a une configuration Debug qui peut être activée dans l'initialiseur en définissant :

config.debug = true