Application Load
IAppLoadCommonEvents
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IAppLoadCommonEventsPromotional content and its display settings.
src/lib/interfaces/orionplace/appBase/appLoadCommon/IAppLoadCommonEvents.tsexport interface IAppLoadCommonEvents {
// Event identifier. Included in the event object emitted when its image is
// clicked.
id: number;
// Event language code. `EventsBlock` selects events matching
// `store.localeCode`;
// other languages are not substituted.
locale: string;
// Image URL for `desktop`, or `null`. Also the first fallback when the
// selected
// format has no image.
image: string | null;
// Image URL for `wide`, or `null`.
image_wide: string | null;
// Image URL for `tablet`, or `null`.
image_tablet: string | null;
// Image URL for the explicit `account` format, or `null`. Window width never
// selects this format automatically.
image_account: string | null;
// Image URL for `mobile`, or `null`.
image_mobile: string | null;
// `true` when the event has an active promo-code type. `EventEnrollmentDialog`
// can enroll a signed-in customer with a confirmed email through
// `profile_event_subscribe`; enrolling turns the account’s email messages on.
// The response confirms enrollment without returning a code; the store emails
// the code later.
promo: boolean;
// Allows the event in the page carousel. `false` excludes it; an omitted field
// keeps it eligible in `EventsBlock`. Its language must also match.
is_layout?: boolean;
// Allows a separate modal display without overriding `is_layout`. Application
// Load may return `false` for a signed-in customer who already received a code
// of the linked promo type. `EventsBlock` does not use this flag.
is_modal?: boolean;
// Modal delay in seconds; `0` means no delay. The exact field name is
// `model_delay_sec`. The carousel does not start a timer from this value.
model_delay_sec?: number;
// Maximum modal displays during `modal_display_count_days`; `0` means
// unlimited. `EventsBlock` does not count displays or open a modal.
modal_display_count?: number;
// Display-limit period in days. Minimum and default: `1`. `EventsBlock` does
// not store display history.
modal_display_count_days?: number;
}