wgappsdk/dist/types/native.d.ts

WarGaming App SDK for WebView communication

/** 网络状态 */
declare enum NetStatus {
    "NONE" = "NONE",
    "WIFI" = "WIFI",
    "2G" = "2G",
    "3G" = "3G",
    "4G" = "4G",
    "5G" = "5G"
}
/**
 * 原生方法枚举
 * @description 用于调用原生App方法的枚举类型
 */
export declare enum JumpMethod {
    /** 显示 webview 的页面的标题 */
    "SHOWTITLE" = "showTitle",
    /** 委托客户端使用加密方式请求服务端，并把结果返回给 H5 */
    "ENCODECALLURLSYNC" = "encodeCallUrlSync",
    /** 使用客户端打开一个网页，在当前网页，不重新打开一个 webview 窗口 */
    "OPENH5URL" = "openH5Url",
    /** 使用客户端打开一个网页，使用新的 webview 窗口打开 */
    "OPENNEWH5URL" = "openNewH5Url",
    /** 使用客户端输出网页 log */
    "SHOWH5LOG" = "showH5Log",
    /** 获取当前网络状态，传入的参数如下，返回网络状态字符串：NONE, WIFI, 2G, 3G, 4G, 5G */
    "GETNETSTATUS" = "getNetStatus",
    /** 显示网络错误页面 */
    "SHOWNETERRORUI" = "showNetErrorUi",
    /** 显示 webview 的页面的小标题 */
    "SHOWSUBTITLE" = "showSubTitle",
    /** 通过客户端跳转一个页面，可以跳转到客户端指定的页面，如：坦克详情页、普通 webview 页面、战斗周报页面 */
    "JUMPTOUI" = "jumpToUi",
    /** 通过客户端跳转分享 */
    "JUMPTOSHARE" = "jumpToShare",
    /** 通过客户端修改排行榜筛选页面顶部状态栏以及title栏的背景色值 */
    "JUMPTORANKFILTER" = "jumpToRankFilter",
    /** 通过客户端展示分享按钮 */
    "SHAREBTNISSHOW" = "shareBtnIsShow",
    /** 获取当前登录用户登录平台 */
    "GETCURUSERPLAT" = "getCurUserPlat",
    /** 调起当前登录页面 */
    "JUMPTOLOGIN" = "jumpToLogin",
    /** 获取当前 app 版本信息 */
    "GETCURVERSION" = "getCurVersion",
    /** 修改 webview 的顶部 title 栏相关的 style */
    "TITLEBARSTYLEMOTIFY" = "titleBarStyleMotify",
    /** 预览大图 */
    "JUMPIMAGEBROWSEPAGE" = "JumpImageBrowsePage",
    /** 图片保存到本地 */
    "SAVEIMAGETOGALLERY" = "SaveImageToGallery",
    /** 关闭页面 */
    "FINISHWEB" = "finishWeb",
    /** 调起 APP 输入框（资讯类） */
    "OPENINPUTVIEW" = "openInputView",
    /** 调起 APP 输入框（论坛） */
    "OPENINPUTVIEWFORUM" = "openInputViewForum",
    /** 调起发帖编辑器(论坛) */
    "OPENEDITORFORUM" = "openEditorForum",
    /** 插入投票 */
    "PUSHFORUMVOTE" = "pushForumVote",
    /** 插入单场战绩 */
    "PUSHFORUMRECORD" = "pushForumRecord",
    /** 获取社区绑定后的token，请求社区相关接口使用 */
    "GETCOMMUNITYTOKEN" = "getCommmunityToken",
    /** 编辑头像 */
    "EDITAVATARFORUM" = "editAvatarForum",
    /** 振动 */
    "VIBRATE" = "vibrate",
    /** 获取系统信息 */
    "GETDEVICECONFIGURE" = "getDeviceConfigure",
    /** 调起选择菜单 */
    "OPENSELECT" = "openSelect",
    /** 调起模态框 */
    "OPENMODAL" = "openModal",
    /** 打开视频播放页 */
    "VIDEOPLAYER" = "jumpToVideoPlayer",
    /** 广播消息到其他 webview */
    "PUSHMESSAGE" = "pushMessage",
    /** 获取APP当前登录的用户信息 */
    "GETAPPUSERINFO" = "getAppUserInfo",
    /** 调起弹层 */
    "FULLDIALOG" = "fullDialog",
    /** 旋转屏幕 */
    "SETREQUESTEDORIENTATION" = "setRequestedOrientation"
}
/** 振动等级 */
declare enum VibrateLevel {
    "LIGHT" = "light",
    "MEDIUM" = "medium",
    "HEAVY" = "heavy"
}
export declare enum AppNetMethod {
    "GET" = "get",
    "POST" = "post"
}
/** jumpToUi 跳转类型 */
export declare enum JumpType {
    "WEBLINK" = "weblink",
    "CMSDETAIL" = "cmsdetail",
    "INSIDELINK" = "insidelink",
    "WEEKLYLINK" = "weeklylink",
    "RANKFILTERLINK" = "rankfilterlink",
    "OPENCLIENT" = "openclient"
}
interface IRightIcon {
    /** 是否显示右上角的搜索按钮  0：隐藏 1：显示 */
    show_search_icon?: string;
    /** 是否显示右上角的筛选按钮  0：隐藏 1：显示 */
    show_filter_icon?: string;
    /** 是否显示右上角的分享按钮  0：隐藏 1：显示 */
    show_share_icon?: string;
}
interface IBgColor {
    startColor: string;
    endColor: string;
}
interface ITitleBarStyle {
    right_icon?: IRightIcon;
    /** 是否显示返回按钮  0：隐藏 1：显示 */
    show_back_icon?: string;
    /** 所有icon是否白色系  0：黑色  1：白色 */
    icon_is_white?: string;
    /** 是否隐藏顶部title栏  0：显示  1：隐藏 */
    hide_title_bar?: string;
    /** V1.2.5版本新增设置顶部电池导航栏背景 */
    status_bar_color?: string;
    /** 背景色 */
    bg_color?: IBgColor;
    /** 是否能点击返回按钮 1:可以 0：不可以 */
    response_back_click?: string;
    /** 是否能滑动返回 1:可以 0：不可以 */
    swipe_back?: string;
    /** 是否显示标题栏 1:显示 0：不显示 */
    isHiddenStatusBar?: string;
}
/** APP 分享类型 */
export declare enum ShareType {
    /** URL 地址 */
    "URL" = "url",
    /** 页面截图 */
    "SCREENSHOT" = "base64bitmap",
    /** 网络图片 */
    "NETIMG" = "netimg"
}
/** 分享截图图片 */
interface IJumpToShareScreenShotConfig {
    project: "forum";
    type: ShareType;
    bmpKey: "A1";
    bitmap: string;
}
/** 分享图片 */
interface IJumpToShareImageConfig {
    project: "forum";
    type: ShareType;
    imageUrl: string;
}
/** 分享链接 */
interface IJumpToShareLinkConfig {
    project: "forum";
    type: ShareType;
    title: string;
    desc: string;
    iconUrl: string;
    url: string;
}
interface ISelectItem {
    text: string;
    disabled: boolean;
    [key: string]: any;
}
interface IModalBtn {
    text: string;
    textColor: string;
    bgColor: string;
}
interface IVibrate {
    /** 只对 Android 有效，默认 50ms */
    duration: number;
    /** 只对 ios 有效，默认 light */
    level: VibrateLevel;
}
interface IOrientation {
    /** 横屏 */
    HORIZONTAL: '2';
    /** 竖屏 */
    VERTICAL: '1';
}
interface IAppListenReturn {
    biz: string;
    errno: number;
    errmsg: string;
}
interface IComment extends IAppListenReturn {
    data: string;
    images: string;
    gamedata: {
        battledata30d: string;
    };
}
interface ISelected extends IAppListenReturn {
    data: {
        selectedVal: string;
        [key: string]: any;
    };
}
interface IPushMessage extends IAppListenReturn {
    data: {
        [key: string]: string | number | object;
    };
}
interface IListTop extends IAppListenReturn {
    data: {
        [key: string]: string | number | object;
    };
}
interface IModal extends IAppListenReturn {
    data: {
        modalValue: string;
    };
}
export { NetStatus, VibrateLevel };
export type { IRightIcon, IBgColor, ITitleBarStyle, IJumpToShareScreenShotConfig, IJumpToShareImageConfig, IJumpToShareLinkConfig, ISelectItem, IModalBtn, IVibrate, IOrientation, IComment, ISelected, IModal, IPushMessage, IListTop, IAppListenReturn, };