Over the Air (Strings)

Pomocí SDK aplikace pravidelně kontroluje aktualizované překlady a stahuje je na pozadí.

Pravidelně kontrolujte nejnovější vydání Android SDK, zejména s ohledem na upgrade.

Pokud se překlady neaktualizují:

Pokud se používá nesprávná verze překladu, ujistěte se, že vydání obsahuje nejnovější překlady, je k dispozici aktuální verze aplikace a je nastavena verzeName pro aplikaci a používají formát <Více závažné.Méně závažné.point>.

Požadavky

Zahrnout SDK

Přidat nové úložiště do kořenového souboru build.gradle:

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

Přidejte knihovnu jako závislost:

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

Podpora Jetpack Compose

Chcete-li povolit podporu Jetpack Compose pro překlady OTA, postupujte takto:

Konfigurace

Spusťte SDK ve třídě aplikací a přidejte ID distribuce a secret prostředí. Třídy dědící z Application by měly přepsat attachBaseContext a povolit překlady mimo kontext aktivity:

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

Vložte SDK do každé aktivity, např. vytvořením základní aktivity, kterou všechny ostatní aktivity dědí z:

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

Překlady lze použít jako obvykle v sestavách:

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

A vnitřní kód:

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

Některé knihovny nepodporují automatické rozbalování kontextu a očekávají určitou třídu. V tomto případě lze zalamování kontextu v komponentách Jetpack Compose zakázat pomocí:

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

Konfigurace pro úrovně protokolu:

Změnit jazyk

Pokud nepoužíváte systémový jazyk, lze v metodě setLocaleCode nastavit jiný jazyk. Kód jazyka (kód jazyka) musí být ve vydání.

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

Vlastní verze aplikace

SDK ve výchozím nastavení používá verzi aplikace k vrácení vydání, které odpovídá omezením vydání pro min a max verzi. Verze aplikace musí použít sémantické verzování, jinak se překlad neaktualizuje. Pokud aplikace nepoužije sémantické verzování, je možné použitou verzi aplikace ručně přepsat.

Příklad:

Phrase.setAppVersion("3.2.4");

Verze musí být nastavena před voláním updateTranslations( ).

Nastavit časový limit

Výchozí časový limit pro stahování překladů je nastaven na 10s.

Výchozí lze změnit pomocí:

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

Aktualizovat návrat

Vyžaduje-li zpracování úspěšných aktualizací překladu, připojte handler pro zpětné volání:

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

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

Aktualizace překladů lze spouštět také ručně. Nově načtené překlady se zobrazí při Dalším spuštění aplikace.

Chcete-li mít nejnovější překlady okamžitě k dispozici, použijte metodu Phrase.applyPendingUpdates(). To lze kombinovat s poslechem aktualizací překladu:

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

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

Uživatelské rozhraní nezobrazuje překlady automaticky a je třeba je znovu vytvořit.

Konfigurace datového centra v USA

Datové centrum Phrase US je také podporováno. Datové centrum v USA lze nakonfigurovat voláním:

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

Záložní systém

Pokud se nelze do Phrase dostat kvůli chybějícímu síťovému připojení klienta nebo přerušení služby, použije SDK zabalené překlady ze souboru se zdrojem. Doporučujeme pravidelnou aktualizaci zabalených překladů v aplikaci. SDK také ukládá překlady lokálně do mezipaměti v zařízení. Pokud taková mezipaměť existuje, používá se do doby, než se Další překlad aktualizuje.

SDK používá pro překlady nejnovější vydání. V případě, že je pro aplikaci nastaven verzeName, použije se nejnovější vydání, které splňuje omezení verze.

Přidat nový jazyk

Vytvoření nového jazyka ve Phrase a vytvořit nové vydání. SDK načítá jazyk, pokud se jedná o jazyk zařízení uživatele. Při vydání nové verze aplikace se doporučuje pravidelně přidávat nové soubory strings.xml pro nové jazykové soubory, nebo se uživatelům při prvním spuštění aplikace zobrazí pouze záložní překlady určené systémem Android.

Audit

SDK je uzavřený zdroj a nelze ho zobrazit ani upravovat. Pokud se jedná o požadavek organizace, lze audity poskytnout. V případě potřeby nás Kontaktujte.

Vlastní zobrazení Podpora

Vlastní zobrazení lze překládat pomocí stylizovaných atributů. Jelikož TypedArray neumožňuje přepisování zdrojů, vyžadují se drobné změny ve vlastním zobrazení:

Příklad aplikace

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

Pomocí SDK aplikace pravidelně kontroluje aktualizované překlady a stahuje je na pozadí.

Požadavky

Tato knihovna závisí na verzi 0.18.0 Flutterovy intl knihovny. Postupujte podle jejich průvodce a přidejte do aplikace podporu lokalizací.

Instalace

Přidat Phrase do souboru pubspec.yaml:

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

flutter:
  generate: true
  ...

Stejně jako v intl knihovně se generování kódu používá ke zpracování souborů ARB. Spuštěním tohoto příkazu aktualizujte:

flutter pub run phrase

Použití build_runner:

flutter pub run build_runner watch

Použití

Inicializace Phrase v souboru 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(
      název: 'Flutter Demo',
      //..
      lokalizaceDelegáti: PhraseLocalizations.localizationsDelegates,
      supportedMísta: PhraseLocalizations.supportedLocales,
    );
  }
}

Přístup ke zprávám s:

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

Přizpůsobení

Aktualizovat chování

Překlady OTA se aktualizují při každém spuštění aplikace. zakázat:

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

Chcete-li aktualizovat ručně:

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

Vlastní verze aplikace

SDK ve výchozím nastavení používá verzi aplikace k vrácení vydání, které odpovídá omezením vydání pro min a max verzi. Verze aplikace musí použít sémantické verzování, jinak se překlad neaktualizuje. Pokud aplikace nepoužije sémantické verzování, lze verzi aplikace ručně přepsat: je možné ručně přepsat verzi aplikace:

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

Konfigurace datového centra v USA

Datové centrum Phrase US je také podporováno. Datové centrum v USA lze vybrat předáním příslušného parametru názvu hostitele API v konfiguraci SDK:

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

Příklad aplikace

https://github.com/phrase/flutter_sdk_example

Pomocí SDK aplikace pravidelně kontroluje aktualizované překlady a stahuje je na pozadí.

Zařízení Mac Catalyst je také podporované.

SDK lze nainstalovat ručně nebo prostřednictvím Swift Package Manager, Carthage nebo Cocoa Pods.

Pokud se překlady neaktualizují:

Pokud používáte nesprávnou verzi překladu, zajistěte, aby bylo k dispozici vydání s nejnovějšími překlady a aktuální verzí aplikace.

Swift Package Manager

Přidat URL veřejného úložiště (https://github.com/Phrase/ios-sdk/). Xcode se automaticky postará o zbytek instalace.

Kartágo

Přidejte do košíku následující řádek:

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

Spusťte aplikaci Carthage aktualizovat a přidejte do svého projektu PhraseApp.framework podle popisu v dokumentaci aplikace Carthage.

Kakaové lusky

Přidejte do svého Podprofilu následující řádek:

pod 'PhraseSDK'

Spusťte instalaci pod. Pokud jsou CocoaPody nové, podívejte se do jejich dokumentace.

Ruční instalace

Postupujte takto:

Konfigurace

Doporučujeme volat obě funkce v rámci AppDelegate v metodě applementDidFinishLaunchingWithOptions.

Objective-C

Integrujte SDK do aplikace 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;
}

Zakázat kroužení

Chcete-li zakázat swizzling, nastavte v souboru Info.plist PhraseSDKMainBundleProxyDisabled na ANO.

Pokud je swizzling vypnuto, aktualizované překlady se již nezobrazují. Překlad se bude synchronizovat i po volání updateTranslation a bude přístupný metodou Phrase.localizedString().

Zpracování verzí aplikace

Chcete-li určit, které vydání by mělo být vráceno, vyžaduje SDK sémantickou verzi aplikace, aby se překlady aktualizovaly.

SDK se pokusí získat sémantickou verzi následujícím způsobem:

Pokud CFBundleShortVersionString chybí nebo ji nelze vytvořit v sémantické verzi společně s CFBundleVersion, SDK vyhodí zprávu PhraseSetupError.appVersionNotSemantic.

Zakázat překlad pro více tabulek

Abyste zabránili OTA v překladu jakýchkoli tabulek v hlavním balíčku iOS kromě výchozí tabulky Localizable, nastavte následující možnost:

Phrase.shared.configuration.ignoreOtherTables = true

Návraty

Připojte callback handler a zpracujte úspěšné aktualizace překladu:

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

Režim ladění

Jsou-li vyžadovány další informace, povolte režim Debug, abyste získali další záznam z PhraseSDK.framework do konzole:

Phrase.shared.configuration.debugMode = true

Nastavit časový limit pro požadavky

Nastavte časový limit pro požadavky proti Phrase voláním:

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

Výchozí časový limit je 10 sekund a spojení trvající déle než 10 sekund budou ukončena.

Zajistit ruční přepsání jazyka

Pokud jako kód jazyka nepoužíváte systémový jazyk, lze v init volání nastavit jiný kód jazyka. Kód jazyka musí být ve vydání z Phrase:

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

Záložní systém

Pokud nelze z Phrase načíst nové překlady prostřednictvím SDK, použijí se nejnovější překladové soubory, které instalace obdržela. Pokud aplikace nikdy neobdržela nové soubory z Phrase, použije zkompilované překladové soubory aplikace. Zabráníte tak chybám v případě technických potíží nebo chyb v síti. Doporučujeme udržovat překladové soubory zkompilované do aplikace aktuální s každým vydáním.

Audit

SDK je uzavřený zdroj a nelze ho zobrazit ani upravovat. Pokud se jedná o požadavek organizace, lze audity poskytnout. V případě potřeby nás Kontaktujte.

Pomocí SDK aplikace pravidelně kontroluje aktualizované překlady a stahuje je na pozadí.

Knihovna pro překlady OTA pracuje pouze s knihovnou react-i18next.

React Native SDK nainstalujete takto:

Vzorový soubor 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
    }
  });

Příklad aplikace

https://github.com/phrase/react_native_sdk_example

Knihovna i18next-Phrase-backend implementuje vzorový backend pro i18next, který načítá překlady z vydání OTA.

Chcete-li vytvořit nové vydání, musí být platforma i18next nastavena pro distribuci a být součástí vydání.

Použití

Pro spuštění Phrase:

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

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

Caching

Knihovna ukládá překlady do mezipaměti a nové překlady nebude kontrolovat po dobu 5 minut. Caching lze nakonfigurovat nastavením volby cacheExpirationTime v konfiguraci backendu pro testovací účely.

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      distribuce: 'DISTRIBUTION_ID',
      secret: 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0',
      cacheExpirationTime: 60 * 5, // čas v sekundách
    }
  });

Příklad aplikace

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

Knihovna Phrase-OTA-i18n implementuje příklad backendu pro drahokam I18n, který načítá překlady z vydání OTA. Pomocí knihovny aplikace pravidelně kontroluje aktualizované překlady a stahuje je na pozadí.

Knihovna je platná pro libovolnou aplikaci Ruby používající drahokam i18n.

Chcete-li vytvořit nové vydání, musí být platforma Rails nastavena pro distribuci a být součástí vydání.

Instalace

Použití

Pro vygenerování konfigurace:

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

Ladění

Drahokam má konfiguraci Debug, kterou lze v inicializátoru povolit nastavením:

config.debug = true