Zamok Kiosk API
    Preparing search index...
    • Parameters

      • state: null | string[] = null
      • action:
            | {
                payload: {
                    key: NotificationKey;
                    message: ReactNode;
                    options?: OptionsObject;
                };
                type: "ENQUEUE_SNACKBAR";
            }
            | { payload: number; type: "SESSION_START" }
            | { payload: number; type: "SESSION_END" }
            | { payload: { date: number; source: string }; type: "SESSION_RENEW" }
            | { type: "SESSION_MAX_LENGTH_RENEW" }
            | PayloadAction<"LOGS_UPSERT", LogUpsertPayload<unknown>>
            | PayloadAction<"LOGS_LOAD", LoadPayload>
            | PayloadAction<"LOGS_LOADED", LoadedPayload>
            | PayloadAction<"LOGS_PAGINATE", PaginatePayload>
            | PayloadAction<"LOGS_PAGINATE_ADD_PAGE", AddPagePayload>
            | PayloadAction<"LOGS_PAGINATE_PREPEND_LOGS", PrependLogsPayload>
            | PayloadAction<"LOGS_PAGINATE_GO_NEXT", PaginateAction>
            | PayloadAction<"LOGS_PAGINATE_GO_PREV", PaginateAction>
            | EmptyAction<"SESSION_RESET">
            | PayloadAction<"SESSION_MAX_LENGTH_TIMER_COUNTDOWN", number>
            | EmptyAction<"IS_TOUCH">
            | PayloadAction<"ACCEPT_SPLASH_SCREEN", null | boolean>
            | PayloadAction<"SHOW_SPLASH_SCREEN", boolean>
            | PayloadAction<"OPEN_TIMER_COUNTDOWN_DIALOG", OpenCountdownPayload>
            | PayloadAction<"COUNTDOWN_FINISHED", { type: CountdownDialogTypes }>
            | PayloadAction<"DOWNLOAD_ASSET", string>
            | PayloadAction<"ASSET_DOWNLOADED", DownloadedAP>
            | {}
            | {}
            | {}
            | {}
            | {}
            | {}
            | {}
            | PayloadAction<"LOGS_LOADED", LoadPayload>
            | EmptyAction<"DISABLE_TRANSLATIONS">
            | EmptyAction<"ENABLE_TRANSLATIONS">
            | PayloadAction<"SET_BUTTON_LAYOUT", { columns: number; rows: number }>
            | PayloadAction<"SET_BUTTON_COLS", number>
            | PayloadAction<"ADD_COL_ROW_BUTTONS", number>
            | PayloadAction<"DELETE_COL_ROW_BUTTONS", number>
            | PayloadAction<"SET_BUTTON_ROWS", number>
            | PayloadAction<
                "COPY_HOMEPAGE_TEMPLATE",
                { instanceId: string; settings: Settings },
            >
            | PayloadAction<"SET_ACTIVE_VERSION", string>
            | PayloadAction<
                "UPDATE_BUTTON_GRAPHICS",
                {
                    buttonId?: string;
                    graphic: "image"
                    | "icon"
                    | "backgroundImage";
                    styleProperties: Record<string, string | null>;
                },
            >
            | PayloadAction<"SET_SHOW_LANGUAGE_PICKER", boolean>
            | PayloadAction<"UPDATE_HOMEPAGE_ITEM", { id: EditorId; item: any }>
            | PayloadAction<"SET_SELECT_ALL", boolean>
            | PayloadAction<
                "UPDATE_ALL_CUSTOM_STYLES",
                { buttonId?: string; styleProperties: Record<string, string> },
            >
            | PayloadAction<
                "UPDATE_CUSTOM_STYLES",
                { buttonId?: string; styleProperties: Record<string, string | null> },
            >
            | PayloadAction<"LOG_HOMEPAGE_HISTORY", { doc: Settings; kiosk: string }>
            | PayloadAction<"LOG_BUTTON_PRESS", { label: string; url?: string }>
            | PayloadAction<"UPDATE_CURRENT_VERSION", string>
            | PayloadAction<"DELETE_VERSION", { id: string; name: string }>
            | PayloadAction<"EDIT_VERISON_NAME", { name: string; versionId: string }>
            | PayloadAction<
                "SEARCH_HISTORY",
                { renderModulesId?: string; templateId: TemplateId },
            >
            | EmptyAction<"SHOW_WEBVIEW_NAVBAR">
            | EmptyAction<"HIDE_WEBVIEW_NAVBAR">
            | EmptyAction<"GET_WEATHER_DATA">
            | EmptyAction<"HOMEPAGE_WEBVIEW_BACK">
            | EmptyAction<"CLOSE_HOMEPAGE_WEBVIEW_RELOAD">
            | PayloadAction<"OPEN_HOMEPAGE_WEBVIEW", string>
            | EmptyAction<"CLOSE_HOMEPAGE_WEBVIEW">
            | PayloadAction<"UPDATE_HOMEPAGE_LANGUAGE", string>
            | PayloadAction<"UPDATE_CURRENT_KIOSK", string>
            | PayloadAction<"UPDATE_SETTINGS", Settings>
            | PayloadAction<"UPDATE_KIOSK_TYPE", number>
            | PayloadAction<"UPDATE_CURRENT_URL", string>
            | PayloadAction<"UPDATE_BTN_ACTION_PAYLOAD", any>
            | PayloadAction<"LOAD_HOMEPAGE_ACTIONS", null | HomepageAction[]>
            | PayloadAction<"LOAD_HOMEPAGE_TEMPLATES", undefined | string[]>
            | PayloadAction<"FAVORITE_VERSION", string>
            | PayloadAction<"UPDATE_BUTTON_ICON", HpGraphic>
            | PayloadAction<"UPDATE_BUTTON_FACE_LOCK", boolean>
            | PayloadAction<
                "UPDATE_BUTTON_ICON_SIZE",
                null
                | { applyAll?: boolean; id?: string; size: null | string },
            >
            | PayloadAction<"RESET_TO_DEFAULT_SETTINGS", TemplateId>
            | PayloadAction<"SHOW_ITEM", EditorId>
            | PayloadAction<"HIDE_OR_REMOVE_ITEM", EditorId>
            | EmptyAction<"DESELECT_ITEM">
            | EmptyAction<"REDO_LAST_ACTION">
            | EmptyAction<"UNDO_ALL">
            | PayloadAction<"SELECT_ITEM", SelectAP>
            | PayloadAction<"EDIT_LABEL", string>
            | PayloadAction<"UPDATE_WEATHER_WIDGET", string | WeatherDataPayload>
            | EmptyAction<"UNDO_LAST_ACTION">
            | PayloadAction<"DELETE_ITEM", string[]>
            | PayloadAction<"ADD_ITEM", { id: EditorId; languages: string[] }>
            | EmptyAction<"ADD_SINGLE_ITEM">
            | PayloadAction<"ADD_BUTTONS", number>
            | PayloadAction<"REORDER_ITEMS", Direction>
            | PayloadAction<"SWITCH_WIDGET", WidgetId>
            | PayloadAction<
                "SWITCH_TEMPLATE",
                { renderModulesId?: string; templateId: TemplateId },
            >
            | PayloadAction<"UPDATE_STYLES", UpdateStylesAP>
            | PayloadAction<"SWITCH_VERSIONS", Log>
            | PayloadAction<"HP_BUTTON_PRESS", HpButtonPressAP>
            | PayloadAction<
                "UPDATE_INSTRUCTIONAL_POPUP_PAYLOAD",
                { payload: any; property: string },
            >
            | EmptyAction<"RESET_WEBVIEW">
            | PayloadAction<"SET_MULTI_SELECTED_ITEMS", string[]>
            | PayloadAction<"SECURE_HOMEPAGE_WORKFLOW", { actionTypes: string[] }>

      Returns undefined | null | string[]