IAuthProtocol: revoke()

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

プロトコルにしたがって認証情報を破棄します。

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

構文

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

引数

• entity: AuthEntity

  破棄する対象の認証情報を格納したエンティティです。

• options: object

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

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

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

• ok: boolean

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

• failed: { code, message }?

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

  • code: string

    失敗コードです。

  • message: string

    失敗メッセージです。

• info: any?

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

• newEntity: AuthEntity?

  破棄した結果、新しく認証エンティティが得られた場合はそれを返します。