工作台数据接口

获取工作台Banner信息

获取工作台展示的Banner数据。

接口定义

Kotlin

fun getBannerList(callback: KIMISdkLinkupService.ResultCallback1<BannerData>)

参数说明

参数	类型	说明
callback	KIMISdkLinkupService.ResultCallback1<BannerData>	请求完成的回调

代码示例

Kotlin

KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.getBannerList(object : KIMISdkLinkupService.ResultCallback1<BannerData> {
        override fun onSuccess(data: BannerData) {
        }

        override fun onFailed(error: KIMISdkLinkupService.Error) {
        }
    })

获取应用列表

获取工作台应用列表。

接口定义

Kotlin

fun getAppList(
    @AppListType listType: Int,
    offset: Int,
    count: Int,
    callback: KIMISdkLinkupService.ResultCallback1<AppBriefData>
)

参数说明

参数	类型	说明
type	AppListType	请求的app列表类型
offset	Int	列表偏移量
count	Int	请求的app数量
callback	KIMISdkLinkupService.ResultCallback1<AppBriefData?>	请求完成后的回调

代码示例

Kotlin

KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.getAppList(
        AppListType.ALL,
        offset.toInt(),
        20,
        object : KIMISdkLinkupService.ResultCallback1<AppBriefData> {
            override fun onSuccess(data: AppBriefData) {
            }

            override fun onFailed(error: KIMISdkLinkupService.Error) {
            }
        })

获取应用分组列表

获取全部应用的分组信息。

接口定义

Kotlin

fun getAppGroupList(callback: KIMISdkLinkupService.ResultCallback1<AppGroupData>)

参数说明

参数	类型	说明
callback	KIMISdkLinkupService.ResultCallback1<AppGroupData>	请求完成的回调

代码示例

Kotlin

KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.getAppGroupList(object : KIMISdkLinkupService.ResultCallback1<AppGroupData> {
        override fun onSuccess(data: AppGroupData) {
        }

        override fun onFailed(error: KIMISdkLinkupService.Error) {
        }
    })

获取指定分组下的应用列表

获取指定分组下的应用信息。

接口定义

Kotlin

fun getAppListByGroupId(
    groupId: Long,
    offset: Int,
    count: Int,
    callback: KIMISdkLinkupService.ResultCallback1<AppBriefData>
)

参数说明

参数	类型	说明
groupId	Int	分组ID
offset	Int	列表索引偏移值，用于分页加载。如每页获取100条数据，则获取第二页是传100
count	Int	分页拉取每页数量，最大值100
callback	KIMISdkLinkupService.ResultCallback1<AppBriefData>	请求完成的回调

代码示例

Kotlin

KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.getAppListByGroupId(id, offset, 20,
        object : KIMISdkLinkupService.ResultCallback1<AppBriefData> {
            override fun onSuccess(data: AppBriefData) {

            }

            override fun onFailed(error: KIMISdkLinkupService.Error) {
            }

        })

应用设置、取消常用

将应用设置为常用或取消常用。

接口定义

Kotlin

fun setAppFavorite(
    appId: String,
    isFavorite: Boolean,
    callback: KIMISdkLinkupService.ResultCallback1<Boolean>
)

参数说明

参数	类型	说明
appId	String	应用ID
isFavorite	Boolean	true为添加常用； false为取消常用；
callback	KIMISdkLinkupService.ResultCallback1<Boolean>	请求完成的回调

代码示例

Kotlin

KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.setAppFavorite(
        appBrief.appId,
        true,
        object : KIMISdkLinkupService.ResultCallback1<Boolean> {
            override fun onSuccess(isSuccess: Boolean) {
            }
   
            override fun onFailed(error: KIMISdkLinkupService.Error) {
            }
        })

打开应用

打开应用详情。

接口定义

Kotlin

fun openApp(activity: Activity, appId: String)

参数说明

参数	类型	说明
activity	Activity	/
appId	String	应用ID

代码示例

Kotlin

val appId = "AK202208104849"
KIM.getService().getLinkUpService(KIMSdkWorkSpaceService::class.java)
    ?.openApp(it, appId)

下载工作台应用离线包

接口定义

Kotlin

class KIMSdkWorkSpaceService {
    /**
    * 下载托管包
    * @param appId 应用ID
    * @param version 托管包版本，null为最新包
    */
    fun downloadPackage(appId: String, version? = null): KIMDownloadTask
}

Kotlin

interface KIMDownloadTask {
    /**
    * 设置下载监听
    * @param listener 监听者
    */
    fun setListener(listener: KIMDownloadListener)
    
    /**
    * 取消下载
    */
    fun cancel()
}

Kotlin

interface KIMDownloadListener {
    fun onProgress(downloadedBytes: Int, totalBytes: Int)
    fun onSuss(path: String)
    fun onFail(error: KIMError)
}

参数说明

参数	类型	说明
appId	String	要下载的离线包对应的应用ID。
version	String？	要下载的离线包指定版本，不传则为最新版本。

KIMDownloadTask说明：

属性/方法	类型	说明
setListener		监听下载进度，下载结果，以及下载错误。
cancel		取消当前的下载任务。

KIMDownloadListener说明：

方法	参数	返回值	说明
onProgress	• downloadedBytes: Int 已经下载的字节数。• totalBytes: Int总字节数。	Void	下载进度回调方法。
onSuss	• path: String下载后的临时文件位置。	Void	下载完成后的回调方法。
onFail	当前下载任务。• error: KIMError错误信息。	Void	下载错误的回调方法。

代码示例

Kotlin

//下载最新版本托管包
val task = KIM.getService().getLinkUpService(KIMISdkWorkSpaceService::class.java)
    ?.downloadPackage("AK20241819323")
//下载指定版本托管包
val task2 = KIM.getService().getLinkUpService(KIMISdkWorkSpaceService::class.java)
    ?.downloadPackage("AK20241819323", "1.0.3")
//设置托管包下载监听
task.setListener(object: KIMDownloadListener {
    fun onProgress(downloadedBytes: Int, totalBytes: Int) {
        //更新进度
    }
    fun onSuss(path: String) {
        //下载成功    
    }
    fun onFail(error: KIMError) {
        //下载失败    
    }
})
//取消托管包下载
task.cancel()