HTTPRequestHandler API
HTTPリクエストとHTTPレスポンスを操作するためのアクションを提供します。
概要
| アクション | 説明 |
|---|---|
| AddAttributeToHtmlTag | ドキュメントの最も外側のHTMLタグ（xmlns、manifestなど）にアトリビュートを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddFaviconTag | 現在のページにファビコンを設定できます。"omlresources"を使用してomlにアイコンファイルを追加できます。 このメソッドはAjaxリクエストでは無効です。 |
| AddHeader | 現在のHTTPレスポンスにヘッダーを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddJavaScriptTag | 現在のHTTPレスポンスのHTMLに<script>タグを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddLinkTag | 現在のHTTPレスポンスのHTMLに<link>タグを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddMetaHttpEquivTag | 現在のHTTPレスポンスのHTMLにhttp-equiv属性を持つ<meta>タグを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddMetaTag | 現在のHTTPレスポンスのHTMLに<meta>タグを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| AddPostProcessingFilter | このメソッドはAjaxリクエストでは無効です。 Javaでは実装されていません。 |
| AddSessionToURL | 指定されたURLに現在のセッション識別子を追加します。 |
| AddStyleSheetTag | 現在のHTTPレスポンスのHTMLに<link rel="stylesheet">タグを追加します。 このメソッドはAjaxリクエストでは無効です。 |
| GetCookie | Cookieの値を取得します。 |
| GetEntryURL | エントリのURLを返します。該当する場合、Personal Areaとセッション識別子を含めます。 |
| GetFormValue | 現在のHTTPリクエストのフォームフィールドの値を取得します。 リクエスト内にフィールドが存在しない場合は、空の文字列を返します。フィールドが存在していても値が空の文字列である場合も同様です。 |
| GetIP | リモートクライアントのIPホストアドレス（HTTPリクエストを実行するユーザーPCのIP）を取得します。 |
| GetPageExtension | 現在の画面に対応する物理ページの拡張子（ドットを含む）を返します。例: ".aspx"または".jsf"。 |
| GetPageName | 現在の画面に対応する物理ページの名前を返します。名前の衝突が発生した場合を除き、通常は画面名と同じです。 |
| GetRawURL | http://[サーバー]部分やセッション識別子を含まない、現在の相対リクエストURLを返します。 SEOルールが適用されている場合、ユーザーのブラウザに表示されるURLが返されます。これはルール適用後の最終URLではありません。 |
| GetReferrerURL | |
| GetRequest_AddArgument | 引数文字列に新しいパラメータを追加して、GETメソッドを含むHTTPリクエストの引数文字列を作成します。 |
| GetRequest_Submit | GET引数とURLを指定してHTTP GETリクエストを送信します。レスポンスコンテンツを文字列データやバイナリデータとして返します。 |
| GetRequestContent | 現在のHTTPリクエストのコンテンツを取得します。 |
| GetRequestDomain | ブラウザで表示される現在のHTTPリクエストのホスト部分を返します。 例: ブラウザで使用するアドレスが"http://support.domain.com/site/welcome.aspx?id=12345"の場合、GetRequestDomain()は"support.domain.com"を返します。 |
| GetRequestFiles | 現在のHTTPリクエストで送信されたファイルのリストを返します。 |
| GetRequestHeader | 現在のHTTPリクエストの特定のヘッダーの値を取得します。ヘッダーが存在しない場合や値がない場合は、空の文字列を返します。 |
| GetRunningESpaceJQueryVersion | 実行中のESpaceのjQueryVersionを返します。 |
| GetSessionId | 現在のHTTPリクエストのセッション識別子を取得します。 |
| GetURL | セッション識別子を含まない、現在の絶対リクエストURLを返します。 SEOルールが適用されている場合、ルール適用後の最終URLが返されます。これはユーザーのブラウザに表示されるURLではありません。 |
| GetURLMethod | 現在のリクエストURLのリクエストメソッド（GETまたはPOST）を取得します。 |
| GetURLWithSession | 現在のリクエストURL（セッション識別子を含む）を取得します。 |
| GetUserAgent | 現在のHTTPリクエストのユーザーエージェントを取得します。 |
| GetUserLanguages | クライアント言語設定のソート済みレコードリストを取得します。 |
| GetValueFromInputId | |
| GetValueFromInputIdDecoded | |
| IsAjaxRequest | これがAJAXリクエストで実行されている場合は、Trueを返します。 Javaでは実装されていません。 |
| IsSecureConnection | 現在のリクエストがHTTPS経由で行われているかどうかを示します。 |
| MakeAbsoluteURL | 指定されたURLに基づいて絶対URLを作成します。 |
| PostRequest_AddArgument | 引数リストに新しいテキストパラメータを追加して、POST HTTPリクエストの引数リストを作成します。引数名が指定されていない場合、指定された値のみが送信されます（これはxmlポストの場合などに使用できます）。 |
| PostRequest_AddBinaryArgument | 引数リストに新しいバイナリパラメータを追加して、HTTPリクエストの引数リストを作成します。引数名が指定されていない場合、指定された値のみが送信されます（これはxmlポストの場合などに使用できます）。 |
| PostRequest_Submit | POST引数とURLを指定してHTTP POSTリクエストを送信します。レスポンスコンテンツを文字列データやバイナリデータとして返します。 |
| ReplaceURLDomain | URLのドメインを新しいドメインに置き換えます。この関数でJavaScriptをURLとして指定することはできません。新しいドメインが指定されていない場合は、現在のリクエストのドメインが使用されます。 |
| RunJavaScript | 指定されたJavaScriptをブラウザで実行します。 |
| SetBaseTag | 現在のHTTPレスポンスのHTMLのbaseタグを設定します。 このメソッドはAjaxリクエストでは無効です。 |
| SetCookie | Cookieを設定します。 |
| SetLastModified | 現在のレスポンスのLast Modified Date HTTPヘッダーを設定します。 |
| SetPageTitle | 現在のHTTPレスポンスのHTMLのページタイトルを設定します。 このメソッドはAjaxリクエストでは無効です。 |
| SetRequestTimeout | 現在のHTTPリクエストのタイムアウトを設定します。 |
| SetStatusCode | 現在のHTTPレスポンスのステータスコードを設定します。 |
| URLEncode | Webサーバーからクライアントへの信頼できるHTTP送信で使用するURL文字列をエンコードします。 |
| ストラクチャ | 説明 |
|---|---|
| RequestFile | |
| UserLanguage |
アクション
AddAttributeToHtmlTag
ドキュメントの最も外側のHTMLタグ（xmlns、manifestなど）にアトリビュートを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- 名前
- 型: Text。必須。
- Value
- 型: Text。必須。
AddFaviconTag
現在のページにファビコンを設定できます。"omlresources"を使用してomlにアイコンファイルを追加できます。
このメソッドはAjaxリクエストでは無効です。
入力
- IconFilename
- 型: Text。必須。
アイコンのファイル名。"outsystems.ico"など。 - MimeType
- 型: Text。デフォルト: 「image/x-icon」。
アイコンファイルのmimeタイプ。デフォルトでは、"image/x-icon"です。
AddHeader
現在のHTTPレスポンスにヘッダーを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- 名前
- 型: Text。必須。
ヘッダーの名前。 - Value
- 型: Text。必須。
ヘッダーの値。
AddJavaScriptTag
現在のHTTPレスポンスのHTMLに<script>タグを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- JavaScriptURL
- 型: Text。必須。
JavaScriptファイルのURL。 - Defer
- 型: Boolean。デフォルト: False。
defer属性を<script>タグに追加するかどうかを定義します。デフォルトではFalseです。 - Charset
- 型: Text。デフォルト: 「UTF-8」
<script>タグのcharset属性。デフォルトではUTF-8です。
AddLinkTag
現在のHTTPレスポンスのHTMLに<link>タグを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- Rel
- 型: Text。必須。
- Href
- 型: Text。必須。
- Type
- 型: Text。
AddMetaHttpEquivTag
現在のHTTPレスポンスのHTMLにhttp-equiv属性を持つ<meta>タグを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- HttpEquiv
- 型: Text。必須。
- Content
- 型: Text。必須。
AddMetaTag
現在のHTTPレスポンスのHTMLに<meta>タグを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- 名前
- 型: Text。必須。
- Content
- 型: Text。必須。
AddPostProcessingFilter
このメソッドはAjaxリクエストでは無効です。
Javaでは実装されていません。
入力
- matchingRegexp
- 型: Text。必須。
- replacement
- 型: Text。必須。
AddSessionToURL
指定されたURLに現在のセッション識別子を追加します。
入力
URL
- 型: Text。必須。
セッションIDを含まないURL。
出力
- URLWithSession
- 型: Text。
セッションIDを含むURL。
AddStyleSheetTag
現在のHTTPレスポンスのHTMLに<link rel="stylesheet">タグを追加します。
このメソッドはAjaxリクエストでは無効です。
入力
- StyleSheetURL
- 型: Text。必須。
CSSファイルのURL。 - Charset
- 型: Text。デフォルト: 「UTF-8」
<script>タグのcharset属性。デフォルトではUTF-8です。
GetCookie
Cookieの値を取得します。
入力
- CookieName
- 型: Text。必須。
Cookieの名前。
出力
- CookieValue
- 型: Text。
指定されたCookieの値。
GetEntryURL
エントリのURLを返します。該当する場合、Personal Areaとセッション識別子を含めます。
入力
- EntryName
- 型: Text。必須。
エントリの名前。 - eSpaceName
- 型: Text。
eSpaceの名前。指定されていない場合は、現在のeSpaceを推測して相対URLを付与します。 - FirstParameterName
- 型: Text。
最初のパラメータの名前。 - FirstParameterValue
- 型: Text。
最初のパラメータの値。 - SecondParameterName
- 型: Text。
2つ目のパラメータの名前。 - SecondParameterValue
- 型: Text。
2つ目のパラメータの値。 - ThirdParameterName
- 型: Text。
3つ目のパラメータの名前。 - ThirdParameterValue
- 型: Text。
3つ目のパラメータの値。 - FourthParameterName
- 型: Text。
4つ目のパラメータの名前。 - FourthParameterValue
- 型: Text。
4つ目のパラメータの値。 - FifthParameterName
- 型: Text。
5つ目のパラメータの名前。 - FifthParameterValue
- 型: Text。
5つ目のパラメータの値。
出力
URL
- 型: Text。
エントリのURL。
GetFormValue
現在のHTTPリクエストのフォームフィールドの値を取得します。
リクエスト内にフィールドが存在しない場合は、空の文字列を返します。フィールドが存在していても値が空の文字列である場合も同様です。
入力
- 名前
- 型: Text。必須。
出力
- Value
- 型: Text。
GetIP
リモートクライアントのIPホストアドレス（HTTPリクエストを実行するユーザーPCのIP）を取得します。
出力
- UserIP
- 型: Text。
HTTPリクエストを実行するユーザーPCのIP。
GetPageExtension
現在の画面に対応する物理ページの拡張子（ドットを含む）を返します。例: ".aspx"または".jsf"。
出力
- PageExtension
- 型: Text。
現在の画面に対応する物理ページの拡張子。
GetPageName
現在の画面に対応する物理ページの名前を返します。名前の衝突が発生した場合を除き、通常は画面名と同じです。
出力
- PageName
- 型: Text。
現在の画面に対応する物理ページの名前。
GetRawURL
http://[サーバー]部分やセッション識別子を含まない、現在の相対リクエストURLを返します。
SEOルールが適用されている場合、ユーザーのブラウザに表示されるURLが返されます。これはルール適用後の最終URLではありません。
出力
- RawURL
- 型: Text。
GetReferrerURL
出力
- ReferrerURL
- 型: Text。
GetRequest_AddArgument
引数文字列に新しいパラメータを追加して、GETメソッドを含むHTTPリクエストの引数文字列を作成します。
入力
- ArgumentsIn
- 型: Text。
現在の引数文字列。 - 名前
- 型: Text。必須。
新しい引数名。 - Value
- 型: Text。必須。
新しい引数値。
出力
- ArgumentsOut
- 型: Text。
<引数名> = <引数値>の組み合わせを連結した入力引数文字列。
GetRequest_Submit
GET引数とURLを指定してHTTP GETリクエストを送信します。レスポンスコンテンツを文字列データやバイナリデータとして返します。
入力
URL
- 型: Text。必須。
GET HTTPリクエストを作成する対象のURL。
例: "http://mydomain.com/hello/test.aspx" - Arguments
- 型: Text。必須。
GETの引数文字列。
例: "param1=valueOne¶m2=valueTwo" - Timeout
- 型: Integer。
リクエストタイムアウトまでの待機時間（ミリ秒単位）。 - KeepAlive
- 型: Boolean。
インターネットリソースへの永続的な接続を行うか（True）、行わないか（False）を示します。
出力
- TextContent
- 型: Text。
レスポンスのテキストコンテンツ。 - BinaryContent
- 型: Binary Data。
レスポンスのバイナリコンテンツ。 - BinaryContentType
- 型: Text。
レスポンスで返されるContent-Typeヘッダーの値。
GetRequestContent
現在のHTTPリクエストのコンテンツを取得します。
入力
- IncludeHeaders
- 型: Boolean。デフォルト: True。
ヘッダーが含まれるかどうかを定義します。デフォルトではTrueです。
出力
- RawContent
- 型: Text。
現在のHTTPリクエストのコンテンツ。
GetRequestDomain
ブラウザで表示される現在のHTTPリクエストのホスト部分を返します。
例: ブラウザで使用するアドレスが"http://support.domain.com/site/welcome.aspx?id=12345"の場合、GetRequestDomain()は"support.domain.com"を返します。
出力
- Domain
- 型: Text。
現在のHTTPリクエストのドメイン。
GetRequestHeader
現在のHTTPリクエストの特定のヘッダーの値を取得します。ヘッダーが存在しない場合や値がない場合は、空の文字列を返します。
入力
- HeaderName
- 型: Text。必須。
ヘッダーの名前。
出力
- Value
- 型: Text。
ヘッダーが存在しない場合や値がない場合は、空の文字列を返します。
GetRunningESpaceJQueryVersion
実行中のESpaceのjQueryVersionを返します。
出力
- JQueryVersion
- 型: Text。
GetSessionId
現在のHTTPリクエストのセッション識別子を取得します。
出力
- SessionId
- 型: Text。
セッション識別子。
GetURL
セッション識別子を含まない、現在の絶対リクエストURLを返します。
SEOルールが適用されている場合、ルール適用後の最終URLが返されます。これはユーザーのブラウザに表示されるURLではありません。
出力
URL
- 型: Text。
現在のリクエストURL。
GetURLMethod
現在のリクエストURLのリクエストメソッド（GETまたはPOST）を取得します。
出力
- Method
- 型: Text。
現在のリクエストメソッド（GETまたはPOST）。
GetURLWithSession
現在のリクエストURL（セッション識別子を含む）を取得します。
出力
URL
- 型: Text。
現在のリクエストURL（セッション識別子を含む）。
GetUserAgent
現在のHTTPリクエストのユーザーエージェントを取得します。
出力
- UserAgent
- 型: Text。
GetUserLanguages
クライアント言語設定のソート済みレコードリストを取得します。
出力
- Languages
- 型: UserLanguageのレコードリスト。
クライアント言語設定のソート済みレコードリスト。
GetValueFromInputId
入力
- InputId
- 型: Text。必須。
出力
- Value
- 型: Text。
GetValueFromInputIdDecoded
入力
- InputId
- 型: Text。必須。
出力
- Value
- 型: Text。
IsAjaxRequest
これがAJAXリクエストで実行されている場合は、Trueを返します。
Javaでは実装されていません。
出力
- IsAjaxRequest
- 型: Boolean。
これがAJAXリクエストで実行されている場合は、Trueを返します。
IsSecureConnection
現在のリクエストがHTTPS経由で行われているかどうかを示します。
出力
- IsSecureConnection
- 型: Boolean。
MakeAbsoluteURL
指定されたURLに基づいて絶対URLを作成します。
入力
URL
- 型: Text。必須。
相対URLまたは絶対URL。
出力
- AbsoluteURL
- 型: Text。
絶対URL。
PostRequest_AddArgument
引数リストに新しいテキストパラメータを追加して、POST HTTPリクエストの引数リストを作成します。引数名が指定されていない場合、指定された値のみが送信されます（これはxmlポストの場合などに使用できます）。
入力
- ArgumentsIn
- 型: Binary Data。
現在の引数リスト（バイナリ形式）。 - 名前
- 型: Text。
新しいテキスト引数名。 - Value
- 型: Text。必須。
新しいテキスト引数値。
出力
- ArgumentsOut
- 型: Binary Data。
<引数名> = <引数値>の組み合わせを連結した入力引数リスト（バイナリ形式）。
PostRequest_AddBinaryArgument
引数リストに新しいバイナリパラメータを追加して、HTTPリクエストの引数リストを作成します。引数名が指定されていない場合、指定された値のみが送信されます（これはxmlポストの場合などに使用できます）。
入力
- ArgumentsIn
- 型: Binary Data。
現在の引数リスト（バイナリ形式）。 - 名前
- 型: Text。
新しいテキスト引数名。 - Value
- 型: Binary Data。必須。
新しいバイナリ引数値。
出力
- ArgumentsOut
- 型: Binary Data。
<引数名> = <引数値>の組み合わせを連結した入力引数リスト（バイナリ形式）。
PostRequest_Submit
POST引数とURLを指定してHTTP POSTリクエストを送信します。レスポンスコンテンツを文字列データやバイナリデータとして返します。
入力
URL
- 型: Text。必須。
GET HTTPリクエストを作成する対象のURL。 - Arguments
- 型: Binary Data。
POSTの引数。 - Timeout
- 型: Integer。
リクエストタイムアウトまでの待機時間（ミリ秒単位）。 - KeepAlive
- 型: Boolean。
インターネットリソースへの永続的な接続を行うか（True）、行わないか（False）を示します。
出力
- TextContent
- 型: Text。
レスポンスのテキストコンテンツ。 - BinaryContent
- 型: Binary Data。
レスポンスのバイナリコンテンツ。 - BinaryContentType
- 型: Text。
レスポンスで返されるContent-Typeヘッダーの値。
ReplaceURLDomain
URLのドメインを新しいドメインに置き換えます。この関数でJavaScriptをURLとして指定することはできません。新しいドメインが指定されていない場合は、現在のリクエストのドメインが使用されます。
入力
URL
- 型: Text。必須。
ドメインを置き換えるURL。 - Domain
- 型: Text。
URLに挿入する新しいドメイン。
出力
- SafeURL
- 型: Text。
新しいドメインによるURL。
RunJavaScript
指定されたJavaScriptをブラウザで実行します。
入力
- スクリプト
- 型: Text。必須。
ブラウザに送信されるJavaScriptコード。
SetBaseTag
現在のHTTPレスポンスのHTMLのbaseタグを設定します。
このメソッドはAjaxリクエストでは無効です。
入力
- HREF
- 型: Text。必須。
- Target
- 型: Text。デフォルト: ""。
SetCookie
Cookieを設定します。
入力
- CookieName
- 型: Text。必須。
Cookieの名前。 - CookieValue
- 型: Text。
Cookieの値。 - CookieExpirationSpan
- 型: Integer。
Cookieの有効期間（分単位）。ゼロ以下の場合、Cookieは現在のセッションの間のみ有効になります。 - CookiePath
- 型: Text。
Cookieのパス。デフォルトのパスは、現在のeSpace、テナント、Personal Areaを組み合わせたものです。 - CookieDomain
- 型: Text。
Cookieのドメイン。デフォルトでは現在のドメインです。
SetLastModified
現在のレスポンスのLast Modified Date HTTPヘッダーを設定します。
入力
- LastModifiedDate
- 型: DateTime。必須。
最終変更日。
SetPageTitle
現在のHTTPレスポンスのHTMLのページタイトルを設定します。
このメソッドはAjaxリクエストでは無効です。
入力
- Title
- 型: Text。必須。
SetRequestTimeout
現在のHTTPリクエストのタイムアウトを設定します。
入力
- Timeout
- 型: Integer。必須。
タイムアウト（秒単位）。タイムアウトなしの場合は、-1。
SetStatusCode
現在のHTTPレスポンスのステータスコードを設定します。
注記: カスタムHTTPステータスコードの設定は高度な拡張シナリオです。意図したとおりに自社インフラで動作するかどうかをテストするようにしてください（ステータスコード「204」は問題の原因となることが知られています）。OutSystemsで使用される標準的なHTTPステータスコードを確認してください。
入力
- StatusCode
- 型: Integer。必須。
レスポンスのステータスコード。例: 404、403。
URLEncode
Webサーバーからクライアントへの信頼できるHTTP送信で使用するURL文字列をエンコードします。
入力
- StrIn
- 型: Text。必須。
文字列のURL。 - Encoding
- 型: Text。
エンコードタイプ: ASCII、Unicode、UTF7、またはUTF8。
出力
- StrOut
- 型: Text。
エンコードされた文字列のURL。
ストラクチャ
RequestFile
アトリビュート
- FileName
- 型: Text (50)。必須。
- FileType
- 型: Text (50)。必須。
- FileSize
- 型: Integer。必須。
- BinaryContent
- 型: Binary Data。必須。
UserLanguage
アトリビュート
- Value
- 型: Text (50)。必須。