WebEntity: getChallenge()

指定の Web 認証スキームに対応するチャレンジ[^challenge]を取得します。

レスポンスヘッダの値を表しています。

この関数は非同期関数です。

構文

webEntity.getChallenge(scheme) => Promise<string | undefined>

引数

• scheme: string

  スキーム名を表す文字列です。

返値: Promise<(string | undefined)>

与えられたスキームに対応するプロトコルが実装されていれば、チャレンジを表す文字列を返します。対応するプロトコルが存在しなければ undefined を返します。

解説

返値には、コンストラクタの引数 o.authProtocols に指定された AbstractAuthProtocol のインスタンスを対象とする getChallenge() メソッドの返値が使用されます。

もし指定のスキームに対応する認証プロトコルが o.authProtocols に指定されていなかった場合、この関数は undefined を返します。