SlugTeam

# API

# Base 基础

# isMock 是否为模拟测试

newSlugSDK 会根据传入的 env 变量选择 release 版本还是 debug 版本。
在传入的env变量为debug时，isMock()会返回为true，反之在变量为release时，isMock()会返回为false。

# Returns

说明 类型
是否为 模拟测试 Boolean

# Demo

newSlugSDK.isMock()
1

# isSlugSDK 是否为SlugSDK

# Returns

说明 类型
是否为 Slug SDK Boolean

# Demo

newSlugSDK.isSlugSDK()
1

# Device 设备

# getSystemType 获取系统类型

# Returns

说明 类型
系统类型: 0（iOS），1（Android） Number

# Demos

newSlugSDK.getSystemType()
1

# getDiviceInfo 获取设备信息

Android 下当 "usedMemory + 新分配的内存 ≥ memoryUpperLimit" 就会出现 OOM（out of memory），iOS 下当 "usedMemory / physicalMemory ≥ 百分比值（不同系统这个值不一样）" 时进程会被杀死：参考文献

Android 下的 CPU 使用率 = (这次获取的 processCpuTime - 上次获取的 processCpuTime) / (这次获取的 totalCpuTime - 上次获取的 totalCpuTime)

# Returns

说明 类型
设备信息 String

# Demo

// Android：'{"osSystem":"", "osVersion":"", "deviceModel":"", "deviceName":"", "deviceTradeMark":"", "deviceManufacturer":"", "uid":"", "memoryUpperLimit":进程的内存上限（单位为K）, "usedMemory":当前进程占用内存（单位为K）, "processCpuTime":当前进程占用的CPU时间, "totalCpuTime":总的CPU时间, "dalvikMemory":Java代码占用的内存（单位为K）, "nativeMemory":C/C++代码占用的内存（单位为K）, "otherMemory":其他内存（单位为K）}'
// iOS: '{"osSystem":"", "osVersion":"", "deviceModel":"", "uid":"", "deviceName":"", "physicalMemory":手机总的内存（单位为K）, "usedMemory":当前进程占用内存（单位为K）, "cpuUsageRatio":当前进程的CPU使用率（不带百分号的数值，如：3.1表示3.1%）}'

newSlugSDK.getDeviceInfo()
1
2
3
4

# hasNotchScreen 是否有刘海

# Returns

说明 类型
是否有刘海 Boolean

# Demo

newSlugSDK.hasNotchScreen()
1

# getNotchHeight 获取刘海高度

# Returns

说明 类型
获取刘海高度 Number

# Demo

newSlugSDK.getNotchHeight()
1

# Network 网络

# getNetworkType 获取网络类型

# Returns

说明 类型
网络类型: "NO NETWORK"、"WIFI"、"4G"、"3G"、"2G"、"UNKNOWN NETWORK" String

# Demo

newSlugSDK.getNetworkType()
1

# fetch 获取网络请求与响应

# Params

名称 说明 类型 默认值 可选值 版本
url 网络请求的Url String
method 请求方式 String GET / POST / PUT / DELETE
dataType 数据类型 String json / jsonp
callbackFnName 回调函数名称（只在dataType 为 jsonp 时可用） String
headers 请求头 String
data 数据 String

# Returns

说明 类型
网络请求与响应获取信息 String

# Demo

newSlugSDK.fetch()
1

# Open 开放接口

# getAccountType 获取账户类型

# Returns

说明 类型
账户类型: 1（微信），2（QQ） Number

# Demo

newSlugSDK.getAccountType()
1

# login 获取登录凭证

# Returns

说明 类型
登录凭证（code) String

# Demo

newSlugSDK.login()
1

# getUserInfo 获取用户信息

# Params

名称 说明 类型 默认值 可选值 版本
avatar 用户头像URL String
name 用户名称 String

# Returns

说明 类型
用户信息 String

# Demo

newSlugSDK.getUserInfo()
1

# report

该接口还在调试中...

# Params

名称 说明 类型 默认值 可选值 版本
event 自定义上报活动参数 String

# Router 路由

# reLaunch 重新加载

reLaunch的参数值可以选择想要跳转到的url地址，或者path和query组成的参数组。

# Params

名称 说明 类型 默认值 可选值 版本
path 跳转地址 String
query 跳转规则 String 可选

# Demo

//pass by url
newSlugSDK.reLaunch('url')

//or pass by path and querky
newSlugSDK.reLaunch(
    'path', 
    'query'
)
1
2
3
4
5
6
7
8

navigateTo的参数值可以选择想要跳转到的url地址，或者path和query组成的参数组。

# Params

名称 说明 类型 默认值 可选值 版本
path 跳转地址 String
query 跳转规则 String 可选

# Demo

//pass by url
newSlugSDK.navigateTo('url')

//or pass by path and querky
newSlugSDK.navigateTo(
    'path', 
    'query'
)
1
2
3
4
5
6
7
8

# redirectTo 跳转到

redirectTo的参数值可以选择想要跳转到的url地址，或者path和query组成的参数组。

# Params

名称 说明 类型 默认值 可选值 版本
path 跳转地址 String
query 跳转规则 String 可选

# Demo

//pass by url
newSlugSDK.redirectTo('url')

//or pass by path and querky
newSlugSDK.redirectTo(
    'path', 
    'query'
)
1
2
3
4
5
6
7
8

navigateBack中的delta参数为可选值。

# Params

名称 说明 类型 默认值 可选值 版本
delta 返回上一应用参数 Number 可选

# Demo

newSlugSDK.navigateBack(delta)
1

# close 关闭

关闭微应用sdk

# Demo

newSlugSDK.close()
1

navigateToMiniProgram中的query 参数为可选值。

# Params

名称 说明 类型 默认值 可选值 版本
path 跳转地址 String
query 跳转规则 String 可选
appId appID String

# Demo

newSlugSDK.navigateToMiniProgram(
    'path', 
    'query',
    'appId'
)
1
2
3
4
5

# Params

名称 说明 类型 默认值 可选值 版本
url URL跳转地址 String

# Demo

newSlugSDK.navigateToH5('url')
1

# Share 转发

# hadInstalled 是否安装了支持指定协议的APP

# Params

名称 说明 类型 默认值 可选值 版本
scheme app 场景值 String

# Returns

说明 类型
安装状态 boolean

# Demo

newSlugSDK.hadInstalled('scheme')
1

# isPlatformInstalled 是否安装了支持指定协议的app(微信与QQ)

# Params

名称 说明 类型 默认值 可选值 版本
PlatformType app 类型: 1（微信），2（QQ） Number

# Returns

说明 类型
安装状态 boolean

# Demo

//是否安装了微信
newSlugSDK.isPlatformInstalled(1)

//是否安装了QQ
newSlugSDK.isPlatformInstalled(2)
1
2
3
4
5

# isInstallWechat 是否安装了微信

# Returns

说明 类型
安装状态 boolean

# Demo

newSlugSDK.isInstallWechat()
1

# isInstallQQ 是否安装了QQ

# Returns

说明 类型
安装状态 boolean

# Demo

newSlugSDK.isInstallQQ()
1

# shareToWechat 分享到微信

注意： 微信结构化分享 -> 目前只有斗地主有，基于 msdk,slugsdk 无此能力。

# Params

名称 说明 类型 默认值 可选值 版本
title 分享标题 String "" 可选
desc 分享描述 String "" 可选
imgUrl 分享略缩图URL String ""
scene 场景值: 1（微信朋友圈），2（微信好友） Number 可选
url 分享链接 String "" 可选

# Demo

newSlugSDK.shareToWechat(
    'title',  
    'desc',
    'imgUrl',  // 必须以 `https://` 开头，图片的大小不能超过32K
    'scene',
    'url'
)
1
2
3
4
5
6
7

# shareToQQ 分享到QQ

# Params

名称 说明 类型 默认值 可选值 版本
title 分享标题 String "" 可选
desc 分享描述 String "" 可选
imgUrl 分享略缩图URL String ""
scene 场景值: 1（QQ空间），2（QQ好友） Number 可选
url 分享链接 String "" 可选

# Demo

newSlugSDK.shareToQQ(
    'title',  
    'desc',
    'imgUrl',  // 必须以 `https://` 开头，图片的大小不能超过32K
    'scene',
    'url'
)
1
2
3
4
5
6
7

# openMiniProgram 打开小程序

# Params

名称 说明 类型 默认值 可选值 版本
id 小程序 app id String
path 小程序页面路径 String

# Demo

newSlugSDK.openMiniProgram(
    'id',  
    'path'
)
1
2
3
4

# Storage 数据缓存

# getGlobalData 获取全局数据

# Params

名称 说明 类型 默认值 可选值 版本
key 公钥 String

# Returns

说明 类型
全局数据缓存 undefined

# Demo

newSlugSDK.getGlobalData('key')
1

# setGlobalData 设置全局数据

# Params

名称 说明 类型 默认值 可选值 版本
key 公钥 String
value 数据值 String 可选

# Demo

newSlugSDK.setGlobalData(
    'key',  
    'value'
)
1
2
3
4

# getStorage 获取持久数据

# Params

名称 说明 类型 默认值 可选值 版本
key 公钥 String

# Returns

说明 类型
持久数据缓存 undefined

# Demo

newSlugSDK.getStorage('key')
1

# setStorage 设置持久数据

# Params

名称 说明 类型 默认值 可选值 版本
key 公钥 String
value 数据值 String 可选

# Demo

newSlugSDK.setStorage(
    'key',  
    'value'
)
1
2
3
4

# removeStorage 移除数据缓存

# Params

名称 说明 类型 默认值 可选值 版本
key 公钥 String

# Demo

newSlugSDK.removeStorage('key')
1

# clearStorage 清除所有数据缓存

# Demo

newSlugSDK.clearStorage()
1

# getStorageInfo 获取数据缓存信息

# Returns

说明 名称 类型
keys 数据密钥 String
currentSize 目前占用的空间大小(B) Number
limitSize 限制的空间大小(B) Number

# Demo

newSlugSDK.getStorageInfo()
1

# Media 媒体

# 敬请期待


# UI 界面

# 敬请期待