NotesHTTPRequest (LotusScript)

Web サーバーに対して HTTP 要求を行うために使用される LotusScript クラスです。

プロパティ

Maxredirects
HTTP リクエストで許可されるリダイレクトの数。

Preferstrings
国際文字の出力に使用する形式を制御します。

Responsecode
リクエストの読み込み中に発生した問題を特定するために、リクエストのHTTPレスポンスコードを返します。このプロパティは読み取り専用です。

Timeoutsec
HTTP リクエストのタイムアウト（秒）。

メソッド

DeleteResource
リソースを削除する要求を Web サーバーに送信します。

Get
リソースを取得するために Web サーバーに要求を送信します。

GetResponseHeaders
応答ヘッダーのバリアント配列を返します。

Post
リソースを作成または更新するための要求を Web サーバーに送信します。

Put
リソースを作成または更新するための要求を Web サーバーに送信します。

Patch
リソースを部分的に更新するためのリクエストを Web サーバーに送信します。

ResetHeaders
現在のリクエストで使用されているヘッダーをデフォルトにリセットします。

Resetproxy
前回のSetproxy呼び出しでプロキシをリセットしました。Resetproxy呼び出し後、以降のリクエストではプロキシは使用されません。

SetHeaderField
Web サーバーへのリクエストで使用されるコンテンツ ヘッダーを設定します。

Setproxy
今後のリクエストに使用するプロキシを設定します。

Setproxyuser
プロキシでの認証に使用するユーザー名とパスワードを設定します。

作成方法

NotesHTTPRequest オブジェクトを作成するには、CreateHTTPRequest を使用します。

構文

Dim webRequest As NotesHTTPRequest
set webRequest = NotesSession.CreateHTTPRequest()

 

 

Maxredirects プロパティ

HTTP リクエストで許可されるリダイレクトの数。

データ型

Integer

構文

設定するには: NotesHTTPRequest .maxredirects =1

使用法

指定しない場合はデフォルトは 0 です。

 

 

Preferstrings プロパティ

国際文字の出力に使用する形式を制御します。

データ型

Boolean

構文

設定するには: NotesHTTPRequest .preferstrings = flag

  • True は、国際文字出力に Unicode を使用することを示します。
  • False は、国際文字出力に UTF8 バイト配列を使用することを示します。NotesJSONNavigator クラスで使用します。

使用法

指定しない場合は、デフォルトは UTF8 バイト配列になります。

 

 

Responsecode プロパティ

リクエストの読み込み中に発生した問題を特定するために、リクエストのHTTPレスポンスコードを返します。このプロパティは読み取り専用です。

データ型

String

構文

String = NotesHTTPRequest .responseCode

 

 

Timeoutsec プロパティ

HTTP リクエストのタイムアウト（秒）。

データ型

Integer

構文

NotesHTTPRequest.timeoutsec = value

使用法

指定しない場合、タイムアウトは 30 秒になります。

 

 

DeleteResource メソッド

リソースを削除する要求を Web サーバーに送信します。

構文

Call NotesHTTPRequest .deleteResource( URL$ )

パラメータ

URL$

文字列。リクエスト先の URL。

戻り値

Variant コンテンツを JSON UTF-8 バイト配列として返します。UTF-8 バイト配列ではなく Unicode を返すには、preferstrings プロパティを使用してください。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.deleteResource(URL$)

Get メソッド

リソースを取得するために Web サーバーに要求を送信します。

構文

Call NotesHTTPRequest.get( URL$ )

パラメータ

URL$

文字列。リクエスト先の URL。

戻り値

Variant

Variant コンテンツを JSON UTF-8 バイト配列として返します。UTF-8 バイト配列ではなく Unicode を返すには、preferstrings プロパティを使用してください。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.get(URL$)

 

 

GetResponseHeaders メソッド

応答ヘッダーを Variant 型の配列で返します。

構文

value = NotesHTTPRequest.GetResponseHeaders ( )

戻り値

Variant

レスポンスヘッダーの Variant 型の配列を返します。各値にはヘッダーフィールドと値が含まれます。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.get(URL$)
valueV = webRequest.GetResponseHeaders()

 

 

Patch メソッド

リソースを部分的に更新するためのリクエストを Web サーバーに送信します。

構文

Call NotesHTTPRequest.patch ( URL$,valueV )

パラメータ

URL$

文字列。リクエスト先の URL。

valueV

Variant。リソースの更新として送信する Variant コンテンツ。Variant コンテンツはJSON文字列です。

戻り値

Variant

Variant コンテンツをJSON UTF8バイト配列として返します。UTF8バイト配列ではなくUnicodeを返すには、preferstringsプロパティを使用してください。

例


Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.patch(URL$, valueV)

 

 

Put メソッド

リソースを作成または更新するための要求を Web サーバーに送信します。

構文

Call NotesHTTPRequest.put( URL$, valueV )

パラメータ

URL$

文字列。リクエスト先の URL。

valueV

Variant 型。リソースの更新として送信する variant コンテンツ。Variant 型コンテンツは JSON 文字列です。

戻り値

Variant

Variant コンテンツをJSON UTF-8バイト配列として返します。UTF-8バイト配列ではなくUnicodeを返すには、preferstringsプロパティを使用してください。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.put(URL$, valueV)

 

 

Post メソッド

リソースを作成または更新するための要求を Web サーバーに送信します。

構文

Call NotesHTTPRequest.post( URL$, valueV )

パラメータ

URL$

文字列。リクエスト先の URL。

valueV

Variant。リソースの更新として送信する Variant バリアントコンテンツ。Variant コンテンツは JSON 文字列です。

戻り値

Variant

Variant コンテンツをJSON UTF-8バイト配列として返します。UTF-8バイト配列ではなくUnicodeを返すには、preferstringsプロパティを使用してください。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.post(URL$, valueV)

 

 

ResetHeaders メソッド

現在のリクエストで使用されているヘッダーをデフォルトにリセットします。

構文

Call NotesHTTPRequest.ResetHeaders()

使用法

ヘッダーをデフォルトに戻します:
  • Accept: application/json
  • Content-Type: application/json
  • charsets: utf-8

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.ResetHeaders()

 

 

SetHeaderField メソッド

Web サーバーへのリクエストで使用されるコンテンツ ヘッダーを設定します。

構文

Call NotesHTTPRequest.SetHeaderField( headerfield$, headervalue$ )

パラメータ

headerfield$

設定するヘッダーの名前。

headervalue$

設定するヘッダーの値。

使用法

setHeaderField を連続的に呼び出してヘッダーフィールドを追加します。headerFields は、resetHeaders メソッドを呼び出してデフォルトに戻すまで、呼び出しごとに保持されます。

デフォルトでは、各リクエストに対して次のヘッダーがデフォルトで設定されますが、これらはカスタマイズまたは上書きできます。
  • Accept: application/json
  • Content-Type: application/json
  • charsets: utf-8

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.SetHeaderField(headerfield$, headervalue$)

 

 

Setproxy メソッド

今後のリクエストに使用するプロキシを設定します。

構文

Call NotesHTTPRequest.Setproxy( PROXY_URL$ , PROXY_PORT)

パラメータ

PROXY_URL$ :

String。プロキシサーバーのホスト名またはドット区切りの数値IPアドレス。

PROXY_PORT:

Long。プロキシ サーバーに接続するためのポートを設定します。ポート番号は 65535 以下にしてください。

間違ったポート値を指定すると、次のエラー メッセージが表示され、例外が発生します:プロキシ ポート値が不正です。0 (デフォルト ポートを使用) から 65535 までの値を受け入れます。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.Setproxy(PROXY_URL$, PROXY_PORT)
'Following two requests will go through proxy server
Call webRequest.get(URL$)
Call webRequest.post(URL$, valueV)
注意: Setproxy が何らかの理由 (プロキシアドレスまたはポート番号が間違っている) で失敗した場合、"ネットワーク データの受信に失敗しましたCall webRequest.get(URL$)" というエラー メッセージとともに例外が発生します。

 

 

Setproxyuser メソッド

プロキシでの認証に使用するユーザー名とパスワードを設定します。

構文

Call NotesHTTPRequest.Setproxyuser ( PROXY_USER$ , PROXY_PASSWORD$ )

パラメータ

PROXY_USER$ : 文字列。プロキシ認証で使用するユーザー名。

PROXY_PASSWORD$:文字列。プロキシ認証で使用するパスワード。

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.Setproxy("http:\\proxy.com", 3128)
Call webRequest.Setproxyuser("pxuser", "psswd")
'Following two requests will go through proxy if proxy authenticates successfully
Call webRequest.get(URL$)
Call webRequest.post(URL$, valueV)
注意:何らかの理由 (ユーザー名またはパスワードが間違っている) でプロキシ認証が失敗した場合、"ネットワーク データの受信に失敗しましたCall webRequest.get(URL$)" というエラー メッセージとともに例外が発生します。

 

 

Resetproxy メソッド

前回のSetproxy呼び出しでプロキシをリセットしました。Resetproxy呼び出し後、以降のリクエストではプロキシは使用されません。

構文

Call NotesHTTPRequest.Resetproxy()

例

Dim webRequest as NotesHTTPRequest
Set webRequest = NotesSession.CreateHTTPRequest()
Set webRequest = NotesSession.CreateHTTPRequest()
Call webRequest.Setproxy("http:\\proxy.com", 3128)
Call webRequest.Setproxyuser("pxuser", "psswd")
Call webRequest.get(URL$) 'This request will go through proxy server
Call webRequest.Resetproxy()
Call webRequest.get(URL$) 'This request will not go through proxy server