WebEntity: getAuthProtocol()

指定の Web 認証スキームに対応する認証プロトコルを実装するオブジェクトを取得します。

構文

webEntity.getAuthProtocol(scheme) => AbstractAuthProtocol | undefined

引数

• scheme: string

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

返値: AbstractAuthProtocol | undefined

与えられたスキームに対応するプロトコルが実装されていれば、そのプロトコルを実装する AbstractAuthProtocol のインスタンスを返します。対応するプロトコルが存在しなければ undefined を返します。

解説

返値にはコンストラクタ の引数 o.authProtocols に指定された AbstractAuthProtocol のインスタンスが使用されます。

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