InteractionRequiredAuthError class
ユーザーの操作が必要な場合にスローされるエラー。
- Extends
コンストラクター
| Interaction |
プロパティ
| claims |
トークン要求が Web サイトを成功させるために必要な追加の要求を含む文字列: ユーザーを承認ページにリダイレクトし、追加の要求 Web API を設定します。クライアントに送り返される WWW-Authenticate ヘッダーに要求を含めて、追加の要求デスクトップ アプリケーションまたはブラウザー コンテキストでトークンを要求することを認識できるようにします。 アプリ コンテキスト (client_credentials) にトークンを対話形式で取得するときに要求を含める: AcquireTokenByClientCredential 要求に要求を含める |
| error |
サーバー エラー番号。 |
| timestamp | エラーが発生した時刻 |
| trace |
エラーに関連付けられている TraceId |
継承されたプロパティ
| correlation |
エラーに関連付けられている CorrelationId |
| error |
短い文字列の説明エラー |
| error |
エラーの詳細な説明 |
| message | |
| name | |
| platform |
ブローカーが有効になっている場合の MsalNodeRuntime からの既定の PlatformBrokerError |
| stack | |
| stack |
デフォルト値は 非数値値、または負数に設定した場合、スタックトレースはフレームをキャプチャしません。 |
| sub |
エラーのサブクラスについて説明します |
継承されたメソッド
| capture |
トレースの最初の行は オプションの
|
| prepare |
「https://v8.dev/docs/stack-trace-api#customizing-stack-traces」を参照してください。 |
| set |
コンストラクターの詳細
InteractionRequiredAuthError(string, string, string, string, string, string, string, string)
new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string, timestamp?: string, traceId?: string, correlationId?: string, claims?: string, errorNo?: string)
パラメーター
- errorCode
-
string
- errorMessage
-
string
- subError
-
string
- timestamp
-
string
- traceId
-
string
- correlationId
-
string
- claims
-
string
- errorNo
-
string
プロパティの詳細
claims
トークン要求が Web サイトを成功させるために必要な追加の要求を含む文字列: ユーザーを承認ページにリダイレクトし、追加の要求 Web API を設定します。クライアントに送り返される WWW-Authenticate ヘッダーに要求を含めて、追加の要求デスクトップ アプリケーションまたはブラウザー コンテキストでトークンを要求することを認識できるようにします。 アプリ コンテキスト (client_credentials) にトークンを対話形式で取得するときに要求を含める: AcquireTokenByClientCredential 要求に要求を含める
claims: string
プロパティ値
string
errorNo
サーバー エラー番号。
errorNo?: string
プロパティ値
string
timestamp
エラーが発生した時刻
timestamp: string
プロパティ値
string
traceId
エラーに関連付けられている TraceId
traceId: string
プロパティ値
string
継承されたプロパティの詳細
correlationId
errorCode
errorMessage
message
platformBrokerError
ブローカーが有効になっている場合の MsalNodeRuntime からの既定の PlatformBrokerError
platformBrokerError?: PlatformBrokerError
プロパティ値
AuthError.platformBrokerError から継承
stack
stackTraceLimit
Error.stackTraceLimitの性質は、スタックトレースによって収集されるスタックフレームの数(new Error().stackであれError.captureStackTrace(obj)であれ)を指定します。
デフォルト値は 10 ですが、有効なJavaScript番号に設定することができます。 変更は、値が変更 された後に キャプチャされたスタックトレースに影響を与えます。
非数値値、または負数に設定した場合、スタックトレースはフレームをキャプチャしません。
static stackTraceLimit: number
プロパティ値
number
AuthError.stackTraceLimitから継承
subError
継承済みメソッドの詳細
captureStackTrace(object, Function)
.stackにtargetObjectプロパティを作成し、アクセスするとError.captureStackTrace()が呼び出されたコード内の位置を表す文字列を返します。
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
トレースの最初の行は ${myObject.name}: ${myObject.message}で接頭辞付きになります。
オプションの constructorOpt 引数は関数を受け入れます。 もし与えられた場合、 constructorOpt以上のフレーム( constructorOptを含む)は生成されたスタックトレースから除外されます。
constructorOptの議論は、エラー発生の実装詳細をユーザーから隠すのに役立ちます。 次に例を示します。
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
static function captureStackTrace(targetObject: object, constructorOpt?: Function)
パラメーター
- targetObject
-
object
- constructorOpt
-
Function
AuthError.captureStackTraceから継承
prepareStackTrace(Error, CallSite[])
「https://v8.dev/docs/stack-trace-api#customizing-stack-traces」を参照してください。
static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any
パラメーター
- err
-
Error
- stackTraces
-
CallSite[]
返品
any
AuthError.prepareStackTraceから継承
setCorrelationId(string)
function setCorrelationId(correlationId: string)
パラメーター
- correlationId
-
string
AuthError.setCorrelationIdから継承