AppRegistry

AppRegistryは、すべてのReact Nativeアプリを実行するためのJSエントリポイントです。アプリのルートコンポーネントはAppRegistry.registerComponentで自分自身を登録する必要があります。ネイティブシステムはアプリのバンドルを読み込んで、AppRegistry.runApplicationを呼び出して準備ができたら実際にアプリを実行します。

import {Text, AppRegistry} from 'react-native';

const App = () => (
  <View>
    <Text>App1</Text>
  </View>
);

AppRegistry.registerComponent('Appname', () => App);

ビューを破棄する必要がある場合にアプリケーションを「停止」するには、runApplicationに渡されたタグを使用してAppRegistry.unmountApplicationComponentAtRootTagを呼び出します。これらは常にペアで使用されます。

AppRegistryは、他のモジュールが必要になる前に、JS実行環境の準備が完了していることを確認するために、requireシーケンスの早い段階でrequireされる必要があります。

リファレンス

メソッド

`getAppKeys()`

static getAppKeys(): string[];

文字列の配列を返します。

`getRegistry()`

static getRegistry(): {sections: string[]; runnables: Runnable[]};

Registryオブジェクトを返します。

`getRunnable()`

static getRunnable(appKey: string): : Runnable | undefined;

Runnableオブジェクトを返します。

パラメータ

名前	タイプ
appKey 必須	文字列

`getSectionKeys()`

static getSectionKeys(): string[];

文字列の配列を返します。

`getSections()`

static getSections(): Record<string, Runnable>;

Runnablesオブジェクトを返します。

`registerCancellableHeadlessTask()`

static registerCancellableHeadlessTask(
  taskKey: string,
  taskProvider: TaskProvider,
  taskCancelProvider: TaskCancelProvider,
);

キャンセル可能なヘッドレスタスクを登録します。ヘッドレスタスクは、UI なしで実行されるコードの一部です。

パラメータ

名前	タイプ	説明
taskKey 必須	文字列	startHeadlessTask が呼び出されたときに使用された、このタスクインスタンスに対するネイティブ ID。
taskProvider 必須	TaskProvider	単一引数としてネイティブ側から渡されたデータを取って返す関数です。この約束が解決または拒否されると、ネイティブ側にこのイベントが通知され、JS コンテキストの破棄を決定できます。
taskCancelProvider 必須	TaskCancelProvider	引数を取らない void を返す関数です。キャンセルが要求されると、taskProvider によって実行される関数はすぐにラップアップして戻される必要があります。

`registerComponent()`

static registerComponent(
  appKey: string,
  getComponentFunc: ComponentProvider,
  section?: boolean,
): string;

パラメータ

名前	タイプ
appKey 必須	文字列
componentProvider 必須	ComponentProvider
section	boolean

`registerConfig()`

static registerConfig(config: AppConfig[]);

パラメータ

名前	タイプ
config 必須	AppConfig[]

`registerHeadlessTask()`

static registerHeadlessTask(
  taskKey: string,
  taskProvider: TaskProvider,
);

ヘッドレスタスクを登録します。ヘッドレスタスクは、UI なしで実行されるコードの一部です。

これはアプリがバックグラウンドにあるときに JavaScript でタスクを実行するための一つの方法です。これは、新しいデータを同期したり、プッシュ通知を処理したり、音楽を再生したりするために使用できます。

パラメータ

名前	タイプ	説明
taskKey 必須	文字列	startHeadlessTask が呼び出されたときに使用された、このタスクインスタンスに対するネイティブ ID。
taskProvider 必須	TaskProvider	単一引数としてネイティブ側から渡されたデータを取って返す関数です。この約束が解決または拒否されると、ネイティブ側にこのイベントが通知され、JS コンテキストの破棄を決定できます。

`registerRunnable()`

static registerRunnable(appKey: string, func: Runnable): string;

パラメータ

名前	タイプ
appKey 必須	文字列
run 必須	関数

`registerSection()`

static registerSection(
  appKey: string,
  component: ComponentProvider,
);

パラメータ

名前	タイプ
appKey 必須	文字列
component 必須	ComponentProvider

`runApplication()`

static runApplication(appKey: string, appParameters: any): void;

JavaScript バンドルを読み込み、アプリを実行します。

パラメータ

名前	タイプ
appKey 必須	文字列
appParameters 必須	any

`setComponentProviderInstrumentationHook()`

static setComponentProviderInstrumentationHook(
  hook: ComponentProviderInstrumentationHook,
);

パラメータ

名前	タイプ
hook 必須	関数

有効な hook 関数は、以下の引数を想定します

名前	タイプ
component 必須	ComponentProvider
scopedPerformanceLogger 必須	IPerformanceLogger

この関数は React コンポーネントを返す必要があります。

`setWrapperComponentProvider()`

static setWrapperComponentProvider(
  provider: WrapperComponentProvider,
);

パラメータ

名前	タイプ
provider 必須	ComponentProvider

`startHeadlessTask()`

static startHeadlessTask(
  taskId: number,
  taskKey: string,
  data: any,
);

ネイティブコードからのみ呼び出されます。ヘッドレスタスクを開始します。

パラメータ

名前	タイプ	説明
taskId 必須	number	このタスクインスタンスのネイティブ ID で、その後実行が追跡されます。
taskKey 必須	文字列	開始するタスクのキー。
data 必須	any	タスクに渡すデータ。

`unmountApplicationComponentAtRootTag()`

static unmountApplicationComponentAtRootTag(rootTag: number);

ビューが破棄される時点でアプリケーションを停止します。

パラメータ

名前	タイプ
rootTag 必須	number

タイプの定義

AppConfig

registerConfig メソッドのアプリケーション設定。

タイプ
オブジェクト

プロパティ

名前	タイプ
appKey 必須	文字列
component	ComponentProvider
run	関数
section	boolean

メモ: すべての config で、component または run 関数のいずれかが設定される必要があります。

Registry

タイプ
オブジェクト

プロパティ

名前	タイプ
runnables	Runnables の配列
セクション	文字列の配列

Runnable

タイプ
オブジェクト

プロパティ

名前	タイプ
component	ComponentProvider
run	関数

Runnables

appKey のキーと Runnable のタイプの値を持つオブジェクト。

タイプ
オブジェクト

タスク

タスクは、任意のデータを引数として受け取り、undefined に解決する Promise を返す関数です。

タイプ
関数

TaskCanceller

TaskCanceller は、引数を受け取らず void を返す関数です。

タイプ
関数

TaskCancelProvider

有効な TaskCancelProvider は、TaskCanceller を返す関数です。

タイプ
関数

TaskProvider

有効な TaskProvider は、タスク を返す関数です。

タイプ
関数

ネイティブコードが必須のプロジェクト

リファレンス

メソッド​

getAppKeys()​

getRegistry()​

getRunnable()​

getSectionKeys()​

getSections()​

registerCancellableHeadlessTask()​

registerComponent()​

registerConfig()​

registerHeadlessTask()​

registerRunnable()​

registerSection()​

runApplication()​

setComponentProviderInstrumentationHook()​

setWrapperComponentProvider()​

startHeadlessTask()​

unmountApplicationComponentAtRootTag()​

タイプの定義​

AppConfig​

Registry​

Runnable​

Runnables​

タスク​

TaskCanceller​

TaskCancelProvider​

TaskProvider​

メソッド

`getAppKeys()`

`getRegistry()`

`getRunnable()`

`getSectionKeys()`

`getSections()`

`registerCancellableHeadlessTask()`

`registerComponent()`

`registerConfig()`

`registerHeadlessTask()`

`registerRunnable()`

`registerSection()`

`runApplication()`

`setComponentProviderInstrumentationHook()`

`setWrapperComponentProvider()`

`startHeadlessTask()`

`unmountApplicationComponentAtRootTag()`

タイプの定義

AppConfig

Registry

Runnable

Runnables

タスク

TaskCanceller

TaskCancelProvider

TaskProvider