no versions found for ApplicationFrameworkReferences / Utility/auth/iauthkey_toAuthorizationField / en

IAuthKey: toAuthorizationField()

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

Authorization ヘッダのフィールドに格納する文字列にフォーマットされた認証情報です。

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

構文

authKey.toAuthorizationField(request) => Promise<string | null>

引数

  • request: { method, url }

    認証を付与するリクエストオブジェクトです。

    • method: string

      リクエストのメソッドです。

    • url: string

      リクエストの送信先の URL です。

返値: Promise<string | null>

認証情報を生成できればそれをフォーマットした文字列、できなければ null を返すプロミスです。