outsystems.api.requestInfo API
現在のリクエストとセッションに関する情報を取得するためのメソッドを提供するJavaScript API。
outsystems.api.requestInfoグローバルオブジェクトはすべてのOutSystemsアプリケーションに対して定義されています。
メソッド
以下のメソッドはすべて文字列を返します。
| メソッド | 説明 |
|---|---|
| getApplicationKey() | 現在のアプリケーションの識別子を返します。キーはアプリケーションに固有のものであり、環境が異なっても変わりません。 |
| getApplicationName() | 現在のアプリケーションの名前を返します。 |
| getEnvironmentKey() | 現在の環境の識別子を返します。 |
| getEnvironmentName() | 現在の環境の名前を返します。 |
| getEspaceKey() | 現在のモジュールの識別子を返します。モジュールに固有のものであり、環境が異なっても変わりません。 |
| getEspaceName() | 現在のモジュールの名前を返します。 |
| getFrontendKey() | 現在のリクエストが処理されたフロントエンドサーバーの識別子を返します。 |
| getRequestKey() | 現在のリクエストを一意に識別するGUIDを返します。 |
| getSessionKey() | 現在のリクエストに関連付けられたセッションの一意の識別子を返します。 |
| getTenantKey() | 現在のリクエストに関連付けられたテナントの識別子を返します。 |
| getTenantName() | 現在のリクエストに関連付けられたテナントの名前を返します。 |
| getUserKey() | ビジターが現在のリクエスト中にログインした場合、ユーザーに関連付けられたユーザー識別子を返します。 それ以外の場合は空の文字列を返します。 |
| getVisitorKey() | 現在のリクエストに関連付けられたビジターの一意の識別子を返します。 ビジターとはデバイスとブラウザの組み合わせのことです。 このキーは、ビジターが特定のデバイスとブラウザを使用してWebサイトのドメインに初めてアクセスしたときに作成されます。 ブラウザのCookieが消去されるまで同じキーが使用されます。 |
| getVisitKey() | 現在のリクエストに関連付けられたビジットの一意の識別子を返します。 ビジットは、同じビジターからの一連のページリクエストとして定義されます。リクエストの記録が30分間ない場合、ビジットは終了したものとみなされます。 |
| getWebScreenKey() | 現在のWeb画面の一意の識別キーを返します。キーはモジュール内のWeb画面に固有のものであり、環境が異なっても変わりません。 |
| getWebScreenName() | 現在のWeb画面の名前を返します。 |
例
以下は、画面のJavaScriptで上記のメソッドを使用する方法の例です。
// Use the outsystems.api.requestInfo to get information about
// the current screen.
var info = {
'ApplicationName': outsystems.api.requestInfo.getApplicationName(),
'ModuleName': outsystems.api.requestInfo.getEspaceName(),
'ScreenName': outsystems.api.requestInfo.getWebScreenName(),
};
console.log(info);
// This example returns
// Object {ApplicationName: "Phone Book", ModuleName: "PhoneBook", ScreenName: "Login"}