AuthAgent: login()

ログイン処理を実行します。

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

構文

authAgent.login() => Promise<{ ok, code }>
authAgent.login({ protocolId }) => Promise<{ ok, code }>

引数

• options: { [protocolId] }?

  以下のプロパティを持つオブジェクトです。この引数は省略可能で、省略した場合はそれぞれの値は既定値となります。

  • protocolId: string?

    認証プロトコルの ID です。現在の AuthAgent では使用されていません。

    引数には各プロトコルに渡すオプションも入れることができます。

返値: Promise<{ ok, code }>

次のプロパティを持つオブジェクトを返すプロミスです。

• ok: boolean

  ログインに成功したかどうかを表します。

• code: string | undefined

  失敗した場合の理由を表す失敗コードです。