Apex 開発者ガイド
jHttpRequest クラス
名前空間
使用方法
HttpRequest で作成されたリクエストボディ内の XML または JSON コンテンツを解析するには、XML クラスまたは JSON クラスを使用します。
例
次の例は、要求に認証ヘッダーを使用する方法と応答の処理を示しています。
HttpRequest のメソッド
HttpRequest のメソッドは次のとおりです。すべてインスタンスメソッドです。
getBodyDocument()
署名
public Dom.Document getBodyDocument()
戻り値
型: Dom.Document
例
このメソッドを次のショートカットとして使用します。
getMethod()
署名
public String getMethod()
戻り値
型: String
使用方法
次は、戻り値の例です。
- DELETE
- GET
- HEAD
- PATCH
- POST
- PUT
- TRACE
setBody(body)
署名
public Void setBody(String body)
パラメータ
- body
- 型: String
戻り値
型: Void
使用方法
制限: 同期 Apex の場合は 6 MB、非同期 Apex の場合は 12 MB。
HTTP 要求のサイズおよび応答のサイズは、ヒープサイズの合計にカウントされます。
setBodyAsBlob(body)
署名
public Void setBodyAsBlob(Blob body)
パラメータ
- body
- 型: Blob
戻り値
型: Void
使用方法
制限: 同期 Apex の場合は 6 MB、非同期 Apex の場合は 12 MB。
HTTP 要求のサイズおよび応答のサイズは、ヒープサイズの合計にカウントされます。
setBodyDocument(document)
署名
public Void setBodyDocument(Dom.Document document)
パラメータ
- document
- 型: Dom.Document
戻り値
型: Void
使用方法
制限: 同期 Apex の場合は 6 MB、非同期 Apex の場合は 12 MB。
setClientCertificateName(certDevName)
署名
public Void setClientCertificateName(String certDevName)
パラメータ
- certDevName
- 型: String
戻り値
型: Void
使用方法
「HTTP 要求での証明書の使用」を参照してください。
setCompressed(flag)
署名
public Void setCompressed(Boolean flag)
パラメータ
- flag
- 型: Boolean
戻り値
型: Void
setEndpoint(endpoint)
署名
public Void setEndpoint(String endpoint)
パラメータ
- endpoint
- 型: String
- エンドポイントに使用できる値は、次のとおりです。
- エンドポイント URL
- 指定ログイン情報 URL (スキーム callout、指定ログイン情報の名前、必要に応じて追加されたパスを含む)
- エンドポイント URL
戻り値
型: Void
setMethod(method)
署名
public Void setMethod(String method)
パラメータ
- method
- 型: String
- このメソッドの種別の値には、次のものがあります。
- DELETE
- GET
- HEAD
- PATCH
- POST
- PUT
- TRACE
戻り値
型: Void
使用方法
このメソッドは要求オプションの設定にも使用できます。
setTimeout(timeout)
署名
public Void setTimeout(Integer timeout)
パラメータ
- timeout
- 型: Integer
戻り値
型: Void
使用方法
タイムアウト値は 1 ～ 120,000 ミリ秒の間で設定します。
toString()
署名
public String toString()
戻り値
型: String