IAuthProtocol: auth()

継承したクラスで実装してください。

認証処理を実行します。

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

構文

iauthProtocol.auth() => Promise<{ ok, entity, failed, info }>
iauthProtocol.auth(options) => Promise<{ ok, entity, failed, info }>

引数

• options: { [protocolId] }?

  オプション引数です。プロトコルによって追加の引数がある場合があります。

  • protocolId: string?

    認証プロトコルの ID です。

返値: Promise<{ ok, entity, failed, info }>

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

• ok: boolean

  認証に成功したかどうかを表す真偽値です。

• entity: AuthEntity?

  認証に成功した場合、認証情報が取得されればそれを格納したエンティティを返します。

• failed: { code, message }?

  認証に失敗した場合、失敗した理由などを返すオブジェクトを返します。

  • code: string

    失敗コードです。

  • message: string

    失敗メッセージです。

• info: any?

  デバッグ用の追加情報です。