ryuu.js/dist/models/services/filters.d.ts

Ryuu JavaScript Utility Library

import { Filter } from "../interfaces/filter";
/**
 * Sends filter data to the parent window or to the iOS webkit message handler.
 *
 * @this {Domo} - The Domo instance context.
 * @param filters - An array of Filter objects or null.
 * @param pageStateUpdate - Optional boolean indicating if the page state should be updated.
 * @param onAck - Callback function to be called when the filters are acknowledged.
 * @param onReply - Callback function to be called when the filters are replied.
 */
export declare function requestFiltersUpdate(filters: Filter[] | null, pageStateUpdate?: boolean | null, onAck?: Function, onReply?: Function): string;
/**
 * Registers a callback to be invoked when filters are updated.
 * NOTE: this references the Domo object, so it should be called in the context of Domo.
 *
 * @this {Domo} - The Domo instance context.
 * @param callback - The function to call when filters are updated.
 * @returns A function to unregister the callback.
 */
export declare function onFiltersUpdated(callback: Function): () => void;
/**
 * Handles the updated filters message.
 *
 * @this {Domo} - The Domo instance context.
 * @param message - The message containing updated filters.
 * @param responsePort - The port to send the response back.
 * @returns void
 */
export declare function handleFiltersUpdated(message: any, responsePort?: MessagePort): void;