要求プロパティオブジェクト

[アーティクル]
07/26/2024

この記事では、Microsoft Dynamics 365 Commerce での要求プロパティオブジェクトについて説明します。

要求プロパティオブジェクトは HTTP 要求を表し、要求された URL、ロケール、デバイス、ユーザー、クッキー、クエリ文字列パラメーターなど、さまざまなデータプロパティが含まれます。 this.props.context という名前の読み取り専用要求コンテキストオブジェクトにアクセスでき、また、モジュールの動作は必要に応じて変更できます。

例

次の例では、要求コンテキスト内から要求プロパティオブジェクトにアクセスする方法を示します。

if (this.props.context.request.user.isAuthenticated) {
    userName = this.props.context.request.user.signinName ? this.props.context.request.user.signinName : '';
    firstName = this.props.context.request.user.firstName ? this.props.context.request.user.firstName : '';
    lastName = this.props.context.request.user.lastName ? this.props.context.request.user.lastName : '';
}

一般プロパティ

url – 要求された URL。
ロケール ーロケールコンテキスト (たとえば、「en-us」)。
textDirection ーテキストの方向 (使用可能な値は 「rtl」、および 「ltr」という値)。
sitePath ーサイトのフルパス。
デバイス ー要求が送信されたデバイス。
- タイプ ーデバイスタイプ (たとえば「pc」)。
user – ユーザーに関する情報。プロパティは次のとおりです。
- token
- isAuthenticated
- signinURL
- signoutURL
- signUpUrl
- editProfileUrl
- signinName
- 名前
- firstName
- lastName
- emailAddress
- customerAccountNumber
クエリ : – クエリ文字列パラメータの一覧。
クッキー ークッキー情報。

インターフェイス

interface IParsedQSP<TValue> {
    hasValue: boolean;
    isTruthy: boolean;
    value: TValue | undefined;
}

interface IRequestContextUrl {
    serverUrl: string;
    serverPageUrl: string;
    requestUrl: URL;
    staticCdnUrl: string;
}

interface IRequestContextParams {
    mock?: string;
    isDebug: boolean;
    isEditor: boolean;
    concatJs: IParsedQSP<boolean | string | number | undefined>;
    theme: string;
}

interface IRequestContextDevice {
    Type: string;
}

interface IRequestContextUser {
    token: string;
    isAuthenticated: boolean;
    signInUrl?: string;
    signOutUrl?: string;
    signUpUrl?: string;
    editProfileUrl?: string;
    signinName?: string;
    name?: string;
    firstName?: string;
    lastName?: string;
    emailAddress?: string;
    customerAccountNumber?: string;
}

interface IRequestContextFeatures {
    [switchName: string]: boolean;
}

interface IRequestContextHeaders {
    readonly [header: string]: string;
}

interface IRequestContext {
    url: IRequestContextUrl;
    locale: string;
    market?: string;
    textDirection: string;
    sitePath?: string;
    params: IRequestContextParams;
    device: IRequestContextDevice;
    user: IRequestContextUser;
    app: IGeneric<IAny>;
    query?: IDictionary<string>;
    apiSettings: ICommerceApiSettings;
    channel?: IChannelConfiguration;
    gridSettings?: IGridSettings;
    urlTokens: IUrlTokens;
    operationId: string;
    features: IRequestContextFeatures;
    pageData: IGeneric<IAny>;
    headers: IRequestContextHeaders;
    cookies: ICookieContext;
}