iframe-bridge-sdk
Version:
Universal iframe communication SDK - unified package for host and guest applications
54 lines • 1.35 kB
TypeScript
import { BaseMessenger, type Message, type GuestConfig } from './shared';
/**
* Guest SDK - 在iframe中运行,与宿主应用通信
*/
export declare class GuestSDK extends BaseMessenger {
/** 是否在iframe中运行 */
private readonly isInIframe;
/** 目标窗口来源 */
private targetOrigin;
/** 是否已初始化 */
private initialized;
constructor(config?: GuestConfig);
/**
* 初始化Guest SDK
* @param config 配置选项
*/
init(config?: GuestConfig): void;
/**
* 手动发送ready事件
*/
sendReady(): void;
/**
* 检查是否在iframe中运行
*/
isIframe(): boolean;
/**
* 获取目标窗口来源
*/
getTargetOrigin(): string;
/**
* 设置目标窗口来源
* @param origin 目标来源
*/
setTargetOrigin(origin: string): void;
/**
* 实现抽象方法:发送消息到宿主窗口
* @param message 要发送的消息
*/
protected sendMessage(message: Message): void;
/**
* 检测是否在iframe中运行
*/
private detectIframe;
/**
* 设置消息监听器
*/
private setupMessageListener;
/**
* 验证消息来源是否有效
* @param origin 消息来源
*/
private isValidOrigin;
}
//# sourceMappingURL=guest.d.ts.map