Over the Air (Strings)

Con el SDK, la aplicación comprueba regularmente si hay traducciones actualizadas y las descarga en segundo plano.

Revisa regularmente las últimas versiones del SDK de Android, especialmente teniendo en cuenta las actualizaciones.

Si las traducciones no se están actualizando:

Si se está utilizando la versión incorrecta de una traducción, asegúrate de que haya un lanzamiento con las traducciones más recientes, que la versión actual de la aplicación esté disponible y que se haya establecido el versionName para la aplicación y que estás utilizando el formato <Grave. Menor.point>.

Requisitos

Incluir el SDK

Agregar un nuevo repositorio al root build.gradle:

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

Agregar la biblioteca como dependencia:

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

Jetpack Soporte técnico para Compose

Para habilitar la compatibilidad de Jetpack Compose con traducciones OTA, sigue estos pasos:

Configuración

Inicialice el SDK en la clase de aplicación y agregue el ID de distribución y el secreto de entorno. Las clases que heredan de Application deben sobrescribir adtachBaseContext para habilitar traducciones fuera del contexto de actividad:

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));
  }  
}

Inyecto el SDK en cada actividad, por ejemplo creando una actividad base de la que hereden todas las demás actividades:

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

Las traducciones se pueden utilizar como de costumbre en los diseños:

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

Y dentro del código:

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

Algunas bibliotecas no admiten desenvolver automáticamente el contexto y esperan una clase específica. En este caso, la envoltura de contexto en los componentes Jetpack Compose se puede deshabilitar con:

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

Configuraciones para niveles de registro:

Cambiar idioma

Si no se utiliza el idioma del sistema, se puede establecer un idioma diferente en el método setLocaleCode. El código de idioma (localización) debe estar presente en un comunicado.

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

Versión personalizada app

El SDK usa la versión de la aplicación de forma predeterminada para devolver una versión que coincide con las restricciones de versión para las versiones mínima y máxima. La versión de la aplicación debe usar versión semántica, de lo contrario no se devolverá ninguna actualización. En caso de que la aplicación no use versionado semántico, es posible anular manualmente la versión de la aplicación usada.

Ejemplo:

Phrase.setAppVersion("3.2.4");

La versión debe establecerse antes de llamar actualizationTranslations( ).

Establecer tiempo de espera

El tiempo de espera predeterminado para las descargas de traducción está establecido en 10 s.

El valor predeterminado se puede cambiar con:

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

Actualizar rellamada

Si se requiere la gestión de actualizaciones de traducción exitosas, adjunta un controlador de rellamada:

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

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

Las actualizaciones de traducción también se pueden activar manualmente. Las traducciones recién obtenidas se muestran en el Siguiente lanzamiento de la aplicación.

Para que las últimas traducciones estén disponibles de inmediato, usa el método Phrase.applyPendingUpdates(). Esto se puede combinar con la escucha de actualizaciones de traducción:

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

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

La IU no muestra las traducciones automáticamente y debe volver a crearse.

Configurar centro de datos estadounidense

También se admite phrase US centro de datos. El centro de datos estadounidense se puede configurar llamando a:

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

Fallback

En caso de que no sea posible llegar a phrase debido a que falta una conexión de red del cliente o a una interrupción del servicio, el SDK utiliza las traducciones incluidas en el archivo de recursos. Se recomienda actualizar periódicamente las traducciones incluidas en la aplicación. El SDK también almacena en caché las traducciones locales en el dispositivo. Si dicha caché existe, se utiliza hasta la Siguiente actualización.

El SDK utiliza la versión más reciente para las traducciones. En caso de que se establezca el versionName para la aplicación, se utilizará la versión más reciente que cumpla con las restricciones de versión.

Agregar un nuevo idioma

Creando el nuevo idioma en phrase y crear una nueva versión. El SDK obtiene el idioma cuando este es el idioma del dispositivo de un usuario. Se recomienda agregar regularmente un nuevo strings.xml para los archivos de idiomas nuevos al lanzar una nueva versión de la aplicación o los usuarios solo verán las traducciones alternativas determinadas por Android al principio de la aplicación.

Auditoría

El SDK es fuente cerrado y no se puede ver ni modificar. Si es un requisito de la organización, se pueden proporcionar auditorías. Contáctanos para más detalles si es necesario.

Soporte para la vista personalizada

Las vistas personalizadas se pueden traducir utilizando atributos de estilo. Dado que TypedArray no permite sobrescribir los recursos, se requieren ligeros cambios en la vista personalizada:

Aplicación de ejemplo

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

Con el SDK, la aplicación comprueba regularmente si hay traducciones actualizadas y las descarga en segundo plano.

Requisitos

Esta biblioteca depende de la versión 0.18.0 de la biblioteca intl de Flutter.Sigue su guía para agregar soporte de localizaciones a la aplicación.

Instalación

Agregar phrase a pubspec.yaml:

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

flutter:
  generate: true
  ...

Como en la biblioteca intl, la generación de código se usa para procesar archivos ARB. Ejecuta este comando para actualizar:

flutter pub run phrase

Usando build_runner:

flutter pub run build_runner watch

Uso

Abre phrase en el archivo 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: «Demostración completa»,
      //..
      localizacionesDelegados: PhraseLocalizations.localizationsDelegates,
      supportedLocales: PhraseLocalizations.supportedLocales,
    );
  }
}

Acceder mensajes con:

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

Personalización

Actualizar comportamiento

Las traducciones OTA se actualizan cada vez que se lanza la aplicación. Para deshabilitar esto:

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

Para actualizar manualmente:

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

Versión personalizada app

El SDK usa la versión de la aplicación de forma predeterminada para devolver una versión que coincide con las restricciones de versión para las versiones mínima y máxima. La versión de la aplicación debe usar versión semántica, de lo contrario no se devolverá ninguna actualización. En caso de que la aplicación no use versionado semántico, se puede anular manualmente la versión de la aplicación: es posible anular manualmente la versión de la aplicación:

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

Configurar centro de datos estadounidense

También se admite phrase US centro de datos. El centro de datos estadounidense se puede seleccionar pasando el parámetro API hostname pertinente en la configuración del SDK:

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", host: PhraseHost.us);

Aplicación de ejemplo

https://github.com/phrase/flutter_sdk_example

Con el SDK, la aplicación comprueba regularmente si hay traducciones actualizadas y las descarga en segundo plano.

También se admite Mac Catalyst.

El SDK se puede instalar manualmente o a través de Swift Package Manager, Cartago o Cocoa Pods.

Si las traducciones no se están actualizando:

Si se utiliza la versión incorrecta de una traducción, asegúrate de que haya un lanzamiento con las traducciones más recientes y de que la versión actual de la aplicación esté disponible.

Gestor de paquetes rápido

Agregar la URL del repositorio público (https:/ / GitHub.com/ Phrase/ios-sdk/). Xcode se encarga automáticamente del resto de la instalación.

Cartago

Agrega la siguiente línea a tu archivo de carrito:

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

Ejecuta cartago actualizar y agrega PhraseApp.framework a tu proyecto como se describe en la documentación de Cartago.

Vainas de cacao

Agrega la siguiente línea a tu archivo pod:

pod 'PhraseSDK'

Ejecuta pod install. Si es nuevo en CocoaPods, consulte su documentación.

Instalación manual

Sigue estos pasos:

Configuración

Se recomienda llamar a ambas funciones dentro del AppDelegate en el método applicationDidFinishLaunchingWithOptions.

Objetivo C

Integra el SDK en la aplicación 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;
}

Deshabilitar remolino

Para deshabilitar swizzling, cambia PhraseSDKMainBundleProxyDisabled a SÍ en el archivo Info.plist.

Cuando se desactiva el swizzling, ya no se muestran las traducciones actualizadas. La traducción se seguirá sincronizando si se llama a updateTranslation y se puede acceder a ella con el método Phrase.localizedString().

Gestión de versiones de aplicaciones

Para determinar qué versión debe devolverse, el SDK requiere una versión semántica de la aplicación para que las traducciones se actualicen.

El SDK intenta obtener una versión semántica de la siguiente manera:

Si falta CFBundleShortVersionString o no se puede crear con una versión semántica junto con CFBundleVersion, el SDK lanza el mensaje PhraseSetupError.appVersionNotSemantic.

Deshabilitar traducción para varias tablas

Para evitar que OTA traduzca ninguna tabla del paquete iOS principal que no sea la tabla Localizable predeterminada, establezca la siguiente opción:

Phrase.shared.configuration.ignoreOtherTables = true

Devoluciones

Asigna un gestor de rellamadas para gestionar las actualizaciones de traducción correctas:

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

Modo debug

Si se requiere más información, habilite el modo debug para obtener un registro adicional de PhraseSDK.framework en la consola:

Phrase.shared.configuration.debugMode = true

Establecer tiempo de espera para solicitudes

Establece un tiempo de espera para las solicitudes contra phrase llamando a:

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

El tiempo de espera predeterminado es de 10 segundos y las conexiones que tarden más de 10 segundos se cerrarán.

Proporcionar anulación de idioma manual

Si no se utiliza el idioma del sistema como localización, se puede establecer una localización diferente en la llamada de entrada. El código de localización debe estar presente en un comunicado de phrase:

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

Fallback

En caso de que no se puedan obtener nuevas traducciones de phrase mediante el SDK, se utilizan los últimos archivos de traducción que recibió la instalación. Si la aplicación nunca recibió nuevos archivos de phrase, usa los archivos de traducción compilados de la aplicación. Esto evita errores en caso de dificultades técnicas o errores de red. Se recomienda mantener actualizados los archivos de traducción que se compilan en la aplicación con cada versión.

Auditoría

El SDK es fuente cerrado y no se puede ver ni modificar. Si es un requisito de la organización, se pueden proporcionar auditorías. Contáctanos para más detalles si es necesario.

Con el SDK, la aplicación comprueba regularmente si hay traducciones actualizadas y las descarga en segundo plano.

La biblioteca para traducciones OTA solo funciona con la biblioteca react i18next.

Para instalar el SDK nativo React, sigue estos pasos:

Archivo de muestra 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
    }
  });

Aplicación de ejemplo

https://github.com/phrase/react_native_sdk_example

La biblioteca i18next Phrase Backend implementa un backend de ejemplo para i18next que recupera las traducciones de versiones OTA.

Para crear un nuevo lanzamiento, la plataforma i18next debe configurarse para su distribución y formar parte de un lanzamiento.

Uso

Para inicializar phrase:

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

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      distribución: 'DISTRIBUTION_ID',
      secreta: 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0',
    }
  });

Almacenamiento en caché

La biblioteca guarda en caché las traducciones y no comprobará si hay nuevas traducciones durante 5 minutos. La caché se puede configurar configurando la opción cacheExpirationTime en la configuración del back-end para fines de prueba.

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      distribución: 'DISTRIBUTION_ID',
      secreta: 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0',
      cacheExpirationTime: 60 * 5, // tiempo en segundos
    }
  });

Aplicación de ejemplo

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

La biblioteca Phrase OTA i18n implementa un back-end de ejemplo para la gema I18n que recupera las traducciones de las versiones OTA. Con la biblioteca, la aplicación comprueba regularmente si hay traducciones actualizadas y las descarga en segundo plano.

La biblioteca es válida para cualquier aplicación Ruby que use la gema i18n.

Para crear un nuevo lanzamiento, la plataforma Rails debe configurarse para la distribución y formar parte de un lanzamiento.

Instalación

Uso

Para generar la configuración:

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

Depuración

La gema tiene una configuración debug que se puede habilitar en el inicializador configurando:

config.debug = true