IAuthProtocol: refresh()

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

認証情報をリフレッシュします。

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

構文

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

引数

• entity: AuthEntity

  リフレッシュする対象の認証情報を格納した認証エンティティです。

• opitons: object?

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

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

• ok: boolean

  リフレッシュに成功したかどうかを表す真偽値です。

• newEntity: AuthEntity?

  リフレッシュに成功した場合、新しく得られた認証エンティティを返します。

• failed: { code, message }?

  リフレッシュに失敗した場合、失敗した理由などを返すオブジェクトを返します。

  • code: string

    失敗コードです。

  • message: string

    失敗メッセージです。

• info: any?

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