Interface Spec

interface Spec {
    activateLicense(
        serialNo: string,
        modules: LicenseModule[],
    ): Promise<ILicenseActivateResult>;
    activeFromFile(): Promise<boolean>;
    clearFileLicense(): Promise<boolean>;
    generateDeviceInfo(): Promise<boolean>;
    getClientUrl(): string;
    getDeviceInfo(): Promise<string>;
    getLicenseInfo(): Promise<ILicenseInfo>;
    getResourceBase(): string;
    initEnvironment(clientPort: null | number): boolean;
    queryLicense(serialNo: string): Promise<ILicenseQueryResult>;
    recycleLicense(): Promise<ILicenseRecycleResult>;
    setLicenseServerUrl(url: string): void;
    setLicenseType(type: "file" | "web"): Promise<boolean>;
}

Hierarchy

TurboModule
- Spec

Index

Methods

activateLicense activeFromFile clearFileLicense generateDeviceInfo getClientUrl getDeviceInfo getLicenseInfo getResourceBase initEnvironment queryLicense recycleLicense setLicenseServerUrl setLicenseType

Methods

activateLicense

activateLicense(
serialNo: string,
modules: LicenseModule[],
): Promise<ILicenseActivateResult>
使用激活码激活在线许可。

先调用 queryLicense 获取该激活码可用的模块，再显式传入本次需要激活的模块。原生层会去重并拒绝空列表、未知模块号以及不含核心模块的请求。
Parameters
- serialNo: string
  iMobile 在线许可激活码
- modules: LicenseModule[]
  本次激活的模块，必须包含 CORE_DEV 或 CORE_RUNTIME
Returns Promise<ILicenseActivateResult>
激活结果；成功后许可落盘并立即通知 Web 侧刷新授权状态

activeFromFile

activeFromFile(): Promise<boolean>
导入 iMobile 文件许可。

调用系统文件选择器选择 .slm 文件，由 mxcore 校验通过后落盘。文件许可与在线许可独立保存；导入成功后切换为文件许可，不会归还或删除在线许可。

Returns Promise<boolean>
选择并成功导入许可时为 true；取消、校验失败或落盘失败时为 false

clearFileLicense

clearFileLicense(): Promise<boolean>
删除本机导入的文件许可。

此方法不会删除或归还在线激活码许可。

Returns Promise<boolean>
文件许可清理成功时为 true

generateDeviceInfo

generateDeviceInfo(): Promise<boolean>
生成设备信息文件。

调用系统文件选择器，由用户选择保存位置。

Returns Promise<boolean>
用户完成保存且写入成功时为 true；取消或写入失败时为 false

getClientUrl

getClientUrl(): string
获取 client web 服务地址

Returns string
client web 服务的地址

getDeviceInfo

getDeviceInfo(): Promise<string>
获取当前设备 ID。

在线激活时 SDK 会把同一设备 ID 作为 macAddress 提交给 iMobile 服务。

Returns Promise<string>
当前设备 ID

getLicenseInfo

getLicenseInfo(): Promise<ILicenseInfo>
获取当前许可信息

Returns Promise<ILicenseInfo>
当前许可信息；没有激活时返回 { license: null }

getResourceBase

getResourceBase(): string
获取 client resource 服务地址

原生资源中存在的 resource.zip 会自动解压，后续可通过此服务地址直接访问包中的资源

Returns string
client resource 服务的地址

initEnvironment

initEnvironment(clientPort: null | number): boolean
初始化环境

启动 RN 原生侧本地 client 服务。传入 null 时使用默认端口。在渲染 MapView 或 SceneView 前调用。
Parameters
- clientPort: null | number
  client 服务运行端口
Returns boolean
是否成功

queryLicense

queryLicense(serialNo: string): Promise<ILicenseQueryResult>
查询激活码可授权的模块及逐模块名额，不消耗名额。
Parameters
- serialNo: string
  iMobile 在线许可激活码
Returns Promise<ILicenseQueryResult>
每个可授权模块的总名额、已用名额和剩余名额

recycleLicense

recycleLicense(): Promise<ILicenseRecycleResult>
归还当前在线许可并释放服务端名额。

只有服务端确认归还或确认该 UUID 已不存在后才清理本地在线许可。

Returns Promise<ILicenseRecycleResult>
归还结果

setLicenseServerUrl

setLicenseServerUrl(url: string): void
配置 iMobile 许可服务地址。
Parameters
- url: string
  服务根地址，或包含 appKey 的完整 activation URL；默认使用 SuperMap 在线许可服务
Returns void

setLicenseType

setLicenseType(type: "file" | "web"): Promise<boolean>
切换为本机已保存的文件许可或在线许可。

校验目标许可有效后持久化选择，并通知已创建的 Controller 刷新授权。不发起激活或归还请求，不合并两份许可的模块。
Parameters
- type: "file" | "web"
  目标许可类型：文件许可 file，在线许可 web。
Returns Promise<boolean>
切换成功返回 true；未初始化、目标许可无效或保存失败返回 false，保持当前选择。