import { Unsubscribe } from '@alicloud/console-base-messenger-base'; import { AddMicroBrowserVisibilityEventtListenerOptions } from '@alicloud/console-base-messenger-micro-browser-portal'; import { SubscribeMicroHelpVisibleChange } from './visible-change'; type TOpenHelpOptions = AddMicroBrowserVisibilityEventtListenerOptions; export type { TOpenHelpOptions as OptionsOpenHelp }; /** * 业务方主动调用,发出「开启微文档」消息,需保证先 subscribe,后 broadcast。 * * PS:因旧的消息处理方案缺陷,此临时方式会有消息冗余,待后续统一优化。 * 1. openHelp 先于 onOpenHelp 执行,直接 broadcast 失效,HELP_READY 消息监听回调的 broadcast 生效。 * 2. openHelp 后于 onOpenHelp 执行,直接 broadcast 生效,HELP_READY 消息监听回调不会被执行。 * * @param url 文档链接地址 * @param options「微文档显隐」回调配置,如果传入函数,您需要自己处理相应的事件 * @param once 是否只监听一次相应的「微文档显隐」回调,默认为 false */ export declare function openHelp(url: string, options?: TOpenHelpOptions | SubscribeMicroHelpVisibleChange, once?: boolean): Unsubscribe | undefined; /** * CB 应用发出「微文档准备就绪」消息 * CB 应用监听「开启微文档」消息 */ export declare function onOpenHelp(fn: (url: string) => void): Unsubscribe;