Class CoreStatelessRequest

constructor

• new CoreStatelessRequest(
      core: CoreStateless,
      options: CoreStatelessForRequestOptions,
  ): CoreStatelessRequest

  Parameters

  • core: CoreStateless
  • options: CoreStatelessForRequestOptions

  Returns CoreStatelessRequest

ReadonlycanPersistProfile

profile

• get profile(): { id: string; [key: string]: JSONType } | undefined

  Current request profile, updated after Experience responses.

  Returns { id: string; [key: string]: JSONType } | undefined

  • { id: string; [key: string]: JSONType }

    • [key: string]: JSONType

    • id: string

      Identifier of the profile.

      Remarks

      Used to associate events with an existing profile.

  • undefined

fetchContentfulEntries

• fetchContentfulEntries<
      S extends EntrySkeletonType = EntrySkeletonType,
      L extends string = string,
  >(
      entries: readonly ManagedEntryDescriptor[],
  ): Promise<Entry<S, undefined, L>[]>

  Fetch Contentful entries through the parent SDK's configured contentful.js client.

  Type Parameters

  • S extends EntrySkeletonType = EntrySkeletonType
  • L extends string = string

  Parameters

  • entries: readonly ManagedEntryDescriptor[]

  Returns Promise<Entry<S, undefined, L>[]>

  Remarks

  If contentful.defaultQuery and a descriptor's entryQuery omit locale, this request's locale becomes the managed Contentful query locale.

fetchContentfulEntry

• fetchContentfulEntry<
      S extends EntrySkeletonType = EntrySkeletonType,
      L extends string = string,
  >(
      entryId: string,
      query?: ContentfulEntryQuery,
  ): Promise<Entry<S, undefined, L>>

  Fetch a Contentful entry by ID or by content type and slug through the parent SDK's configured contentful.js client.

  Type Parameters

  • S extends EntrySkeletonType = EntrySkeletonType
  • L extends string = string

  Parameters

  • entryId: string
  • Optionalquery: ContentfulEntryQuery

  Returns Promise<Entry<S, undefined, L>>

  Remarks

  Set entryQuery on an object descriptor to customize its query. If contentful.defaultQuery and the descriptor's entryQuery or per-call query omit locale, this request's locale becomes the managed Contentful query locale. Entry IDs use getEntry() or a coalesced getEntries() call; descriptors that identify entries by content type and slug use getEntries().

• fetchContentfulEntry<
      S extends EntrySkeletonType = EntrySkeletonType,
      L extends string = string,
  >(
      descriptor:
          | {
              contentType?: undefined;
              entryId: string;
              entryQuery?: ContentfulEntryQuery;
              slug?: undefined;
              slugField?: undefined;
          }
          | {
              contentType: string;
              entryId?: undefined;
              entryQuery?: ContentfulEntryQuery;
              slug: string;
              slugField?: string;
          },
  ): Promise<Entry<S, undefined, L>>

  Fetch a Contentful entry by ID or by content type and slug through the parent SDK's configured contentful.js client.

  Type Parameters

  • S extends EntrySkeletonType = EntrySkeletonType
  • L extends string = string

  Parameters

  • descriptor:
        | {
            contentType?: undefined;
            entryId: string;
            entryQuery?: ContentfulEntryQuery;
            slug?: undefined;
            slugField?: undefined;
        }
        | {
            contentType: string;
            entryId?: undefined;
            entryQuery?: ContentfulEntryQuery;
            slug: string;
            slugField?: string;
        }

  Returns Promise<Entry<S, undefined, L>>

  Remarks

  Set entryQuery on an object descriptor to customize its query. If contentful.defaultQuery and the descriptor's entryQuery or per-call query omit locale, this request's locale becomes the managed Contentful query locale. Entry IDs use getEntry() or a coalesced getEntries() call; descriptors that identify entries by content type and slug use getEntries().

fetchOptimizedEntry

• fetchOptimizedEntry<
      S extends EntrySkeletonType = EntrySkeletonType,
      L extends string = string,
  >(
      entryId: string,
      options?: FetchOptimizedEntryOptions,
  ): Promise<FetchOptimizedEntryResult<S, undefined, L>>

  Fetch a Contentful entry by ID or by content type and slug, then resolve it with request-local selected optimizations.

  Type Parameters

  • S extends EntrySkeletonType = EntrySkeletonType
  • L extends string = string

  Parameters

  • entryId: string
  • Optionaloptions: FetchOptimizedEntryOptions

  Returns Promise<FetchOptimizedEntryResult<S, undefined, L>>

  Remarks

  If options.selectedOptimizations is omitted, this uses the latest selected optimizations returned by an accepted request-bound Experience API call. Set entryQuery on an object descriptor to customize its query. If contentful.defaultQuery and the descriptor's entryQuery or per-call query omit locale, this request's locale becomes the managed Contentful query locale. Fetching follows the same getEntry() and getEntries() behavior as CoreStatelessRequest.fetchContentfulEntry.

• fetchOptimizedEntry<
      S extends EntrySkeletonType = EntrySkeletonType,
      L extends string = string,
  >(
      descriptor:
          | {
              contentType?: undefined;
              entryId: string;
              entryQuery?: ContentfulEntryQuery;
              slug?: undefined;
              slugField?: undefined;
          }
          | {
              contentType: string;
              entryId?: undefined;
              entryQuery?: ContentfulEntryQuery;
              slug: string;
              slugField?: string;
          },
      options?: Omit<FetchOptimizedEntryOptions, "query">,
  ): Promise<FetchOptimizedEntryResult<S, undefined, L>>

  Fetch a Contentful entry by ID or by content type and slug, then resolve it with request-local selected optimizations.

  Type Parameters

  • S extends EntrySkeletonType = EntrySkeletonType
  • L extends string = string

  Parameters

  • descriptor:
        | {
            contentType?: undefined;
            entryId: string;
            entryQuery?: ContentfulEntryQuery;
            slug?: undefined;
            slugField?: undefined;
        }
        | {
            contentType: string;
            entryId?: undefined;
            entryQuery?: ContentfulEntryQuery;
            slug: string;
            slugField?: string;
        }
  • Optionaloptions: Omit<FetchOptimizedEntryOptions, "query">

  Returns Promise<FetchOptimizedEntryResult<S, undefined, L>>

  Remarks

  If options.selectedOptimizations is omitted, this uses the latest selected optimizations returned by an accepted request-bound Experience API call. Set entryQuery on an object descriptor to customize its query. If contentful.defaultQuery and the descriptor's entryQuery or per-call query omit locale, this request's locale becomes the managed Contentful query locale. Fetching follows the same getEntry() and getEntries() behavior as CoreStatelessRequest.fetchContentfulEntry.

identify

• identify(
      payload: {
          campaign?: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          };
          locale?: string;
          location?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          };
          page?: {
              path: string;
              query: Record<string, string>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          };
          screen?: { name: string; [key: string]: JSONType };
          traits?: Record<string, JSONType>;
          userAgent?: string;
          userId: string;
      },
  ): Promise<EventEmissionResult>

  Parameters

  • payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        traits?: Record<string, JSONType>;
        userAgent?: string;
        userId: string;
    }

  Returns Promise<EventEmissionResult>

page

• page(
      payload?: {
          campaign?: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          };
          locale?: string;
          location?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          };
          page?: {
              path: string;
              query: Record<string, string>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          };
          properties?: {
              path?: string;
              query?: Record<string, string>;
              referrer?: string;
              search?: string;
              title?: string;
              url?: string;
              [key: string]: JSONType;
          };
          screen?: { name: string; [key: string]: JSONType };
          userAgent?: string;
      },
  ): Promise<EventEmissionResult>

  Parameters

  • payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        properties?: {
            path?: string;
            query?: Record<string, string>;
            referrer?: string;
            search?: string;
            title?: string;
            url?: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
    } = {}

  Returns Promise<EventEmissionResult>

prefetchManagedEntries

• prefetchManagedEntries(
      entries: readonly ManagedEntryDescriptor[],
  ): Promise<ManagedEntryHandoff[]>

  Prefetch Contentful entries and return request-local handoff payloads for framework SSR.

  Parameters

  • entries: readonly ManagedEntryDescriptor[]

  Returns Promise<ManagedEntryHandoff[]>

screen

• screen(
      payload: {
          campaign?: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          };
          locale?: string;
          location?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          };
          name: string;
          page?: {
              path: string;
              query: Record<string, string>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          };
          properties: Record<string, JSONType>;
          screen?: { name: string; [key: string]: JSONType };
          userAgent?: string;
      },
  ): Promise<EventEmissionResult>

  Parameters

  • payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        name: string;
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        properties: Record<string, JSONType>;
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
    }

  Returns Promise<EventEmissionResult>

track

• track(
      payload: {
          campaign?: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          };
          event: string;
          locale?: string;
          location?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          };
          page?: {
              path: string;
              query: Record<string, string>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          };
          properties?: Record<string, JSONType>;
          screen?: { name: string; [key: string]: JSONType };
          userAgent?: string;
      },
  ): Promise<EventEmissionResult>

  Parameters

  • payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        event: string;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        properties?: Record<string, JSONType>;
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
    }

  Returns Promise<EventEmissionResult>

trackClick

• trackClick(payload: ClickBuilderArgs): Promise<void>

  Parameters

  • payload: ClickBuilderArgs

  Returns Promise<void>

trackFlagView

• trackFlagView(
      payload: {
          campaign?: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          };
          componentId: string;
          experienceId?: string;
          locale?: string;
          location?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          };
          page?: {
              path: string;
              query: Record<string, string>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          };
          screen?: { name: string; [key: string]: JSONType };
          userAgent?: string;
          variantIndex?: number;
          viewDurationMs?: number;
          viewId?: string;
      },
  ): Promise<void>

  Parameters

  • payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        componentId: string;
        experienceId?: string;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
        variantIndex?: number;
        viewDurationMs?: number;
        viewId?: string;
    }

  Returns Promise<void>

trackHover

• trackHover(payload: HoverBuilderArgs): Promise<void>

  Parameters

  • payload: HoverBuilderArgs

  Returns Promise<void>

trackView

• trackView(
      payload:
          | StatelessStickyTrackViewPayload
          | StatelessNonStickyTrackViewPayload,
  ): Promise<EventEmissionResult>

  Parameters

  • payload: StatelessStickyTrackViewPayload | StatelessNonStickyTrackViewPayload

  Returns Promise<EventEmissionResult>