DigestProtocol: revoke()

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

Digest 認証プロトコルでは破棄に関しては特に定められていないので何も行いません。

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

構文

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

引数

• entity: AuthEntity

  破棄する認証エンティティのインスタンスです。

• options: object?

  破棄する上でのオプション引数です。Digest 認証プロトコルでは必要ありません。この引数は省略可能です。

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

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

• ok: boolean

  成功したかどうかです。

• failed: { code, message } | undefined

  失敗した場合は失敗理由をプロパティに持つオブジェクトです。

  • code: string

    失敗コードです。

  • message: string

    失敗に関するメッセージです。

• info: any | undefined

  デバッグ用の情報や次に行うべき処理に関する情報が入ります。

• newEntity: AuthEntity | undefined

  処理の結果新しい認証エンティティが得られた場合はそれが返されます。