keyboard_arrow_leftexistAgent()login()keyboard_arrow_right

AuthAgent

モジュールパス: /alier_sys/Auth.js

--- config: class: hideEmptyMembersBox: true --- classDiagram direction LR IAuthAgent <|-- AuthAgent link IAuthAgent "./iauthagent"

概要

ログインなどの認証処理を行うクラスです。

コンストラクタ

構文

new AuthAgent(args)
new AuthAgent({ id, protocols })
new AuthAgent({ id, protocols, nextProtocol })
new AuthAgent({ id, protocols, selectProtocol })
new AuthAgent({ id, protocols, selectProtocol, nextProtocol })

引数

args: { id, protocols[, selectProtocol][, nextProtocol] }

以下のプロパティを持つオブジェクトです。
- id: string
認証エージェントの保存、取得の際に使用される識別子です。
- protocols: IAuthProtocol | [ ... ] | { ... }
  
  実行する認証プロトコルです。渡されるものの型によってどのように実行されるかが決まります。
  - IAuthProtocol
    
    渡されたプロトコルを実行します。
  - [IAuthProtocol, IAuthProtocol | { [name: string]: IAuthProtocol}]
    
    長さ２の配列の場合は２つのプロトコルを順番に実行します。２つ目はオブジェクトリテラルにして選択可能にすることもできます。
  - { [name: string]: IAuthProtocol | [IAuthProtocol, { [name: string]: IAuthProtocol }] }
    
    オブジェクトリテラルの場合は selectProtocol で決められたプロトコルが実行されます。プロパティはプロトコル単体か長さ２の配列になります。
- selectProtocol: ((envelope: Envelope) => string)?
  
  protocols がオブジェクトだった時に実行するプロトコルを決定するコールバックです。envelope は選択したプロトコル名をエージェントに渡すための Envelope です。
- nextProtocol: ((info: any) => string)?
  
  配列の２番目がオブジェクトだった時に実行するプロトコルを決定するコールバックです。info は１番目に実行したプロトコルで得られた情報です。