JavaScript API
OutSystems JavaScript APIは、JavaScriptフロー要素を使用して、JavaScriptコード内でのOutSystemsの特定のアクションの呼び出しやモバイルアプリイベントへの対応、最終ユーザーのモバイルアプリエクスペリエンスの微調整およびカスタマイズを可能にします。たとえば、JavaScriptでフィードバックメッセージを表示/非表示にしたり、アプリケーションのアップグレード/読み込みイベントを特定の方法で処理したりすることができます。
事前定義された「$public」オブジェクトを介して利用可能なAPIモジュールにアクセスできます。このオブジェクトには、サポートされている各JavaScript APIへの参照が含まれます。
以下の例は、「FeedbackMessage」モジュールの「showFeedbackMessage」関数を呼び出す方法を示しています。
$public.FeedbackMessage.showFeedbackMessage("Your data has been submitted.", 1);
概要
| モジュール | |
|---|---|
| ApplicationLifecycle | アプリケーションのライフサイクルのステータスに関する情報を提供します。 ローカルモデルへのアクセスを許可しない場合にアップグレード中のアプリを保護したり、アプリケーションの読み込みプロセスをカスタマイズしたりするために使用します。 |
| Device | デバイスのネイティブ機能にアクセスするためのメソッドを提供します。 |
| FeedbackMessage | ユーザーへのフィードバックメッセージを表示します。 カスタムスタイルや自動クローズ動作などのオプションを指定して、パーソナライズされたフィードバックメッセージを表示するために使用します。 |
| Logger | メッセージやエラーをログに記録するためのメソッドを提供します。「console.log」として使用しますが、Service Centerでもメッセージを記録します。 |
| Security | クライアント側のロールチェックを実行するためのメソッドを提供します。 特定のロールに応じてUI要素をプログラムで表示したり非表示にしたりするために使用します。 |
| クラス | |
|---|---|
| ApplicationContext | 表示されている画面に基づくコンテキスト情報を提供します。 現在実行されている画面、モジュール、アプリケーションを識別するために使用します。 |
| Navigation | 通常のナビゲーションおよび履歴によるナビゲーションを実行する機能と、ナビゲーション動作を上書きする機能（戻るなど）を提供します。 CSSを使用して既存のアニメーションを上書きする代わりに、新しい遷移アニメーションを作成するために使用します。 |
| Validation | ウィジェットに検証メッセージを表示し、検証値を設定するためのメソッドを提供します。 通常の方法では実行できない反復子内でのウィジェットの検証を行うときに使用します。 |
| View | アクティブなビューコンポーネントと、コンポーネントの状態を処理するためのメソッドを提供します。 |
| 型の別名 | |
|---|---|
| ApplicationLoadEventHandlers | アプリケーションの読み込みのステータスが変化したときに呼び出されるイベントハンドラ。 |
型の別名
ApplicationLoadEventHandlers
ApplicationLoadEventHandlers: オブジェクト
アプリケーションの読み込みのステータスが変化したときに呼び出されるイベントハンドラ。
ApplicationLifecycle.listen関数で使用します。
型宣言
（オプション） onLoadComplete: 関数
アプリケーションが完全に読み込まれて使用可能になったときのコールバック。
(): void
戻り値: void
（オプション） onUpgradeProgress: 関数
バージョンアップグレード中に進捗があったときのコールバック。
(loaded: 数値, total: 数値): void
パラメータ:
- loaded: 数値
- total: 数値
戻り値: void
このセクションの記事
- ApplicationContext
- 表示されている画面に基づくコンテキスト情報を提供します。現在実行されている画面、モジュール、アプリケーションを識別するために使用します。
- ApplicationLifecycle
- アプリケーションのライフサイクルのステータスに関する情報を提供します。ローカルモデルへのアクセスを許可しない場合にアップグレード中のアプリを保護したり、アプリケーションの読み込みプロセスをカスタマイズしたりするために使用します。
- デバイス
- デバイスのネイティブ機能にアクセスするためのメソッドを提供します。
- FeedbackMessage
- ユーザーへのフィードバックメッセージを表示します。カスタムスタイルや自動クローズ動作などのオプションを指定して、パーソナライズされたフィードバックメッセージを表示するために使用します。
- Logger
- メッセージやエラーをログに記録するためのメソッドを提供します。「console.log」として使用しますが、Service Centerでもメッセージを記録します。
- ナビゲーション
- 通常のナビゲーションおよび履歴によるナビゲーションを実行する機能と、ナビゲーション動作を上書きする機能（戻るなど）を提供します。CSSを使用して既存のアニメーションを上書きする代わりに、新しい遷移アニメーションを作成するために使用します。
- セキュリティ
- クライアント側のロールチェックを実行するためのメソッドを提供します。特定のロールに応じてUI要素をプログラムで表示したり非表示にしたりするために使用します。
- Validation
- ウィジェットに検証メッセージを表示し、検証値を設定するためのメソッドを提供します。通常の方法では実行できない反復子内でのウィジェットの検証を行うときに使用します。
- View
- アクティブなビューコンポーネントと、コンポーネントの状態を処理するためのメソッドを提供します。