WPS Open Platform

https://open.wps.cn/documents/app-integration-dev/
Admin
The WPS Open Platform provides SDKs and APIs for integrating various WPS products and capabilities,...
Tokens:24,517
Snippets:288
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Login Implementation Example

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Usage examples for the login method, handling success and failure callbacks.

```Swift
KIM.shared.login(authCode: authCode, appId: appId) { success, error in
    if success {
        // Sign In成功
    } else {
        // Sign In失败
    }
}
```

```Objective-C
[KIM.shared loginWithAuthCode:authCode appId:appId complete:^(BOOL success, KIMError *error) {
    if (success) {
        // Sign In成功
    } else {
        // Sign In失败
    }
}];
```

--------------------------------

### Integration Usage Examples

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

Example prompts for specific integration tasks including SDK import, initialization, and page integration.

```text
将 WOASDK 导入到新建或已有工程中，完成环境检测与工程配置
```

```text
完成 WOASDK 初始化配置，接入 SSO 授权码登录
```

```text
集成会话列表页面，自定义导航栏样式与页面配置
```

--------------------------------

### Install SDK via Terminal

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Run this command in the terminal to complete the CocoaPods installation.

```Shell
pod install
```

--------------------------------

### Logout Implementation

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Usage examples for signing out and handling the completion callback.

```Swift
KIM.shared.logout{ success, error in
    if success {
        // 退登成功，弹出Sign In界面
    } else {
        // 退登失败，请重试
    }
}
```

```Objective-C
 [KIM.shared logoutWithComplete:^(BOOL success, NSError *error) {
        if success == YES {
            // 退登成功，弹出Sign In界面
        } else {
            // 退登失败，请重试
        }
  }];
```

--------------------------------

### Auto Login Implementation

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Usage examples for triggering an automatic login session.

```Swift
KIM.shared.autoLogin()
```

```Objective-C
[KIM.shared autoLogin];
```

--------------------------------

### KIM.init(application: Application, appKey: String, config: KIMInitConfig)

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/init

Initializes the Teams SDK. This must be called when the application starts.

```APIDOC
## KIM.init

### Description
Initializes the Teams SDK. This method must be called when the application starts to prepare the SDK for use.

### Method
Kotlin Method

### Signature
KIM.init(application: Application, appKey: String, config: KIMInitConfig)

### Parameters
- **application** (Application) - Required - The application instance.
- **appKey** (String) - Required - The App Key obtained from the enterprise management background.
- **config** (KIMInitConfig) - Required - The initialization configuration object.

### KIMInitConfig Properties
- **options** (MutableList<KIMFunConfig>) - Optional - Page configuration items.
- **entryJsonUrl** (String) - Optional - The service entry address for private deployments.
- **allowUnsafeHttps** (Boolean) - Optional - Whether to allow insecure https certificates (default: false).
- **isV7** (Boolean) - Optional - Whether the private service version is V7.
- **subOrigins** (Array<String>?) - Optional - List of domain names for multi-domain intercommunication.
- **appDisplayName** (String?) - Optional - App display name for internal copy display.
```

--------------------------------

### Launch Message List via Activity

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/msg-list/msg_ui

Start the KIMMessageListActivity by passing the generated arguments through an Intent.

```Kotlin
val args = KIMMessageListFragment.defaultArguments(chatId)
val intent = Intent(context, KIMMessageListActivity::class.java)
intent.putExtra(Router.EXTRA_DATA, args)
context.startActivity(intent)
```

--------------------------------

### Register Login Status Monitoring

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Example of registering the current instance as a logout listener.

```Swift
KIM.shared.addLogoutListener(logoutDelegate: self)
```

```Objective-C
[KIM.shared addLogoutListenerWithLogoutDelegate:self];
```

--------------------------------

### Initialize Teams SDK

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/init

The primary method for initializing the SDK when the application starts.

```Kotlin
KIM.init(application: Application, appKey: String, config: KIMInitConfig)
```

--------------------------------

### Forced Logout Implementation

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Usage examples for triggering a forced logout.

```Swift
KIM.shared.forceLogout{

}
```

```Objective-C
[KIM.shared forceLogoutWithComplete:^{

}];
```

--------------------------------

### Configure Online Push Notifications

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/init

Example of implementing KIMCfgNotification to customize notification channels, builders, and intent handling during SDK initialization.

```Kotlin
KIM.init(this, appKey, mutableListOf(
   object : KIMCfgNotification() {
      override fun getIntent(message: KIMCoreMessage): Intent {
         val intent = Intent(application, MainActivity::class.java)
         intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
         val data = "kim://kim.wps.cn/chat?chat_id=" + message.getChatId()
         intent.data = Uri.parse(data)
         return intent
      }

      override fun getNotificationChannels(): List/<NotificationChannel/> {
         return if (Build.VERSION.SDK_INT />= Build.VERSION_CODES.O) {
            val channel = NotificationChannel(
               "kim_message",
               application.getString(R.string.notification_message),
               NotificationManager.IMPORTANCE_HIGH
            )
            val channels: MutableList/<NotificationChannel/> = ArrayList()
            channels.add(channel)
            channels
         } else {
            ArrayList()
         }
      }

      override fun createNotificationBuilder(): NotificationCompat.Builder {
         val builder = NotificationCompat.Builder(application, "kim_message")
         if (Build.VERSION.SDK_INT />= Build.VERSION_CODES.LOLLIPOP) {
            builder.setSmallIcon(R.drawable.ic_notification_logo_transperent)
            builder.color =
               ContextCompat.getColor(application, R.color.color_brand_normal)
         } else {
            builder.setSmallIcon(R.drawable.ic_notification_logo)
         }
         builder.setCategory(NotificationCompat.CATEGORY_MESSAGE)
         return builder
      }

}
))
```

--------------------------------

### Implement OnUserLogoutListener

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Example implementation of the OnUserLogoutListener to handle logout events and perform cleanup.

```kotlin
KIM.getControl().addOnUserLogoutListener(null, object : Control.OnUserLogoutListener {
    override fun onLogout(context: Context, reason: ErrorCode) {
        log("onLogout")
        //清除缓存等
    }
})
```

--------------------------------

### Load SKILL Prompt

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

Use this prompt to instruct an AI agent to read the SKILL file and guide the integration process.

```text
请读取 **/sdk-integration-guide-Android/skills/sdk-integration-guide/SKILL.md，并按该 SKILL 引导我完成 WOASDK 协作中台 android 集成。
```

--------------------------------

### Verify SKILL Loading

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

The AI agent confirms successful loading of the SKILL by starting its response with this specific header.

```text
[开始调用协作中台 WOASDK Android 集成引导 Skill]
```

--------------------------------

### Implement WebSocket Status Listener

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Example implementation of the OnWebSocketStatusChangedListener interface to handle various connection states.

```kotlin
KIM.getControl().addOnWebSocketStatusChangedListener(null, object : Control.OnWebSocketStatusChangedListener {
    override fun onConnecting() {
        WLog.log("[KIM], onWebSocketStatusChanged, onConnecting")
    }

    override fun onConnected() {
        WLog.log("[KIM], onWebSocketStatusChanged, onConnected")
    }

    override fun onReconnected() {
        WLog.log("[KIM], onWebSocketStatusChanged, onReconnected")
    }

    override fun onDisconnected(reason: String?) {
        WLog.log("[KIM], onWebSocketStatusChanged, onDisconnected, reason = $reason")
    }

})
```

--------------------------------

### GET /userInfo

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Retrieves user profile information using a valid access token.

```APIDOC
## GET /userInfo

### Description
Retrieves user profile information using the provided access token.

### Method
GET

### Endpoint
/userInfo

### Query Parameters
- **access_token** (string) - Required - The authorization token credential.

### Response
#### Success Response (200)
- **user_name** (string) - The user's name.
- **union_id** (string) - The user's unique identifier.
- **avatar** (string) - The URL of the user's avatar.
```

--------------------------------

### GET /authorize

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Redirects the user to the authorization page to initiate the third-party account authorization login.

```APIDOC
## GET /authorize

### Description
Redirects the user to the authorization page for third-party account authorization login.

### Method
GET

### Endpoint
/authorize

### Query Parameters
- **client_id** (string) - Required - The client identifier.
- **response_type** (string) - Required - The response type, typically 'code'.
- **redirect_uri** (string) - Required - The callback address for the third-party authorization page.
- **state** (string) - Required - The state parameter field name.
```

--------------------------------

### Invoke Favorites List Interface in Kotlin

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/collect

Example usage for triggering the collection list page using the KIM SDK service.

```Kotlin
KIM.getService().getLinkUpService(KIMISdkCollectService::class.java).switchToCollectListPage(activity, null)
```

--------------------------------

### Authorization Page Request

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Initiates the third-party account authorization login process via a GET request.

```http
GET /authorize?client_id=c1ebe466-1cdc-4bd3-ab69-77c3561b9dee&response_type=code&redirect_uri={:redirect_uri}&state={:state} HTTP/1.1
Host: http://demo.com/
Content-Type: application/x-www-form-urlencoded
```

--------------------------------

### Logout Interface and Usage

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Defines the logout method and provides an example of handling success and error callbacks during the logout process.

```kotlin
fun logout(callback: IOperationCallback?)
```

```kotlin
KIM.getControl().logout(object : IOperationCallback {
    override fun onSuccess() {
        log("logout success")
    }

    override fun onError(err: ErrorCode?) {
        log("logout, error = $err")
    }
})
```

--------------------------------

### Initialize the SDK

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

Initializes the KIM SDK with the application context, app key, and configuration object.

```kotlin
KIM.init(application: Application, appKey: String, config: KIMInitConfig)
```

```kotlin
KIM.init(application, AK, KIMInitConfig().apply {
    entryJsonUrl = "$yourUrl"
    isV7 = true
    appDisplayName = "$yourAppName"
    options = getConfig(application) //初始化页面配置
})
```

--------------------------------

### Configure Top Prompt Bar and Custom Views

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Disable default network tips and implement custom top or header views by overriding specific methods in KIMExpChatListPage.

```swift
KIM.chatModule.chatListConfig.isEnabledChatListNetworkTips = false
```

```kotlin
class CustomPageChatList : KIMExpChatListPage() {

	 	 // Customize Conversation List顶部视图，返回ofCustomize视图会固定在Chats列表顶部与导航栏底部之间，不随Chats列表滚动
    override fun customTopView(context: Context, parent: ViewGroup): View? {
        return ChatListStickView().createStickView(context, parent)
    }

	 	 // Customize Conversation List headerView返回ofCustomize视图会被添加到Chats列表of顶部并跟随列表滚动
    override fun chatListHeaderView(context: Context, parent: ViewGroup): View? {
        return ChatListHeader1().createHeaderView(context, parent)
    }
}
```

--------------------------------

### Integrate GeTui

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure GeTui push by adding the app ID to the manifest and including the SDK dependency.

```xml
<meta-data
     android:name="GETUI_APPID"
     android:value="从个推官方申请到的具体的APPID值" />
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushGetui:0.0.3'
}
```

--------------------------------

### Configure application build.gradle

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/import-sdk

Apply the AGConnect plugin, set manifest placeholders, and declare SDK dependencies.

```groovy
plugins {
    ...
    // 华为离线推送插件
    id 'com.huawei.agconnect'
}

android {

    defaultConfig {
        ...
        minSdk 21
        targetSdk 29

        manifestPlaceholders = [
                GETUI_APPID : "请填写您的个推APP ID",
                MEIZU_APPKEY: "请填写您的魅族APP KEY",
                MEIZU_APPID : "请填写您的魅族APP ID",
                AMAP_API_KEY: "请填写您的高德API_KEY",
                VIVO_APP_ID : "请填写您的VIVO APP_ID",
                VIVO_API_KEY: "请填写您的VIVO API_KEY",
        ]
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
    buildFeatures {
        viewBinding true
        dataBinding true
    }
}

dependencies {
    ...
    // repo/com/kingsoft/kim/sdk/woasdk下目录文件名即为版本号, 使用版本号替换$latestVersion
    api 'com.kingsoft.kim.sdk:woasdk:$latestVersion' 
    api 'com.wps.woa.sdk:image-glide4wrap:1.0.13'
    // 以下按需依赖不同厂商的推送SDK
    api 'com.wps.woa.sdk:pushHuawei:0.0.7'
    api 'com.wps.woa.sdk:pushOppo:0.0.7'
    api 'com.wps.woa.sdk:pushVivo:0.0.7'
    api 'com.wps.woa.sdk:pushXiaomi:0.0.9'
    api 'com.wps.woa.sdk:pushHonor:0.0.4'
    api 'com.wps.woa.sdk:pushMeizu:0.0.6'
    api 'com.wps.woa.sdk:pushGetui:0.0.4'
}
```

--------------------------------

### login(appId: String, authCode: String, callback: KIMCore.ActiveCallback)

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Establishes a login session with the server using an application ID and an authorization code obtained from the business service.

```APIDOC
## login(appId: String, authCode: String, callback: KIMCore.ActiveCallback)

### Description
Establishes a login session with the server. This method must be called to enable SDK services such as instant messaging, documents, and the workbench.

### Parameters
- **appId** (String) - Required - The Application ID obtained from the Enterprise Backstage after SSO configuration.
- **authCode** (String) - Required - The login authorization code obtained from the business service interface.
- **callback** (KIMCore.ActiveCallback) - Required - The result callback for the login operation.

### Code Example
```kotlin
KIM.getControl().login(APP_ID, AUTH_CODE, callBack)
```
```

--------------------------------

### Get Cloud Notification Settings

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Retrieves the current device's notification settings from the cloud.

```Kotlin
KIM.settings().getNotificationSettings(callback: KIMOperateCallback<KIMNotificationSettings>)
```

```Kotlin
KIM.settings().getNotificationSettings(object :
            KIMOperateCallback<KIMNotificationSettings> {
            override fun onSuccess(value: KIMNotificationSettings?) {
                //获取各类开关值
            }

            override fun onError(error: ErrorCode) {
                log.e(error.msg)
            }

        })
```

--------------------------------

### Import SDK Modules

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Import the required SDK modules into your source files.

```Swift
import KIMCore
import WOASDK
```

```Objective-C
@import KIMCore;
@import WOASDK;
```

--------------------------------

### Configure Real Device Framework Search Paths

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Add these paths to the Framework Search Paths in Build Settings for real device builds.

```Plaintext
$(inherited)
$(PROJECT_DIR)/../framework/KIMBase.xcframework/ios-arm64/KIMBase.framework/Frameworks
$(PROJECT_DIR)/../framework/WOASDK.xcframework/ios-arm64/WOASDK.framework/Frameworks
```

--------------------------------

### Integrate Honor Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure Honor push by adding the repository, ProGuard rules, and the SDK dependency.

```groovy
//Honor官方maven仓库，HonorOffline Push
maven { url 'https://developer.hihonor.com/repo/' }
```

```plaintext
# HonorPush
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushHonor:0.0.3'
}
```

--------------------------------

### Initialize WebOffice JSSDK

Source: https://open.wps.cn/documents/app-integration-dev/docs-center/online-preview-edit/flow

Basic HTML structure and script initialization for rendering a WebOffice document using the JSSDK.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>WebOffice</title>
  </head>
  <script src="./web-office-sdk-solution.umd.js"></script>
  <body>
    <script>
      window.onload = () => {
        const instance = WebOfficeSDK.init({
          officeType: WebOfficeSDK.OfficeType.Writer,
          appId: 'xxxxx',
          fileId: 'xxxxx'
        })
      }
    </script>
  </body>
</html>
```

--------------------------------

### Authorization Code Interface Requests

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Exchanges an authorization code for an access token using either GET or POST methods.

```http
GET /accessToken?client_id=c1ebe466-1cdc-4bd3-ab69-77c3561b9dee&client_secret=d8346ea2-6017-43ed-ad68-19c0f971738b&grant_type=authorization_code&code={:code} HTTP/1.1
Host: http://demo.com/
```

```http
POST /accessToken HTTP/1.1
Host: http://demo.com/
Content-Type: application/x-www-form-urlencodedclient_id=c1ebe466-1cdc-4bd3-ab69-77c3561b9dee&client_secret=d8346ea2-6017-43ed-ad68-19c0f971738b&grant_type=authorization_code&code={:code}
```

--------------------------------

### Configure Podfile for CocoaPods Integration

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Add the SDK reference to your Podfile using a local path.

```Ruby
platform :ios, '11.0'
install! 'cocoapods', 
:generate_multiple_pod_projects=>true

workspace 'KIMPodDemo'

target 'KIMPodDemo' do
  use_frameworks! :linkage => :static
  
  # 以 Development Pods of方式引入 KIM SDK
  pod 'KIM', :path => './Framework'
  
end
```

--------------------------------

### Configure repositories in settings.gradle

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/import-sdk

Add the required local and remote repositories to the pluginManagement and dependencyResolutionManagement blocks.

```groovy
pluginManagement {
    repositories {
        // 本地仓库
        maven { url "${rootProject.getRootDir()}/repo" }

        //Huawei官方maven仓库，华为离线推送
        maven { url 'https://developer.huawei.com/repo/' }

        //个推官方maven仓库，个推离线推送
        maven { url "https://mvn.getui.com/nexus/content/repositories/releases/" }

        //荣耀官方maven仓库，荣耀离线推送
        maven { url 'https://developer.hihonor.com/repo/' }

        maven { url 'https://maven.aliyun.com/repository/google' }// 可选配置
        maven { url 'https://maven.aliyun.com/repository/public' }// 可选配置
        maven { url 'https://maven.aliyun.com/repository/gradle-plugin' }// 可选配置
        maven { url 'https://jitpack.io' }// 可选配置
        ...
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        // 本地仓库
        maven { url "${rootProject.getRootDir()}/repo" }

        //Huawei官方maven仓库，华为离线推送
        maven { url 'https://developer.huawei.com/repo/' }

        //个推官方maven仓库，个推离线推送
        maven { url "https://mvn.getui.com/nexus/content/repositories/releases/" }

        //荣耀官方maven仓库，荣耀离线推送
        maven { url 'https://developer.hihonor.com/repo/' }

        maven { url 'https://maven.aliyun.com/repository/google' }// 可选配置
        maven { url 'https://maven.aliyun.com/repository/public' }// 可选配置
        maven { url 'https://maven.aliyun.com/repository/gradle-plugin' }// 可选配置
        maven { url 'https://jitpack.io' }// 可选配置
        ...
    }
}
```

--------------------------------

### Sign In and Connect

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

Authenticates the user using an APP_ID and a time-sensitive authorization code.

```kotlin
KIM.getControl().login(APP_ID, AUTH_CODE, object : KIMCore.ActiveCallback {
    override fun onSuss() {
    }

    override fun onFail(reason: String) {
    }
})
```

--------------------------------

### Force Logout Interface and Usage

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Defines the forceLogout method, which clears local session cache regardless of server request success, and provides an implementation example.

```kotlin
fun forceLogout(callback: IOperationCallback?)
```

```kotlin
KIM.getControl().forceLogout(object : IOperationCallback {
    override fun onSuccess() {
        log("logout success")
    }

    override fun onError(err: ErrorCode?) {
        log("logout, error = $err")
    }
})
```

--------------------------------

### Integrate OPPO Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure OPPO push by adding app credentials to the manifest, setting ProGuard rules, and including the SDK dependency.

```xml
<meta-data
    android:name="OPPO_APP_KEY"
    android:value="从OPPO官方申请到的具体的APPKEY值" />
<meta-data
    android:name="OPPO_APP_SECRET"
    android:value="从OPPO官方申请到的具体的APPSECRET值" />
```

```plaintext
# OPPOPush
-keep public class * extends android.app.Service
-keep class com.heytap.msp.** {*;}
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushOppo:0.0.6'
}
```

--------------------------------

### login(authCode:appId:complete:)

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Establishes a login session with the server using an authorization code and application ID.

```APIDOC
## login(authCode: String, appId: String, complete: @escaping (_ success: Bool, _ error: KIMError?) -> Void)

### Description
Initiates a connection to the server by providing an authorization code and application ID. This method must be called to enable access to messaging, documents, and other platform services.

### Parameters
- **authCode** (String) - Required - The login authorization code obtained from your business service interface.
- **appId** (String) - Required - The Application ID obtained from the Enterprise Backstage after SSO configuration.
- **complete** ((Bool, KIMError?) -> Void) - Required - Callback function returning success status and an optional error object.

### Code Example
```swift
KIM.shared.login(authCode: authCode, appId: appId) { success, error in
    if success {
        // Sign In success
    } else {
        // Sign In failure
    }
}
```
```

```APIDOC
## loginWithAuthCode:(NSString *)authCode appId:(NSString *)appId complete:(void (^)(BOOL, KIMError *))complete

### Description
Objective-C interface to establish a login session with the server using an authorization code and application ID.

### Parameters
- **authCode** (NSString *) - Required - The login authorization code.
- **appId** (NSString *) - Required - The Application ID.
- **complete** (void (^)(BOOL, KIMError *)) - Required - Completion block returning success status and error.

### Code Example
```objectivec
[KIM.shared loginWithAuthCode:authCode appId:appId complete:^(BOOL success, KIMError *error) {
    if (success) {
        // Sign In success
    } else {
        // Sign In failure
    }
}];
```
```

--------------------------------

### Navigate to SDK Pages

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/start

Provides methods to navigate to various SDK fragments including chat lists, message lists, document tabs, and the workbench.

```kotlin
KIM.getService().goPage(KIMChatListFragment::class.java.getPageName(), this, Bundle())
```

```kotlin
val args = KIMMessageListFragment.defaultArguments(chatId, chatName, null)
KIM.getService().goPage(KIMMessageListFragment::class.java.getPageName(), context, args)
```

```kotlin
KIM.getService().goPage(KIMDocumentTabFragment::class.java.getPageName(), this, Bundle())
```

```kotlin
KIM.getService().goPage(KIMWorkSpaceFragment::class.java.getPageName(), this, Bundle())
```

--------------------------------

### Enable Push SPI Initialization

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Add this metadata to the AndroidManifest.xml to automatically register dependent push components.

```xml
<meta-data
     android:name="push_spi_init_enabled"
     android:value="true" />
```

--------------------------------

### Auto Login Interface and Usage

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

Defines the autoLogin method and demonstrates how to trigger an automatic login attempt using the KIM control instance.

```kotlin
fun autoLogin()
```

```kotlin
KIM.getControl().autoLogin()
```

--------------------------------

### Configure Simulator Framework Search Paths

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Add these paths to the Framework Search Paths in Build Settings for simulator builds.

```Plaintext
$(inherited)
$(PROJECT_DIR)/../framework/KIMBase.xcframework/ios-x86_64-simulator/KIMBase.framework/Frameworks
$(PROJECT_DIR)/../framework/WOASDK.xcframework/ios-x86_64-simulator/WOASDK.framework/Frameworks
```

--------------------------------

### Integrate Huawei Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure Huawei push by updating build scripts, adding the service JSON file, setting ProGuard rules, and including the SDK dependency.

```groovy
buildscript {
    ...
    dependencies {
        ...
        classpath 'com.huawei.agconnect:agcp:1.6.0.300'
    }
}

allprojects {
    ...
    repositories {
        //Huawei官方maven仓库
        maven { url 'https://developer.huawei.com/repo/' }
    }
}
```

```groovy
apply plugin: 'com.huawei.agconnect'
```

```plaintext
# HuaweiPush
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
-keep class com.hianalytics.android.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushHuawei:0.0.6'
}
```

--------------------------------

### Integrate Xiaomi Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure Xiaomi push by adding app credentials to the manifest, setting ProGuard rules, and including the SDK dependency.

```xml
<meta-data
    android:name="MIPUSH_APPID"
    android:value="从Xiaomi官方申请到的具体的APPID值" />
<meta-data
    android:name="MIPUSH_APPKEY"
    android:value="从Xiaomi官方申请到的具体的APPKEY值" />
```

```plaintext
# XiaomiPush
-keep class com.wps.woa.sdk.push.manufactory.xiaomi.XiaomiMessageReceiver {*;}
#可以防止一个误报的 warning 导致无法成功编译，如果编译使用的 Android 版本是 23.
-dontwarn com.xiaomi.push.**
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushXiaomi:0.0.7'
}
```

--------------------------------

### Initiate SSO via Web

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Initiate an SSO authentication flow for a specific application using its configured APPID.

```APIDOC
## GET https://open.wps.cn/oauth/v1/auth

### Description
Initiates the SSO authentication process for a web application using the configured APPID.

### Parameters
#### Query Parameters
- **app_id** (string) - Required - The unique identifier generated during SSO configuration.
- **cb** (string) - Required - The callback URL to redirect to after successful authentication.
```

--------------------------------

### Initiate Web-based SSO

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/server/SSO-login

Use this URL structure to initiate an SSO authentication flow for a specific application.

```text
https://open.wps.cn/oauth/v1/auth?app_id={:app_id}&cb=https%3A%2F%2Fkdocs.cn
```

--------------------------------

### ProGuard Configuration Rules

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/import-sdk

Include these rules in your proguard-rules.pro file to ensure proper functionality of integrated SDKs and libraries.

```groovy
##---------------start: proguard configuration for meizu push  ----------
-dontwarn com.meizu.cloud.**
-keep class com.meizu.cloud.** { *; }
##---------------end: proguard configuration for meizu push  ----------

# 小米推送
-keep class com.wps.woa.sdk.push.manufactory.xiaomi.XiaomiMessageReceiver {*;}
#可以防止一个误报的 warning 导致无法成功编译，如果编译使用的 Android 版本是 23。
-dontwarn com.xiaomi.push.**

# 华为推送
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
-keep class com.hianalytics.android.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}

# OPPO推送
-keep public class * extends android.app.Service
-keep class com.heytap.msp.** {*;}

# VIVO推送
-dontwarn com.vivo.push.**
-keep class com.vivo.push.**{*;}
-keep class com.vivo.vms.**{*;}
-keep class com.wps.woa.sdk.push.manufactory.vivo.VivoMessageReceiver {*;}

#amap 3dmap
-keep class com.amap.api.** {*;}
-keep class com.autonavi.** {*;}

#location
-keep class com.amap.api.location.** {*;}
-keep class com.amap.api.fence.** {*;}
-keep class com.autonavi.aps.amapapi.model.** {*;}
#amap search
-keep class com.amap.api.services.** {*;}

# kotlin 相关
-dontwarn kotlin.**
-keep class kotlin.** {*;}
-keep interface kotlin.** {*;}
-keepclassmembers class kotlin.Metadata {
    public <methods>;
}
-keepclasseswithmembers @kotlin.Metadata class * {*;}
-keepclassmembers class **.WhenMappings {
    <fields>;
}
-assumenosideeffects class kotlin.jvm.internal.Intrinsics {
    static void checkParameterIsNotNull(java.lang.Object, java.lang.String);
}
-keep class kotlinx.** {*;}
-keep interface kotlinx.** {*;}
-dontwarn kotlinx.**
-dontnote kotlinx.serialization.SerializationKt
-keep class org.jetbrains.** {*;}
-keep interface org.jetbrains.** {*;}
-dontwarn org.jetbrains.**

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * extends com.google.gson.TypeAdapter
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

# Prevent R8 from leaving Data object members always null
-keepclassmembers,allowobfuscation class * {
  @com.google.gson.annotations.SerializedName <fields>;
}

# Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher.
-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken

##---------------End: proguard configuration for Gson  ----------
```

--------------------------------

### Integrate VIVO Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure VIVO push by adding app credentials to the manifest, setting ProGuard rules, and including the SDK dependency.

```xml
<meta-data
     android:name="com.vivo.push.app_id"
     android:value="从VIVO官方申请到的具体的APPID值" />
<meta-data
     android:name="com.vivo.push.api_key"
     android:value="从VIVO官方申请到的具体的APPKEY值" />
```

```plaintext
# VIVOPush
-dontwarn com.vivo.push.**
-keep class com.vivo.push.**{*;}
-keep class com.vivo.vms.**{*;}
-keep class com.wps.woa.sdk.push.manufactory.vivo.VivoMessageReceiver {*;}
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushVivo:0.0.6'
}
```

--------------------------------

### Enable AndroidX in gradle.properties

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/import-sdk

Configure the project to use AndroidX and enable Jetifier for library compatibility.

```properties
android.useAndroidX=true
android.enableJetifier=true
```

--------------------------------

### Add Build Phase Cleanup Script

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/import-sdk

Include this shell script in Build Phases to remove unnecessary framework directories and avoid Apple review rejection.

```Shell
del_base_framework_dir="${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/KIMBase.framework/Frameworks"
if [ -d $del_base_framework_dir ]; then
    rm -rf $del_base_framework_dir
fi

del_woasdk_framework_dir="${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/WOASDK.framework/Frameworks"
if [ -d $del_woasdk_framework_dir ]; then
    rm -rf $del_woasdk_framework_dir
fi
```

--------------------------------

### KIMMessageListFragment.defaultArguments

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/msg-list/msg_ui

Generates the necessary arguments to initialize the message list interface for a specific chat.

```APIDOC
## fun defaultArguments(chatId: String)

### Description
Creates the bundle of arguments required to initialize the message list for a given chat session.

### Parameters
- **chatId** (String) - Required - The unique identifier for the chat session.
```

--------------------------------

### Integrate Meizu Push

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Configure Meizu push by adding app credentials to the manifest, setting ProGuard rules, and including the SDK dependency.

```xml
<meta-data
     android:name="MEIZU_APPID"
     android:value="从Meizu官方申请到的具体的APPKEY值" />
```

```plaintext
-dontwarn com.meizu.cloud.**
-keep class com.meizu.cloud.** { *; }
```

```groovy
dependencies {
    api 'com.wps.woa.sdk:pushMeizu:0.0.4'
}
```

--------------------------------

### Implement KIMLogoutDelegate Proxy Method

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Implementation of the delegate method to handle logout events and error codes.

```Swift
func didLogout(reason: KIMError) {
   if reason.code == KIMErrorCode.userHasNotLogin.rawValue {
        // Auto Sign-In失败
   } else {
       // 其他账号失效退登情况，如账号被踢
   }
}
```

```Objective-C
- (void)didLogoutWithReason:(KIMError *)reason {
    if (reason.code == KIMErrorCodeUserHasNotLogin) {
        // Auto Sign-In失败
    } else {
        // 其他账号失效退登情况，如账号被踢
    }
}
```

--------------------------------

### Configure buildscript in root build.gradle

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/import-sdk

Define the Android Gradle plugin and AGConnect classpath dependencies.

```groovy
buildscript {
    dependencies {
        // 增加Android Gradle插件版本号配置，{version}为实际的Gradle插件版本号
        classpath 'com.android.tools.build:gradle:{version}'
        // 华为离线推送
        classpath 'com.huawei.agconnect:agcp:1.6.0.300'
        ...
    }
}
plugins {
    id 'org.jetbrains.kotlin.android' version '{version}' apply false // kotlin-gradle插件版本，与相应Gradle版本匹配
    ...
}
```

--------------------------------

### Define Message List Arguments

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/msg-list/msg_ui

Use this function to generate the necessary arguments for initializing the message list with a specific chat ID.

```Kotlin
fun defaultArguments(chatId: String)
```

--------------------------------

### Execute Login Request

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

The implementation call to perform the login operation using the application ID and authorization code.

```Kotlin
KIM.getControl().login(APP_ID, AUTH_CODE, callBack)
```

--------------------------------

### Define Login Interface

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/connect

The function signature required to initiate a login session with the server.

```Kotlin
fun login(appId: String, authCode: String, callback: KIMCore.ActiveCallback)
```

--------------------------------

### Configure Chat List Style

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Modify the appearance of chat list cells by setting properties on KIMChatListConfig before the list loads.

```Kotlin
// 修改Chats列表Cell标题Text Color
KIM.chatModule.chatListConfig.chatTitleColor = R.color.black
// 修改Chats列表Cell标题文字大小
KIM.chatModule.chatListConfig.chatTitleFont = KIMFont(R.dimen.chat_list_item_content)
```

--------------------------------

### KIMExpChatListPage Interface Methods

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Methods available for implementing custom conversation list UI and behavior.

```APIDOC
## customTopView(context: Context, parent: ViewGroup) -> View

### Description
Customize the top view of the conversation list. The returned view is fixed between the top of the list and the bottom of the navigation bar and does not scroll.

## chatListHeaderView(context: Context, parent: ViewGroup) -> View

### Description
Customize the conversation list header view. The returned view is added to the top of the list and scrolls with it.

## configTitleBar(titleView: CommonTitleBar) -> Unit

### Description
Configure the title view of the conversation list navigation bar, such as modifying styles or adding buttons.

## updateTitleBar(titleBar: CommonTitleBar) -> Unit

### Description
Intercept and handle title bar update events. This method is called multiple times by the SDK.

## onClickedAddButton(button: Button, defaultHandler: () -> Unit) -> Unit

### Description
Intercept the click event of the plus button in the title bar. Call `defaultHandler` to execute the default SDK behavior.

## onClickedSearchButton(button: Button, defaultHandler: () -> Unit) -> Unit

### Description
Intercept the click event of the search button in the title bar. Call `defaultHandler` to execute the default SDK behavior.

## updatePopupMenus(context: Context, menus: List<KIMMenuItem>) -> List<KIMMenuItem>

### Description
Update the data source of the plus pop-up panel. Modify the provided list and return the new list of items.

## onClickedPopupMenuItem(context: Context, item: KIMMenuItem, index: Int, defaultHandler: () -> Unit) -> Unit

### Description
Intercept the click event for items in the plus sign pop-up panel. Call `defaultHandler` to execute the default SDK behavior.
```

--------------------------------

### autoLogin()

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

Initiates an automatic login process for a previously authenticated account, bypassing the need for manual credential entry.

```APIDOC
## autoLogin()

### Description
Automatically logs the user into the IM service if a previous session exists. This method handles the connection internally.

### Signature
- Swift: `func autoLogin()`
- Objective-C: `- (void)autoLogin`

### Usage Example
- Swift: `KIM.shared.autoLogin()`
- Objective-C: `[KIM.shared autoLogin];`
```

--------------------------------

### Login Interface Definition

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/iOS/connect

The method signatures for initiating a login session using an authorization code and application ID.

```Swift
func login(authCode: String, appId: String, complete: @escaping (_ success: Bool, _ error: KIMError?) -> Void)
```

```Objective-C
- (void)loginWithAuthCode:(NSString *)authCode appId:(NSString *)appId complete:(void (^)(BOOL, KIMError *))complete;
```

--------------------------------

### Set Push Token via SDK

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/push-overview

Use this method to register a manufacturer-provided push token with the collaborative middle platform SDK.

```java
KIM.getControl().setPushToken(pushType, token)
```

--------------------------------

### KIMChatListConfig

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Configuration class for customizing the visual appearance and behavior of the conversation list interface.

```APIDOC
## KIMChatListConfig

### Description
Configuration class used to customize the conversation list interface style and behavior.

### Properties
- **isEnabledChatListNetworkTips** (Boolean) - Whether to display the network exception prompt view for the conversation list, Default to true
- **isEnabledChatListMultiGroup** (Boolean) - Whether to enable the conversation grouping mode, with the default being true
- **chatBackgroundDrawable** (@DrawableRes Int) - Conversation Item-Default Background Resources
- **chatStickiedDrawable** (@DrawableRes Int) - Conversation Item-Pin Background Resource
- **chatSelectedBackgroundDrawable** (@DrawableRes Int) - Conversation Item - Select Background Color
- **chatTimeFont** (KIMFont) - Conversation Item - Time Text Size/Font Style
- **chatTimeColor** (@ColorRes Int) - Conversation Item - Time Text Color
- **chatTimeFormatter** ((time: Long) -> String) - Conversation Item - Conversation Time Format
- **chatTitleFont** (KIMFont) - Conversation Item - Title Text Size/Title Font Style
- **chatTitleColor** (@ColorRes Int) - Conversation Item - Title Font Color
- **chatContentFont** (KIMFont) - Conversation Item - Summary - Text Size/Summary Font Style
- **chatContentColor** (@ColorRes Int) - Conversation Item - Summary - Font Color
- **chatUnreadBadgeBackgroundDrawable** (@DrawableRes Int) - Conversation Item - Unread Count Marker - Background Resources
- **chatUnreadBadgeTextColor** (@ColorRes Int) - Conversation Item - Unread Count Marker - Text Color
- **chatSeparatorDrawable** (@DrawableRes Int) - Conversation Item - Bottom Divider Image Resources
- **chatSeparatorStartPadding** (@DimenRes Int) - Conversation Item - Left Spacing of Bottom Divider
- **chatSeparatorEndPadding** (@DimenRes Int) - Conversation Item - Right Spacing of Bottom Divider
- **popupMenuCellBackgroundDrawable** (@DrawableRes Int) - Plus Button Pop - up Window cell - Default Background Resources
```

--------------------------------

### KIMFont

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Configuration object for defining text size and style within the conversation list.

```APIDOC
## KIMFont

### Description
Defines text size and style properties for UI elements.

### Properties
- **textSize** (@DimenRes Int) - Indicates the text size dimenResources id
- **textStyle** (Int) - Text Style, Default to Typeface.NORMAL
```

--------------------------------

### KIMExpChatListPage Customization Methods

Source: https://open.wps.cn/documents/app-integration-dev/collaboration-middleware/android/chat/chat-list/chat-ui-custom

Methods available for overriding in KIMExpChatListPage to customize UI components and event handling.

```APIDOC
## updatePopupMenus(context: Context, menus: List<KIMMenuItem>): List<KIMMenuItem>

### Description
Overrides the default menu items in the plus sign pop-up panel of the conversation list title bar.

### Parameters
- **context** (Context) - The current Android context.
- **menus** (List<KIMMenuItem>) - The default list of menu items.

### Returns
- **List<KIMMenuItem>** - The modified list of menu items.

---

## onClickedPopupMenuItem(context: Context, item: KIMMenuItem, index: Int, defaultHandler: () -> Unit)

### Description
Intercepts click events for items within the plus sign pop-up panel.

### Parameters
- **context** (Context) - The current Android context.
- **item** (KIMMenuItem) - The clicked menu item.
- **index** (Int) - The index of the clicked item.
- **defaultHandler** (() -> Unit) - The default action handler.

---

## onClickedChatItem(context: Context, item: KIMChatItem, defaultHandler: () -> Unit)

### Description
Intercepts click events on items within the conversation list.

### Parameters
- **context** (Context) - The current Android context.
- **item** (KIMChatItem) - The clicked conversation item.
- **defaultHandler** (() -> Unit) - The default action handler.

---

## onLongClickedChatItem(context: Context, item: KIMChatItem, defaultHandler: () -> Unit)

### Description
Intercepts long-press events on items within the conversation list.

### Parameters
- **context** (Context) - The current Android context.
- **item** (KIMChatItem) - The long-pressed conversation item.
- **defaultHandler** (() -> Unit) - The default action handler.

---

## customTopView(context: Context, parent: ViewGroup): View?

### Description
Returns a custom view to be fixed at the top of the conversation list, between the list and the navigation bar.

### Parameters
- **context** (Context) - The current Android context.
- **parent** (ViewGroup) - The parent view group.

### Returns
- **View?** - The custom view to display.

---

## chatListHeaderView(context: Context, parent: ViewGroup): View?

### Description
Returns a custom header view that is added to the top of the conversation list and scrolls with it.

### Parameters
- **context** (Context) - The current Android context.
- **parent** (ViewGroup) - The parent view group.

### Returns
- **View?** - The custom header view to display.
```
Tokens:
Raw