Over the Air (Strings)

С помощью SDK приложение регулярно проверяет обновленные переводы и скачивает их в фоновом режиме.

Регулярно проверяйте последние выпуски Android SDK, особенно учитывая обновления.

Если переводы не обновляются:

Если используется неправильная версия перевода, обеспечьте выпуск с последними переводами и доступной текущей версией приложения, а также версиейName для набора приложений и используйте <Существующий.Незначительный. point>. формат.

Требования

Включить SDK

Добавьте новое хранилище в корень Build.gradle:

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

Добавить библиотеку в зависимости:

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

Поддержка Jetpack

Чтобы включить поддержку обновления по воздуху (OTA) перевода Jetpack Compose, выполните следующие действия:

Конфигурация

Инициализируйте SDK в классе приложений и добавить Идентификатор дистрибутива и секрет среды. Классы, унаследованные от Application, должны перезаписать attraitBaseContext, чтобы включить переводы вне контекста деятельности:

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

Впрыскивайте SDK в каждое действие, например, создавая базовое действие, которое все остальные действия унаследуют от:

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

Переводы можно использовать как обычно в верстках:

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

А внутренний код:

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

Некоторые библиотеки не поддерживают автоматическую разворачивание контекста и ожидают определенного класса. В этом случае обертку контекста в компонентах Jetpack Compose можно отключить с помощью:

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

Конфигурации для уровней журнала:

Изменить язык

Если язык системы не используется, в методе setLocaleCode можно указать другой язык. Языковой код (языковой стандарт) должен присутствовать в релизе.

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

Пользовательская версия приложения

SDK использует версию приложения по умолчанию, чтобы вернуть релиз, соответствующий ограничениям на выпуск для версии min и max. Версия приложения должна использовать семантическое управление версиями, иначе обновить перевода не возвращается. В случае, если приложение не использует семантическую версию, можно вручную переопределить используемую версию приложения.

Пример:

Phrase.setAppVersion("3.2.4");

Версия должна быть установлена перед вызовом UpdateTranslations( ).

Задать тайм-аут

Тайм-аут для скачивания переводов по умолчанию установлен на уровне 10s.

По умолчанию можно изменить с помощью:

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

Обновить обратный вызов

Если требуется обработка успешных обновлений перевода, прикрепите обработчик обратного вызова:

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

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

Обновления перевода также могут запускаться вручную. Новые извлеченные переводы отображаются при След. запуске приложения.

Чтобы сделать последние переводы доступными сразу, используйте метод Phrase.applyPendingUpdates(). Это можно совместить с прослушиванием обновлений перевода:

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

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

Пользовательский интерфейс не отображает переводы автоматически и должен быть воссоздан.

Настройка центра хранения и обработки данных в США

Также поддерживается центр хранения и обработки данных phrase US. Настроить центр хранения и обработки данных в США можно по телефону:

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

Резервный вариант

В случае, если связаться с Phrase невозможно из-за отсутствия сетевого подключения клиента или перерыва в предоставлении услуги, SDK использует пакетные переводы из файла ресурса. Рекомендуется регулярно обновлять пакетные переводы в приложении. SDK также кэширует переводы на устройстве локально. Если такой кэш существует, он используется до След. обновить перевода.

SDK использует последний релиз для переводов. В случае, если для приложения установлен versionName, будет использоваться последний релиз, удовлетворяющий ограничениям версии.

Добавить новый язык

Создание нового языка в phrase и создайте новый релиз. SDK извлекает язык, если это язык устройства пользователя. Рекомендуется регулярно добавлять новые strings.xml для файлов на новых языках при выпуске новой версии приложения. Или пользователи увидят резервные переводы, определенные Android, только при первом запуске приложения.

Аудит

SDK имеет закрытый оригинал и не может быть просмотрен или изменен. Если это требование организации, можно предоставить аудит. При необходимости Свяжитесь с нами для более подробной информации.

Поддержка пользовательского просмотра

Пользовательские представления можно перевести с помощью стилизованных атрибутов. Поскольку TyptdArray не позволяет записывать ресурсы, необходимы незначительные изменения в пользовательском представлении:

Пример приложения

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

С помощью SDK приложение регулярно проверяет обновленные переводы и скачивает их в фоновом режиме.

Требования

Эта библиотека зависит от версии intl библиотеки Flutter 0.18.0.Следуйте их рекомендации, чтобы добавить поддержку локализации в приложение.

Установка

Добавьте phrase в pubspec.yaml:

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

flutter:
  generate: true
  ...

Как и в библиотеке intl, генерирование кода используется для обработки файлов ARB. Выполните эту команду, чтобы обновить:

flutter pub run phrase

Использование build_runner:

flutter pub run build_runner watch

Использование

Initialize phrase в файле 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(
      название: 'Flutter Demo',
      //..
      localizationsDelegates: PhraseLocalizations.localizationsDelegates,
      supportedLocales: PhraseLocalizations.supportedLocales,
    );
  }
}

Получить доступ к сообщениям с помощью:

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

Настройка

Обновить поведение

Переводы обновления по воздуху (OTA) обновляются каждый раз при запуске приложения. Чтобы отключить это:

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

Обновить вручную:

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

Пользовательская версия приложения

SDK использует версию приложения по умолчанию, чтобы вернуть релиз, соответствующий ограничениям на выпуск для версии min и max. Версия приложения должна использовать семантическое управление версиями, иначе обновить перевода не будет возвращено. В случае, если приложение не использует семантическую версию, версию приложения можно вручную переопределить: есть возможность вручную переопределить версию приложения:

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

Настройка центра хранения и обработки данных в США

Также поддерживается центр хранения и обработки данных phrase US. Центр хранения и обработки данных в США можно выбрать, передав соответствующий параметр имени интерфейса приложений API в конфигурации SDK:

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", хост: PhraseHost.us);

Пример приложения

https://github.com/phrase/flutter_sdk_example

С помощью SDK приложение регулярно проверяет обновленные переводы и скачивает их в фоновом режиме.

Также поддерживается Mac Catalyst.

SDK можно установить вручную или через Swift Package Manager, Carthage или Coao Pods.

Если переводы не обновляются:

Если используется неправильная версия перевода, убедитесь, что доступен релиз с последними переводами и актуальной версией приложения.

Swift Package Manager

Добавить URL-адрес общедоступного хранилища (https:/github.com/phrase/ios-sdk/). Xcode автоматически обрабатывает остальную часть установки.

Карфаген

Добавьте в Картфайл следующую строку:

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

Обновите карфаген и добавьте PhraseApp.framework в свой проект, как описано в Карфагенской документации.

Какао-стручки

Добавьте в свой подфайл следующую строку:

pod 'PhraseSDK'

Запустите установку капсулы. Если вы новичок в какао-подах, см. их документацию.

Ручная установка

Выполните следующие действия:

Конфигурация

Рекомендуется вызвать обе функции в AppDelegate в методе applicationDidFinishLaunchingWithOptions.

Цель-С

Интегрируйте SDK в приложение 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;
}

Отключить свайзинг

Чтобы отключить переключение, установите значение PhraseSDKMainBundleProxyDisabled на YES в файле Info.plist.

При отключенном нажатии обновленные переводы больше не отображаются. Перевод по- прежнему будет синхронизирован при вызове UpdateTranslation, к нему можно получить доступ с помощью метода Phrase.localizedString().

Обработка версий приложения

Для определения того, какой релиз следует вернуть SDK, требуется семантическая версия приложения, чтобы переводы обновлялись.

SDK пытается получить смысловую версию следующим образом:

Если CFBundleShortVersionString отсутствует или не может быть создан с помощью семантической версии вместе с CFBundleVersion, SDK выдает сообщение PraseSetupError.appVersionNotSemantic.

Отключить перевод для нескольких таблиц

Чтобы OTA не переводила никакие таблицы в основном пакете iOS, кроме локализуемой таблицы по умолчанию, задайте следующий параметр:

Phrase.shared.configuration.ignoreOtherTables = true

Обратные звонки

Прикрепите обработчик обратного вызова для выполнения успешных обновлений перевода:

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

Режим debug

Если требуется дополнительная информация, включите режим Debug, чтобы получить дополнительный вход PraseSDK.framework в консоль:

Phrase.shared.configuration.debugMode = true

Установить тайм-аут для запросов

Установите тайм-аут для запросов против phrase, позвонив по телефону:

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

Тайм-аут по умолчанию составляет 10 секунд, и соединения, занимающие больше 10 секунд, будут закрыты.

Переопределение языка вручную

Если в качестве языкового стандарта не используется язык системы, в вызове init можно указать другой языковой стандарт. Код языкового стандарта должен присутствовать в релизе от phrase:

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

Резервный вариант

В случае невозможности извлечь новые переводы из phrase через SDK используются последние файлы переводов, которые получила установка. Если приложение так и не получило новых файлов от phrase, то оно использует скомпилированные файлы перевода приложения. Это предотвращает ошибки при возникновении технических трудностей или сетевых ошибок. Рекомендуется обновлять файлы перевода, скомпилированные в приложении, с каждым выпуском.

Аудит

SDK имеет закрытый оригинал и не может быть просмотрен или изменен. Если это требование организации, можно предоставить аудит. При необходимости Свяжитесь с нами для более подробной информации.

С помощью SDK приложение регулярно проверяет обновленные переводы и скачивает их в фоновом режиме.

Библиотека переводов обновлений по воздуху (OTA) работает только с библиотекой react- i18next.

Чтобы установить React Native SDK, выполните следующие действия:

Образец файла 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
    }
  });

Пример приложения

https://github.com/phrase/react_native_sdk_example

Библиотека i18next- Phrase-backend реализует пример базового модуля для i18next, который извлекает переводы из обновлений по воздуху (OTA).

Чтобы создать новую версию, необходимо установить платформу i18next для дистрибутива и стать ее частью.

Использование

Чтобы инициализировать Phrase:

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

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      распределение: «DISTRIBUTION_ID»,
      секрет: 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0',
    }
  });

Кэширование

Библиотека кэширует переводы и не будет проверять новые переводы в течение 5 минут. Кэширование можно настроить, установив опцию cacheExpirationTime в конфигурации модуля для тестирования.

i18n
  .use(I18nextPhraseBackend)
  .init({
    fallbackLng: 'en',
    backend: {
      распределение: «DISTRIBUTION_ID»,
      секрет: 'YOUR_ENVIRONMENT_SECRET',
      appVersion: '1.0.0',
      cacheExpirationTime: 60 * 5, // время в секундах
    }
  });

Пример приложения

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

В библиотеке phrase-ota-i18n реализован пример модуля для драгоценного камня I18n, который извлекает переводы из релизов OTA. С помощью библиотеки приложение регулярно проверяет обновленные переводы и скачивает их в фоновом режиме.

Библиотека действительна для любого приложения Ruby с использованием драгоценного камня i18n.

Чтобы создать новую версию, необходимо установить платформу Rails для дистрибутива и стать ее частью.

Установка

Использование

Для создания конфигурации:

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

Отладка

gem имеет конфигурацию Debug, которую можно активировать в инициализаторе, настроив:

config.debug = true