diff --git a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx index d063dd6576..9041c97455 100644 --- a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx +++ b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx @@ -48,6 +48,7 @@ values={[ String? operationID, }) ``` +string bool int ### 输入参数 diff --git a/docs/sdks/callback/index.mdx b/docs/sdks/callback/index.mdx index c4206cb5df..5cc2ce9525 100644 --- a/docs/sdks/callback/index.mdx +++ b/docs/sdks/callback/index.mdx @@ -38,11 +38,12 @@ toc_max_heading_level: 2 | [onGroupDismissed](docs/sdks/callback/onGroupDismissed.mdx) | 群被解散后回调 | | [onRecvNewMessage](docs/sdks/callback/onRecvNewMessage.mdx) | 收到新消息 | | [onRecvC2CReadReceipt](docs/sdks/callback/onRecvC2CReadReceipt.mdx) | 单聊消息已读回执 | -| [onRecvGroupReadReceipt](docs/sdks/callback/onRecvGroupReadReceipt.mdx) | 群聊消息已读回执 | +| [onRecvOnlineOnlyMessage](docs/sdks/callback/onRecvOnlineOnlyMessage.mdx) | 在线消息的回调 | | [onNewRecvMessageRevoked](docs/sdks/callback/onNewRecvMessageRevoked.mdx) | 撤回消息回调 | -| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器会话开始 | -| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器会话完成 | -| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器会话失败 | +| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器数据开始 | +| [onSyncServerProgress](docs/sdks/callback/onSyncServerProgress.mdx) | 同步服务器数据进度 | +| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器数据完成 | +| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器数据失败 | | [onNewConversation](docs/sdks/callback/onNewConversation.mdx) | 有新的会话 | | [onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) | 某些会话的关键信息发生变化 | | [onTotalUnreadMessageCountChanged](docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx) | 会话未读总数变更通知 | diff --git a/docs/sdks/callback/onBase.mdx b/docs/sdks/callback/onBase.mdx index 91da3a0233..a60e5556f8 100644 --- a/docs/sdks/callback/onBase.mdx +++ b/docs/sdks/callback/onBase.mdx @@ -14,33 +14,6 @@ sdk 会回调此接口，成功会调用 onSuccess 方法并返回特定的数 ::: - - - - -### 函数原型 - -```java showLineNumbers - -public interface OnBase { - /** - * 失败 - */ - void onError(int code, String error); - - /** - * 成功 - */ - void onSuccess(T data); -} - -``` ### 返回结果 @@ -48,25 +21,3 @@ public interface OnBase { | --------- | -------------------------------------- | | onError | 错误代码与错误信息 | | onSuccess | 泛型类型（根据调用函数的签名指定类型） | - - - - - -### 委托 - -```C# showLineNumbers -public delegate void OnBase(T data, int errCode, string errMsg); -``` - -### 参数 - -| 参数名称 | 类型 | 描述 | -| -------- | --------| -------- | -| data | T | 返回数据 | -| errCode | int | 错误码 | -| errMsg | string |错误信息 | - - - - diff --git a/docs/sdks/callback/onConnectFailed.mdx b/docs/sdks/callback/onConnectFailed.mdx index a26cd1f982..059cac487f 100644 --- a/docs/sdks/callback/onConnectFailed.mdx +++ b/docs/sdks/callback/onConnectFailed.mdx @@ -17,5 +17,5 @@ toc_max_heading_level: 2 | 名称 | 类型 | 描述 | | ----- | ------ | -------- | -| code | long | 错误码 | -| error | String | 错误信息 | +| code | int | 错误码 | +| error | string | 错误信息 | diff --git a/docs/sdks/callback/onConnectSuccess.mdx b/docs/sdks/callback/onConnectSuccess.mdx index b91eafef57..3eb0ad1a08 100644 --- a/docs/sdks/callback/onConnectSuccess.mdx +++ b/docs/sdks/callback/onConnectSuccess.mdx @@ -15,6 +15,4 @@ toc_max_heading_level: 2 ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------- | ---- | -| data | [WSEvent](docs/sdks/class/response.mdx) | - | +无 diff --git a/docs/sdks/callback/onConnecting.mdx b/docs/sdks/callback/onConnecting.mdx index e43f8c9e0b..05dfbd6044 100644 --- a/docs/sdks/callback/onConnecting.mdx +++ b/docs/sdks/callback/onConnecting.mdx @@ -15,6 +15,4 @@ toc_max_heading_level: 2 ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------- | ---- | -| data | [WSEvent](docs/sdks/class/response.mdx) | - | +无 diff --git a/docs/sdks/callback/onConversationChanged.mdx b/docs/sdks/callback/onConversationChanged.mdx index 3df7441f76..6bf1213711 100644 --- a/docs/sdks/callback/onConversationChanged.mdx +++ b/docs/sdks/callback/onConversationChanged.mdx @@ -14,8 +14,11 @@ toc_max_heading_level: 2 ::: -### 返回数据 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------- | -------- | -| list | [][Conversation](docs/sdks/class/conversation/conversationInfo.mdx) | 会话信息 | + +### 返回结果 + +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| conversationList | `[]`[ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx) | 改变的会话信息列表 | + diff --git a/docs/sdks/callback/onFriendApplicationDeleted.mdx b/docs/sdks/callback/onFriendApplicationDeleted.mdx index d19f1f9194..9a68626097 100644 --- a/docs/sdks/callback/onFriendApplicationDeleted.mdx +++ b/docs/sdks/callback/onFriendApplicationDeleted.mdx @@ -10,7 +10,7 @@ toc_max_heading_level: 2 :::info -目前暂未使用 +好有申请被移除，目前暂未使用 ::: diff --git a/docs/sdks/callback/onFriendDeleted.mdx b/docs/sdks/callback/onFriendDeleted.mdx index a4a0f3f272..213670e484 100644 --- a/docs/sdks/callback/onFriendDeleted.mdx +++ b/docs/sdks/callback/onFriendDeleted.mdx @@ -10,7 +10,7 @@ toc_max_heading_level: 2 :::info -某个用户的好友列表减少时会收到该回调。 +用户的好友列表减少时会收到该回调。 ::: diff --git a/docs/sdks/callback/onGroupApplicationAccepted.mdx b/docs/sdks/callback/onGroupApplicationAccepted.mdx index 40a43af48e..6ed0c4ef3b 100644 --- a/docs/sdks/callback/onGroupApplicationAccepted.mdx +++ b/docs/sdks/callback/onGroupApplicationAccepted.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupApplicationInfo info)? onGroupApplicationAccepted; -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ---------------------------------------------------------------------- | ------------ | | info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupApplicationAccepted:(OIMGroupApplicationInfo *)groupApplication; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ------------------------------------------------------------------------- | ------------ | -| application | [OIMGroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupApplicationAccepted(GroupApplicationInfo info) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 好友拒绝信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationAccepted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupApplicationAccepted, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationAccepted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAccepted, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```c# showLineNumbers -void OnGroupApplicationAccepted(GroupApplicationInfo application); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| application | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - diff --git a/docs/sdks/callback/onGroupApplicationAdded.mdx b/docs/sdks/callback/onGroupApplicationAdded.mdx index 59d64d787e..8778f66384 100644 --- a/docs/sdks/callback/onGroupApplicationAdded.mdx +++ b/docs/sdks/callback/onGroupApplicationAdded.mdx @@ -14,25 +14,6 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupApplicationInfo info)? onGroupApplicationAdded; -``` ### 返回结果 @@ -40,116 +21,3 @@ values={[ | ---- | ---------------------------------------------------------------------- | ------------ | | info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupApplicationAdded:(OIMGroupApplicationInfo *)groupApplication; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ------------------------------------------------------------------------- | ------------ | -| application | [OIMGroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupApplicationAdded(GroupApplicationInfo info) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 好友拒绝信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupApplicationAdded, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAdded, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupApplicationAdded(GroupApplicationInfo application); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| application | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - diff --git a/docs/sdks/callback/onGroupApplicationDeleted.mdx b/docs/sdks/callback/onGroupApplicationDeleted.mdx index d0c0784b6d..c24b93a03e 100644 --- a/docs/sdks/callback/onGroupApplicationDeleted.mdx +++ b/docs/sdks/callback/onGroupApplicationDeleted.mdx @@ -10,146 +10,13 @@ toc_max_heading_level: 2 :::info -目前暂未使用 +群申请列表被删除，申请的发起者，以及该群的群主和管理员会收到此回调，目前暂未使用 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupApplicationInfo info)? onGroupApplicationDeleted; -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ---------------------------------------------------------------------- | ------------ | | info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupApplicationDeleted:(OIMGroupApplicationInfo *)groupApplication; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ------------------------------------------------------------------------- | ------------ | -| application | [OIMGroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - - -### 返回原型 - -```java showLineNumbers -void onGroupApplicationDeleted(GroupApplicationInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 好友拒绝信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupApplicationDeleted, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupApplicationDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationDeleted, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupApplicationDeleted(GroupApplicationInfo application); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| application | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - diff --git a/docs/sdks/callback/onGroupApplicationRejected.mdx b/docs/sdks/callback/onGroupApplicationRejected.mdx index beb3f546f1..5d3cc3a6ca 100644 --- a/docs/sdks/callback/onGroupApplicationRejected.mdx +++ b/docs/sdks/callback/onGroupApplicationRejected.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupApplicationInfo info)? onGroupApplicationRejected; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupApplicationRejected:(OIMGroupApplicationInfo *)groupApplication; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ------------------------------------------------------------------------- | ------------ | -| application | [OIMGroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupApplicationRejected(GroupApplicationInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------------- | ------------ | -| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 好友拒绝信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onFriendApplicationRejected(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupApplicationRejected, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onFriendApplicationRejected(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationRejected, ({ data }) => { - // data 入群申请 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupApplicationRejected(GroupApplicationInfo application); -``` ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ---------------------------------------------------------------------- | ------------ | -| application | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | - - - +| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 | \ No newline at end of file diff --git a/docs/sdks/callback/onGroupDismissed.mdx b/docs/sdks/callback/onGroupDismissed.mdx index 03576dadd3..ed4372089d 100644 --- a/docs/sdks/callback/onGroupDismissed.mdx +++ b/docs/sdks/callback/onGroupDismissed.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupInfo info)? onGroupDismissed; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | ------------------------------------------------ | -------- | -| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupDismissed:(OIMGroupInfo *)changeInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | --------------------------------------------------- | -------- | -| groupInfo | [OIMGroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupDismissed(GroupInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | ------------------------------------------------ | ------ | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 组信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupDismissed(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupDismissed, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupDismissed(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupDismissed, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupDismissed(GroupInfo groupInfo); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | --------- | ------------------------------------------------ | -------- | -| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | +| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群信息 | - - diff --git a/docs/sdks/callback/onGroupInfoChanged.mdx b/docs/sdks/callback/onGroupInfoChanged.mdx index a97af020f2..3a350ecf7e 100644 --- a/docs/sdks/callback/onGroupInfoChanged.mdx +++ b/docs/sdks/callback/onGroupInfoChanged.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupInfo info)? onGroupInfoChanged; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupInfoChanged:(OIMGroupInfo *)groupInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | --------------------------------------------------- | -------- | -| groupInfo | [OIMGroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupInfoChanged(GroupInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupInfoChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupInfoChanged, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupInfoChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupInfoChanged, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupInfoChanged(GroupInfo groupInfo); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------ | -------- | -| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | +| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群信息 | - - diff --git a/docs/sdks/callback/onGroupMemberAdded.mdx b/docs/sdks/callback/onGroupMemberAdded.mdx index 374673396b..4e092443ef 100644 --- a/docs/sdks/callback/onGroupMemberAdded.mdx +++ b/docs/sdks/callback/onGroupMemberAdded.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupMembersInfo info)? onGroupMemberAdded; -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------------------- | -------- | | info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupMemberAdded:(OIMGroupMemberInfo *)memberInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---------- | --------------------------------------------------------------- | -------- | -| memberInfo | [OIMGroupMemberInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupMemberAdded(GroupMembersInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupMemberAdded, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupMemberAdded, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupMemberAdded(GroupMember info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMember](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - diff --git a/docs/sdks/callback/onGroupMemberDeleted.mdx b/docs/sdks/callback/onGroupMemberDeleted.mdx index 0147533f07..7163fceeb8 100644 --- a/docs/sdks/callback/onGroupMemberDeleted.mdx +++ b/docs/sdks/callback/onGroupMemberDeleted.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupMembersInfo info)? onGroupMemberDeleted; -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------------------- | -------- | | info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupMemberDeleted:(OIMGroupMemberInfo *)memberInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---------- | --------------------------------------------------------------- | -------- | -| memberInfo | [OIMGroupMemberInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupMemberDeleted(GroupMembersInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupMemberDeleted, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupMemberDeleted, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers - void OnGroupMemberDeleted(GroupMember info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMember](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - diff --git a/docs/sdks/callback/onGroupMemberInfoChanged.mdx b/docs/sdks/callback/onGroupMemberInfoChanged.mdx index 461bc7d904..a3cfc6601e 100644 --- a/docs/sdks/callback/onGroupMemberInfoChanged.mdx +++ b/docs/sdks/callback/onGroupMemberInfoChanged.mdx @@ -14,25 +14,6 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupMembersInfo info)? onGroupMemberInfoChanged; -``` ### 返回结果 @@ -40,116 +21,3 @@ values={[ | ---- | ------------------------------------------------------------- | -------- | | info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onGroupMemberInfoChanged:(OIMGroupMemberInfo *)memberInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---------- | --------------------------------------------------------------- | -------- | -| memberInfo | [OIMGroupMemberInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onGroupMemberInfoChanged(GroupMembersInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMembersInfo](docs/sdks/class/group/groupMemberInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberInfoChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnGroupMemberInfoChanged, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onGroupMemberInfoChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)> | 群成员信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnGroupMemberInfoChanged, ({ data }) => { - // data 群成员信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnGroupMemberInfoChanged(GroupMember info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------- | -------- | -| info | [GroupMember](docs/sdks/class/group/groupMemberInfo.mdx) | 群成员信息 | - - - diff --git a/docs/sdks/callback/onInputStatusChanged.mdx b/docs/sdks/callback/onInputStatusChanged.mdx index 32107711a1..8cf6128b9f 100644 --- a/docs/sdks/callback/onInputStatusChanged.mdx +++ b/docs/sdks/callback/onInputStatusChanged.mdx @@ -13,155 +13,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - - ValueChanged< InputStatusChangedData >? onInputStatusChanged; - -``` ### 返回结果 | 名称 | 类型 | 描述 | | --------- | --------------------------------------------------- | -------- | | InputStatusChangedData | [InputStatusChangedData](docs/sdks/class/conversation/inputStatusChangedData.mdx) | 群聊信息 | - - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onConversationUserInputStatusChanged:(OIMInputStatusChangedData *)inputStatusChangedData; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | --------------------------------------------------- | -------- | -| OIMInputStatusChangedData | [OIMInputStatusChangedData](docs/sdks/class/conversation/inputStatusChangedData.mdx) | 群聊信息 | - - - - - - - - - -### 返回原型 - -```ts showLineNumbers - -onInputStatusChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[InputStatusChangedData](docs/sdks/class/conversation/inputStatusChangedData.mdx)> | 输入状态改变信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK } from '@openim/wasm-client-sdk'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { getSDK } from '@openim/client-sdk'; -// const IMSDK = getSDK(); - -IMSDK.on(CbEvents.onInputStatusChanged, ({ data }) => { - // data -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onInputStatusChanged(data: InputStatusChangedData): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [InputStatusChangedData](docs/sdks/class/conversation/inputStatusChangedData.mdx) | 输入状态改变信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe('onInputStatusChanged', (data) => { - // data -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onInputStatusChanged(data: InputStatusChangedData): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [InputStatusChangedData](docs/sdks/class/conversation/inputStatusChangedData.mdx) | 输入状态改变信息 | - -### 调用示例 - -```js showLineNumbers -import { OpenIMEmitter } from "open-im-sdk-rn"; - -OpenIMEmitter.addListener("onInputStatusChanged", (data) => { - // data -}); -``` - - - - - - - - diff --git a/docs/sdks/callback/onJoinedGroupAdded.mdx b/docs/sdks/callback/onJoinedGroupAdded.mdx index bb27c77c02..65a52eaf73 100644 --- a/docs/sdks/callback/onJoinedGroupAdded.mdx +++ b/docs/sdks/callback/onJoinedGroupAdded.mdx @@ -14,143 +14,10 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupInfo info)? onJoinedGroupAdded; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onJoinedGroupAdded:(OIMGroupInfo *)groupInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | --------------------------------------------------- | -------- | -| groupInfo | [OIMGroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onJoinedGroupAdded(GroupInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onJoinedGroupAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnJoinedGroupAdded, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onJoinedGroupAdded(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnJoinedGroupAdded, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnJoinedGroupAdded(GroupInfo info); - -``` ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | +| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群信息 | - - diff --git a/docs/sdks/callback/onJoinedGroupDeleted.mdx b/docs/sdks/callback/onJoinedGroupDeleted.mdx index c715dffd50..4b71cc5db1 100644 --- a/docs/sdks/callback/onJoinedGroupDeleted.mdx +++ b/docs/sdks/callback/onJoinedGroupDeleted.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(GroupInfo info)? onJoinedGroupDeleted; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onJoinedGroupDeleted:(OIMGroupInfo *)groupInfo; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | --------------------------------------------------- | -------- | -| groupInfo | [OIMGroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | - - - - - -### 返回原型 - -```java showLineNumbers - void onJoinedGroupDeleted(GroupInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 好友信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onJoinedGroupDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnJoinedGroupDeleted, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onJoinedGroupDeleted(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------- | -------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 群聊信息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnJoinedGroupDeleted, ({ data }) => { - // data 群信息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnJoinedGroupDeleted(GroupInfo info); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------ | -------- | -| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群聊信息 | +| info | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 群信息 | - - diff --git a/docs/sdks/callback/onKickedOffline.mdx b/docs/sdks/callback/onKickedOffline.mdx index 9de2e646a3..da9a399d4e 100644 --- a/docs/sdks/callback/onKickedOffline.mdx +++ b/docs/sdks/callback/onKickedOffline.mdx @@ -13,116 +13,7 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - - Function()? onKickedOffline; - -``` - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onKickedOffline; - -``` - - - - - -### 返回原型 - -```java showLineNumbers - -public void onKickedOffline() - -``` - - - - -### 返回原型 - -```ts showLineNumbers - -onKickedOffline(data: WSEvent): void; - -``` - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnKickedOffline, () => {}); -``` - ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------- | ---- | -| data | [WSEvent](docs/sdks/class/response.mdx) | - | - - - - - -### 返回原型 - -```ts showLineNumbers - -onKickedOffline(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------- | ---- | -| data | [WSEvent](docs/sdks/class/response.mdx) | - | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnKickedOffline, () => {}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnKickedOffline(); -``` +无 - - diff --git a/docs/sdks/callback/onNewConversation.mdx b/docs/sdks/callback/onNewConversation.mdx index 778ec23260..8812ef2e3f 100644 --- a/docs/sdks/callback/onNewConversation.mdx +++ b/docs/sdks/callback/onNewConversation.mdx @@ -14,8 +14,12 @@ toc_max_heading_level: 2 ::: + + ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------------------------- | -------- | -| list | [][ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx)>| 会话信息 | +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| conversationList | `[]`[ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx) | 会话信息 | + + diff --git a/docs/sdks/callback/onNewRecvMessageRevoked.mdx b/docs/sdks/callback/onNewRecvMessageRevoked.mdx index e9259d47bf..8a197b1c9a 100644 --- a/docs/sdks/callback/onNewRecvMessageRevoked.mdx +++ b/docs/sdks/callback/onNewRecvMessageRevoked.mdx @@ -14,142 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(RevokedInfo info)? onRecvMessageRevokedV2; -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------------ | -------- | | info | [RevokedInfo](docs/sdks/class/message/revokedInfo.mdx) | 撤回信息详情 | - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onNewRecvMessageRevoked:(OIMMessageRevokedInfo *)messageRevoked; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| -------------- | ---------------------------------------------------------------- | -------- | -| messageRevoked | [OIMMessageRevokedInfo](docs/sdks/class/message/revokedInfo.mdx) | 撤回信息详情 | - - - - - -### 返回原型 - -```java showLineNumbers - void onRecvMessageRevokedV2(RevokedInfo info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------ | -------- | -| info | [RevokedInfo](docs/sdks/class/message/revokedInfo.mdx) | 撤回信息 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onNewRecvMessageRevoked(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[RevokedInfo](docs/sdks/class/message/revokedInfo.mdx)> | 撤回信息详情 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnNewRecvMessageRevoked, ({ data }) => { - // data 撤回信息详情 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onNewRecvMessageRevoked(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[RevokedInfo](docs/sdks/class/message/revokedInfo.mdx)> | 撤回信息详情 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnNewRecvMessageRevoked, ({ data }) => { - // data 撤回信息详情 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnNewRecvMessageRevoked(MessageRevoked info); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------ | -------- | -| info | [MessageRevoked](docs/sdks/class/message/revokedInfo.mdx) | 撤回信息详情 | - - - diff --git a/docs/sdks/callback/onProgress.mdx b/docs/sdks/callback/onProgress.mdx index 0ec09d4123..a52c7b234f 100644 --- a/docs/sdks/callback/onProgress.mdx +++ b/docs/sdks/callback/onProgress.mdx @@ -14,115 +14,10 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - -Function(String clientMsgID, int progress)? onProgress; - -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ------ | --------- | -------- | | clientMsgID | String | 消息ID | -| progress | int | 进度值 | - - - - - -### 返回原型 - -```swift showLineNumbers - -typedef void (^OIMNumberCallback)(NSInteger number); - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ------ | --------- | -------- | -| number | NSInteger | 进度值 | - - - - -### 返回原型 - -```java showLineNumbers - - void onProgress(long progress) - -``` -### 返回结果 - -| 名称 | 类型 | 描述 | -| ------ | --------- | -------- | -| progress | long | 发送消息进度 | - - - - - -### 发送消息进度回调 - -```ts showLineNumbers - -onProgress(data: WSEvent): void; - -``` - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnProgress, ({ data }) => { - // data 消息发送进度 -}); -``` - - - - - -### 发送消息进度回调 - -```ts showLineNumbers - -onProgress(data: WSEvent): void; - -``` - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnProgress, ({ data }) => { - // data 消息发送进度 -}); -``` - - +| progress | int | 进度值（最大100） | - diff --git a/docs/sdks/callback/onRecvC2CReadReceipt.mdx b/docs/sdks/callback/onRecvC2CReadReceipt.mdx index 09052d96a5..d509130c2f 100644 --- a/docs/sdks/callback/onRecvC2CReadReceipt.mdx +++ b/docs/sdks/callback/onRecvC2CReadReceipt.mdx @@ -14,141 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(List list)? onRecvC2CMessageReadReceipt; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------- | -------- | -| list | List<[ReadReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)> | 已读回执列表 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onRecvC2CReadReceipt:(NSArray *)receiptList; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ----------------------------------------------------------------------- | -------- | -| receiptList | NSArray< [OIMReceiptInfo](docs/sdks/class/message/receiptInfo.mdx) \* > | 已读回执列表 | - - - - - - -```java showLineNumbers - void onRecvC2CMessageReadReceipt(List list) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------- | -------- | -| list | List<[ReadReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)> | 回执列表 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvC2CReadReceipt(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[ReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)[]> | 已读回执列表 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvC2CReadReceipt, ({ data }) => { - // data 已读回执列表 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvC2CReadReceipt(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[ReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)[]> | 已读回执列表 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvC2CReadReceipt, ({ data }) => { - // data 已读回执列表 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnRecvC2CReadReceipt(List list); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ---------------------------------------------------------------- | -------- | -| list | List<[MessageReceipt](docs/sdks/class/message/receiptInfo.mdx)> | 已读回执列表 | +| list | `[]`[ReadReceiptInfo](docs/sdks/class/message/receiptInfo.mdx) | 已读回执列表 | - - diff --git a/docs/sdks/callback/onRecvGroupReadReceipt.mdx b/docs/sdks/callback/onRecvGroupReadReceipt.mdx deleted file mode 100644 index 1c53261e25..0000000000 --- a/docs/sdks/callback/onRecvGroupReadReceipt.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -sidebar_position: 3 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# onRecvGroupReadReceipt - -## 功能介绍 - -:::info - -自己发出的群聊消息被群成员标记为已读后，消息发送者和标记者均会收到此回调。 - -::: - - - - - -### 返回原型 - -```dart showLineNumbers - Function(List list)? onRecvGroupMessageReadReceipt; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------- | -------- | -| list | List<[ReadReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)> | 已读回执列表 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onRecvGroupReadReceipt:(NSArray *)receiptList; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----------- | ----------------------------------------------------------------------- | -------- | -| receiptList | NSArray< [OIMReceiptInfo](docs/sdks/class/message/messageInfo.mdx) \* > | 已读回执列表 | - - - - - -### 返回原型 - -```java showLineNumbers - void onRecvGroupMessageReadReceipt(List list) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------- | -------- | -| list | List<[ReadReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)> | 回执列表 | - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvGroupReadReceipt(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[ReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)[]> | 已读回执列表 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvGroupReadReceipt, ({ data }) => { - // data 已读回执列表 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvGroupReadReceipt(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[ReceiptInfo](docs/sdks/class/message/receiptInfo.mdx)[]> | 已读回执列表 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvGroupReadReceipt, ({ data }) => { - // data 已读回执列表 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnRecvGroupReadReceipt(List list); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---------------------------------------------------------------- | -------- | -| list | List<[MessageReceipt](docs/sdks/class/message/receiptInfo.mdx)> | 已读回执列表 | - - - diff --git a/docs/sdks/callback/onRecvNewMessage.mdx b/docs/sdks/callback/onRecvNewMessage.mdx index a8e0352dbe..a8454a678d 100644 --- a/docs/sdks/callback/onRecvNewMessage.mdx +++ b/docs/sdks/callback/onRecvNewMessage.mdx @@ -15,142 +15,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(Message msg)? onRecvNewMessage; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | -------------------------------------------------- | ------ | -| msg | [Message](docs/sdks/class/message/messageInfo.mdx) | 消息体 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onRecvNewMessage:(OIMMessageInfo *)msg; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------------------------- | ------ | -| msg | [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) | 消息体 | - - - - - -### 返回原型 - -```java showLineNumbers -void onRecvNewMessage(Message msg) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | -------------------------------------------------- | ------ | -| msg | [Message](docs/sdks/class/message/messageInfo.mdx) | 消息体 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvNewMessage(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvNewMessage, ({ data }) => { - // data 新消息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvNewMessage(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvNewMessage, ({ data }) => { - // data 新消息 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnRecvNewMessage(Message msg); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | -------------------------------------------------- | ------ | -| msg | [Message](docs/sdks/class/message/messageInfo.mdx) | 消息体 | +| message | [Message](docs/sdks/class/message/messageInfo.mdx) | 新消息 | - - diff --git a/docs/sdks/callback/onRecvNewMessages.mdx b/docs/sdks/callback/onRecvNewMessages.mdx index d8baea7e6f..563322f922 100644 --- a/docs/sdks/callback/onRecvNewMessages.mdx +++ b/docs/sdks/callback/onRecvNewMessages.mdx @@ -14,90 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - - - - - -### 返回原型 - - - - - -### 参数详解 - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvNewMessages(data: WSEvent): void; - -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)[]> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvNewMessages, ({ data }) => { - // data 新消息列表 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvNewMessages(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)[]> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvNewMessages, ({ data }) => { - // data 新消息列表 -}); -``` - - +| messageList | `[]`[Message](docs/sdks/class/message/messageInfo.mdx) | 新消息列表 | - diff --git a/docs/sdks/callback/onRecvOfflineNewMessage.mdx b/docs/sdks/callback/onRecvOfflineNewMessage.mdx index 16e9b7c554..bc838acf73 100644 --- a/docs/sdks/callback/onRecvOfflineNewMessage.mdx +++ b/docs/sdks/callback/onRecvOfflineNewMessage.mdx @@ -15,128 +15,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart -void recvOfflineNewMessage(Message msg) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | -------------------------------------------------------- | ---------- | -| msg | [Message](docs/sdks/class/message/messageInfo.mdx) | 新离线消息 | - - - - - -### 返回原型 - - - - - -```java showLineNumbers - -void onRecvOfflineNewMessage(List msg) - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | -------------------------------------------------------- | ---------- | -| msg | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | 新离线消息 | - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvOfflineNewMessage(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)> | 新离线消息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvOfflineNewMessage, ({ data }) => { - // data 新离线消息 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvOfflineNewMessage(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ----------------------------------------------------------------------------------------------- | ---------- | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)> | 新离线消息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvOfflineNewMessage, ({ data }) => { - // data 新离线消息 -}); -``` - - - - - -### 返回原型 - -```C# -void OnRecvOfflineNewMessage(Message msg); -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | -------------------------------------------------------- | ---------- | -| msg | [Message](docs/sdks/class/message/messageInfo.mdx) | 新离线消息 | +| message | [Message](docs/sdks/class/message/messageInfo.mdx) | 新离线消息 | - - diff --git a/docs/sdks/callback/onRecvOfflineNewMessages.mdx b/docs/sdks/callback/onRecvOfflineNewMessages.mdx index 324556862c..c361caa4f6 100644 --- a/docs/sdks/callback/onRecvOfflineNewMessages.mdx +++ b/docs/sdks/callback/onRecvOfflineNewMessages.mdx @@ -14,90 +14,9 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - - - - - -### 返回原型 - - - - - -### 参数详解 - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvOfflineNewMessages(data: WSEvent): void; - -``` - ### 返回结果 | 名称 | 类型 | 描述 | | ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)[]> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnRecvOfflineNewMessages, ({ data }) => { - // data 新离线消息列表 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onRecvOfflineNewMessages(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------------------------------------------------------- | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx)<[MessageItem](docs/sdks/class/message/messageInfo.mdx)[]> | 新消息 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnRecvOfflineNewMessages, ({ data }) => { - // data 新离线消息列表 -}); -``` - - +| messageList | `[]`[Message](docs/sdks/class/message/messageInfo.mdx)[]> | 新消息列表 | - diff --git a/docs/sdks/callback/onRecvOnlineOnlyMessage.mdx b/docs/sdks/callback/onRecvOnlineOnlyMessage.mdx new file mode 100644 index 0000000000..fc1fb53b23 --- /dev/null +++ b/docs/sdks/callback/onRecvOnlineOnlyMessage.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 3 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# onRecvOnlineOnlyMessage + +## 功能介绍 + +:::info + +当app处于前台，接收到仅仅在线消息（该消息不会被存储，正在输入的消息不会走该回调）时，会收到该回调 + +::: + +### 返回结果 + +| 名称 | 类型 | 描述 | +| ---- | -------------------------------------------------------- | ---------- | +| message | [Message](docs/sdks/class/message/messageInfo.mdx) | 在线消息 | + diff --git a/docs/sdks/callback/onSelfUserInfoUpdate.mdx b/docs/sdks/callback/onSelfInfoUpdated.mdx similarity index 78% rename from docs/sdks/callback/onSelfUserInfoUpdate.mdx rename to docs/sdks/callback/onSelfInfoUpdated.mdx index 58d9dc5cb4..caed48082c 100644 --- a/docs/sdks/callback/onSelfUserInfoUpdate.mdx +++ b/docs/sdks/callback/onSelfInfoUpdated.mdx @@ -14,8 +14,8 @@ toc_max_heading_level: 2 ::: -### 返回数据 +### 返回结果 | 名称 | 类型 | 描述 | | ---- | --------------------------------------------- | -------- | -| user | [UserInfo](docs/sdks/class/user/userInfo.mdx) | 个人信息 | +| userInfo | [UserInfo](docs/sdks/class/user/userInfo.mdx) | 个人信息 | diff --git a/docs/sdks/callback/onSyncServerFailed.mdx b/docs/sdks/callback/onSyncServerFailed.mdx index 2a2fb1ba28..a7eb0ad791 100644 --- a/docs/sdks/callback/onSyncServerFailed.mdx +++ b/docs/sdks/callback/onSyncServerFailed.mdx @@ -10,128 +10,12 @@ toc_max_heading_level: 2 :::info -向服务器同步会话失败时的回调。 +由于网络或者其他原因，同步服务器数据失败时的回调。 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function()? onSyncServerFailed; -``` - -### 返回结果 - -无 - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onSyncServerFailed; - -``` - -### 返回结果 - -无 - - - - - -### 返回原型 - -```java showLineNumbers - void onSyncServerFailed() -``` - -### 返回结果 - -无 - - - - - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerFailed(): void; - -``` - -### 返回结果 - -无 - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnSyncServerFailed, () => {}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerFailed(): void; - -``` - -### 返回结果 - -无 - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerFailed, () => {}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnSyncServerFailed(); -``` - ### 返回结果 - - +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| reinstalled | bool | 是否卸载重装| diff --git a/docs/sdks/callback/onSyncServerFinish.mdx b/docs/sdks/callback/onSyncServerFinish.mdx index ad27f530de..411351f902 100644 --- a/docs/sdks/callback/onSyncServerFinish.mdx +++ b/docs/sdks/callback/onSyncServerFinish.mdx @@ -10,131 +10,12 @@ toc_max_heading_level: 2 :::info -向服务器同步会话成功时的回调。 +向服务器同步数据成功时的回调。 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function()? onSyncServerFinish; -``` - -### 返回结果 - -无 - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onSyncServerFinish; - -``` - -### 返回结果 - -无 - - - - - - -### 返回原型 - -```java showLineNumbers - void onSyncServerFinish() -``` - -### 返回结果 - -无 - - - - - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerFinish(): void; - -``` - ### 返回结果 -无 - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnSyncServerFinish, () => {}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerFinish(): void; - -``` - -### 返回结果 - -无 - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerFinish, () => {}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnSyncServerFinish(); -``` - -### 返回结果 - -无 - - - +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| reinstalled | bool | 是否卸载重装| diff --git a/docs/sdks/callback/onSyncServerProgress.mdx b/docs/sdks/callback/onSyncServerProgress.mdx new file mode 100644 index 0000000000..c3f61bfc50 --- /dev/null +++ b/docs/sdks/callback/onSyncServerProgress.mdx @@ -0,0 +1,23 @@ +--- +sidebar_position: 3 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# onSyncServerProgress + +## 功能介绍 + +:::info + +向服务器同步数据的进度回调,app卸载重装时才会触发： + +当app非卸载重装时，代表sdk重新登录或者断线重连的数据同步，此时不会触发OnSyncServerProgress + +::: + +### 返回结果 + +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| progress | int | 同步进度（最大100）| diff --git a/docs/sdks/callback/onSyncServerStart.mdx b/docs/sdks/callback/onSyncServerStart.mdx index 5ece18ac5e..e6f2d91af4 100644 --- a/docs/sdks/callback/onSyncServerStart.mdx +++ b/docs/sdks/callback/onSyncServerStart.mdx @@ -10,130 +10,19 @@ toc_max_heading_level: 2 :::info -向服务器同步会话开始时的回调。 +向服务器同步数据开始时的回调： -::: - - - - - -### 返回原型 - -```dart showLineNumbers -Function()? onSyncServerStart; -``` - -### 返回结果 - -无 - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onSyncServerStart; - -``` - -### 返回结果 - -无 - - - - - - -### 返回原型 - -```java showLineNumbers - void onSyncServerStart() -``` - -### 返回结果 - -无 +当reinstalled为false，代表sdk重新登录或者断线重连的数据同步，此时不会触发OnSyncServerProgress，OnSyncServerFinish会在数据同步完成后触发。 - +当reinstalled为true时，即表示卸载重装后的数据同步，可利用OnSyncServerProgress处理同步进度。 - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerStart(): void; - -``` - -### 返回结果 - -无 - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnSyncServerStart, () => {}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onSyncServerStart(): void; +::: -``` ### 返回结果 -无 - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerStart, () => {}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnSyncServerStart(); -``` - -### 返回结果 +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| reinstalled | bool | 是否卸载重装| -无 - - diff --git a/docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx b/docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx index bbadbd2faa..168f1f6a2e 100644 --- a/docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx +++ b/docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx @@ -14,143 +14,8 @@ toc_max_heading_level: 2 ::: - - - - -### 返回原型 - -```dart showLineNumbers - Function(int count)? onTotalUnreadMessageCountChanged; -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----- | ---- | ---------- | -| count | int | 未读数 | - - - - - -### 返回原型 - -```swift showLineNumbers - -- (void)onTotalUnreadMessageCountChanged:(NSInteger)totalUnreadCount; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---------------- | --------- | ---------- | -| totalUnreadCount | NSInteger | 未读数 | - - - - - -### 返回原型 - -```java showLineNumbers -void onTotalUnreadMessageCountChanged(int count) -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----- | ---- | ---------- | -| count | int | 未读数变化 | - - - - - - -### 返回原型 - -```ts showLineNumbers - -onTotalUnreadMessageCountChanged(data: WSEvent): void; - -``` - ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx) | 未读数 | - -### 调用示例 - -```js showLineNumbers -import { getSDK, CbEvents } from '@openim/wasm-client-sdk'; -// or -// import { getSDK, CbEvents } from '@openim/client-sdk'; -// const IMSDK = getSDK(); -const IMSDK = getSDK(); - -IMSDK.on(CbEvents.OnTotalUnreadMessageCountChanged, ({ data }) => { - // data 消息未读数 -}); -``` - - - - - -### 返回原型 - -```ts showLineNumbers - -onTotalUnreadMessageCountChanged(data: WSEvent): void; - -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ------------------------------------------------ | ------ | -| data | [WSEvent](docs/sdks/class/response.mdx) | 未读数 | - -### 调用示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.subscribe(IMSDK.IMEvents.OnTotalUnreadMessageCountChanged, ({ data }) => { - // data 消息未读数 -}); -``` - - - - - -### 返回原型 - -```C# showLineNumbers -void OnTotalUnreadMessageCountChanged(int count); -``` - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ----- | ---- | ---------- | -| count | int | 未读数 | - - - - +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | +| totalUnreadCount | int | 未读数 | diff --git a/docs/sdks/callback/onUserStatusChanged.mdx b/docs/sdks/callback/onUserStatusChanged.mdx index c29046b4cb..e38a7a6cd1 100644 --- a/docs/sdks/callback/onUserStatusChanged.mdx +++ b/docs/sdks/callback/onUserStatusChanged.mdx @@ -14,6 +14,9 @@ toc_max_heading_level: 2 ::: -| 名称 | 类型 | 描述 | -| ---- | -------------- | -------- | + +### 返回结果 + +| 字段名称 | 类型 | 描述 | +| ---- | ------------------------------------------------------ | -------- | | info | [UserStatusInfo](docs/sdks/class/user/userStatusInfo.mdx) | 用户状态信息 | \ No newline at end of file diff --git a/docs/sdks/callback/onUserTokenExpired.mdx b/docs/sdks/callback/onUserTokenExpired.mdx index 72cd57e2be..e22a99e643 100644 --- a/docs/sdks/callback/onUserTokenExpired.mdx +++ b/docs/sdks/callback/onUserTokenExpired.mdx @@ -9,12 +9,10 @@ toc_max_heading_level: 2 :::info -token 无效回调。 +token 过期回调。 ::: ### 返回结果 -| 名称 | 类型 | 描述 | -| ---- | --------------------------------------- | ---- | -| data | [WSEvent](docs/sdks/class/response.mdx) | - | +无 \ No newline at end of file diff --git a/docs/sdks/callback/onUserTokenInvalid.mdx b/docs/sdks/callback/onUserTokenInvalid.mdx new file mode 100644 index 0000000000..dd814d687f --- /dev/null +++ b/docs/sdks/callback/onUserTokenInvalid.mdx @@ -0,0 +1,17 @@ +--- +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# onUserTokenInvalid + +## 功能介绍 + +:::info +由于平台号填写错误、系统异常或其他原因造成的token无效回调。 + +::: + +### 返回结果 + +无 diff --git a/docs/sdks/class/conversation/conversationInfo.mdx b/docs/sdks/class/conversation/conversationInfo.mdx index e1a1abb27a..050e13e862 100644 --- a/docs/sdks/class/conversation/conversationInfo.mdx +++ b/docs/sdks/class/conversation/conversationInfo.mdx @@ -18,24 +18,21 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| conversationID | string | 会话 ID | -| conversationType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| userID | string | 用户 ID | -| groupID | string | 群 ID | -| showName | string | 展示名称 | -| faceURL | string | 头像 | -| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 | -| unreadCount | int | 未读数 | -| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @类型 | -| latestMsgSendTime | int | 最新消息发送时间（毫秒） | -| draftText | string | 草稿 | -| draftTextTime | int | 生成草稿时间 | -| isPinned | bool | 是否置顶 | -| isPrivateChat | bool | 是否开启了阅后即焚 | -| burnDuration | int | 阅后即焚时间（秒） | -| isNotInGroup | bool | 暂未使用 | -| attachedInfo | string | 暂未使用 | -| latestMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 最新的一条消息 | -| ex | string | 扩展字段 | - - +| ConversationID | string | 会话 ID | +| ConversationType | [ConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | +| UserID | string | 用户 ID | +| GroupID | string | 群 ID | +| ShowName | string | 展示名称 | +| FaceURL | string | 头像 | +| RecvMsgOpt | [RecvMsgOpt](docs/sdks/enum/recvMsgOpt.mdx) | 会话消息接收选项 | +| UnreadCount | int | 未读数 | +| GroupAtType | [GroupAtType](docs/sdks/enum/groupAtType.mdx) | @类型 | +| LatestMsgSendTime | int | 最新消息发送时间（毫秒） | +| DraftText | string | 草稿 | +| DraftTextTime | int | 生成草稿时间(毫秒) | +| IsPinned | bool | 是否置顶 | +| IsPrivateChat | bool | 是否开启了阅后即焚 | +| BurnDuration | int | 阅后即焚时间（秒） | | +| AttachedInfo | string | 暂未使用 | +| LatestMsg | [MessageInfo](docs/sdks/class/message/messageInfo.mdx) | 最新的一条消息 | +| Ex | string | 扩展字段 | diff --git a/docs/sdks/class/conversation/conversationReq.mdx b/docs/sdks/class/conversation/conversationReq.mdx index 0c281c0157..6edd4aec3f 100644 --- a/docs/sdks/class/conversation/conversationReq.mdx +++ b/docs/sdks/class/conversation/conversationReq.mdx @@ -18,14 +18,9 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| conversationID | string | 会话 ID | -| conversationType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| userID | string | 用户 ID | -| groupID | string | 群 ID | -| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 | -| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @类型 | -| isPinned | bool | 是否置顶 | -| isPrivateChat | bool | 是否开启了阅后即焚 | -| burnDuration | int | 阅后即焚时间（秒） | -| attachedInfo | string | 暂未使用 | -| ex | string | 扩展字段 | +| RecvMsgOpt | [RecvMsgOpt](docs/sdks/enum/recvMsgOpt.mdx) | 会话消息接收选项 | +| GroupAtType | [GroupAtType](docs/sdks/enum/groupAtType.mdx) | @类型 | +| IsPinned | bool | 是否置顶 | +| IsPrivateChat | bool | 是否开启了阅后即焚 | +| BurnDuration | int | 阅后即焚时间（秒） | +| Ex | string | 扩展字段 | diff --git a/docs/sdks/class/conversation/index.mdx b/docs/sdks/class/conversation/index.mdx index 600bb399e5..be44716865 100644 --- a/docs/sdks/class/conversation/index.mdx +++ b/docs/sdks/class/conversation/index.mdx @@ -17,3 +17,4 @@ toc_max_heading_level: 2 | 模块名称 | 模块功能简介 | | --------------------------------------------------------------------- | ------------ | | [ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx) | 会话信息 | +| [ConversationReq](docs/sdks/class/conversation/conversationReq.mdx) | 变更会话相关属性 | diff --git a/docs/sdks/class/conversation/inputStatusChangedData.mdx b/docs/sdks/class/conversation/inputStatusChangedData.mdx index 9c356d6152..74dd49509e 100644 --- a/docs/sdks/class/conversation/inputStatusChangedData.mdx +++ b/docs/sdks/class/conversation/inputStatusChangedData.mdx @@ -4,7 +4,7 @@ toc_min_heading_level: 2 toc_max_heading_level: 2 --- -# inputStatusChangedData +# InputStatesChangedData ## 功能介绍 @@ -18,7 +18,9 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| userID | string | 用户ID | -| conversationID | string | 会话ID | -| platformIDs | [][int](/docs/sdks/enum/platform.mdx) | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7 | +| UserID | string | 用户ID | +| ConversationID | string | 会话ID | +| PlatformIDs | `[]`[IMPlatformID](/docs/sdks/enum/platform.mdx) | 平台号 | + + diff --git a/docs/sdks/class/group/CreateGroupReq.mdx b/docs/sdks/class/group/createGroupReq.mdx similarity index 52% rename from docs/sdks/class/group/CreateGroupReq.mdx rename to docs/sdks/class/group/createGroupReq.mdx index 5dc5310d41..4502537e3d 100644 --- a/docs/sdks/class/group/CreateGroupReq.mdx +++ b/docs/sdks/class/group/createGroupReq.mdx @@ -10,7 +10,9 @@ toc_max_heading_level: 2 :::info -创建群组请求。 +创建群组请求, + +注：MemberUserIDs和AdminUserIDs以及OwnerUserID彼此不可重复，独立填写。 ::: @@ -19,8 +21,8 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ---------------------- | --------------------------------------------------------- | ----------------------------------------- | -| MemberUserIDs | []string | 群ID | -| GroupInfo| [GroupInfo](/class/group/groupInfo.mdx) | 群名称 | -|AdminUserIDs | []string | 群公告 | -| OwnerUserID| string | 群简介 | +| MemberUserIDs | []string | 群成员id列表 | +| GroupInfo| [GroupInfo](/class/group/groupInfo.mdx) | 群信息 | +| AdminUserIDs | []string | 群管理员id列表 | +| OwnerUserID| string | 群主 | diff --git a/docs/sdks/class/group/groupApplicationInfo.mdx b/docs/sdks/class/group/groupApplicationInfo.mdx index 49c9117cf7..51e6a86e30 100644 --- a/docs/sdks/class/group/groupApplicationInfo.mdx +++ b/docs/sdks/class/group/groupApplicationInfo.mdx @@ -18,26 +18,26 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ------------- | -------- | ------------------------------------------------------------- | -| groupID | string | 群 ID | -| groupName | string | 群名称 | -| notification | string | 群公告 | -| introduction | string | 群简介 | -| groupFaceURL | string | 群头像 | -| createTime | int | 申请进群时间 | -| status | [int](docs/sdks/enum/groupStatus.mdx) | 群状态 | -| creatorUserID | string | 建群者 ID | -| groupType | [int](docs/sdks/enum/groupType.mdx) | 群类型 | -| ownerUserID | string | 群主 ID | -| memberCount | int | 群成员数量 | -| userID | string | 进群申请者 ID | -| nickname | string | 进群申请者昵称 | -| userFaceURL | string | 进群申请者头像 | -| handleResult | [int](docs/sdks/enum/handleResult.mdx) | 处理结果 | -| reqMsg | string | 申请加群的附加信息 | -| handledMsg | string | 处理附加信息 | -| reqTime | int | 申请进群时间 | -| handleUserID | string | 处理进群的用户 ID | -| handledTime | int | 处理近期申请时间 | -| ex | string | 扩展字段 | -| joinSource | [int](docs/sdks/enum/joinSource.mdx) | 进群方式 | -| inviterUserID | string | 邀请进群用户 ID | +| GroupID | string | 群 ID | +| GroupName | string | 群名称 | +| Notification | string | 群公告 | +| Introduction | string | 群简介 | +| GroupFaceURL | string | 群头像 | +| CreateTime | int | 申请进群时间 （毫秒） | +| Status | [GroupStatus](docs/sdks/enum/groupStatus.mdx) | 群状态 | +| CreatorUserID | string | 建群者 ID | +| GroupType | [GroupType](docs/sdks/enum/groupType.mdx) | 群类型 | +| OwnerUserID | string | 群主 ID | +| MemberCount | int | 群成员数量 | +| UserID | string | 进群申请者 ID | +| Nickname | string | 进群申请者昵称 | +| UserFaceURL | string | 进群申请者头像 | +| HandleResult | [HandleResult](docs/sdks/enum/handleResult.mdx) | 处理结果 | +| ReqMsg | string | 申请加群的附加信息 | +| HandledMsg | string | 处理附加信息 | +| ReqTime | int | 申请进群时间 （毫秒） | +| HandleUserID | string | 处理进群的用户 ID | +| HandledTime | int | 处理近期申请时间 （毫秒） | +| Ex | string | 扩展字段 | +| JoinSource | [JoinSource](docs/sdks/enum/joinSource.mdx) | 进群方式 | +| InviterUserID | string | 邀请进群用户 ID | diff --git a/docs/sdks/class/group/groupInfo.mdx b/docs/sdks/class/group/groupInfo.mdx index 04c0a6125c..a28d188831 100644 --- a/docs/sdks/class/group/groupInfo.mdx +++ b/docs/sdks/class/group/groupInfo.mdx @@ -18,20 +18,20 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ---------------------- | --------------------------------------------------------- | ----------------------------------------- | -| groupID | String | 群ID | -| groupName | String | 群名称 | -| notification | String | 群公告 | -| introduction | String | 群简介 | -| faceURL | String | 群头像 | -| createTime | int | 群创建时间 | -| status | [int](docs/sdks/enum/groupStatus.mdx) | 群状态 0 正常，1 被封，2 解散，3 禁言 | -| creatorUserID | String | 创建者ID | -| groupType | [int](docs/sdks/enum/groupType.mdx) | 群状态 | -| ownerUserID | String | 群主 ID | -| memberCount | int | 群成员数量 | -| ex | String | 扩展字段 | -| needVerification | [int](docs/sdks/enum/groupVerification.mdx) | 进群验证方式 | -| lookMemberInfo | [int](docs/sdks/enum/allowType.mdx) | 是否允许查看成员资料 | -| applyMemberFriend | [int](docs/sdks/enum/allowType.mdx) | 是否允许通过群添加好友 | -| notificationUpdateTime | int | 群公告更新时间 | -| notificationUserID | String | 群公告发布者ID | +| GroupID | string | 群ID | +| GroupName | string | 群名称 | +| Notification | string | 群公告 | +| Introduction | string | 群简介 | +| FaceURL | string | 群头像 | +| CreateTime | int | 群创建时间 | +| Status | [GroupStatus](docs/sdks/enum/groupStatus.mdx) | 群状态 | +| CreatorUserID | string | 创建者ID | +| GroupType | [GroupType](docs/sdks/enum/groupType.mdx) | 群状态 | +| OwnerUserID | string | 群主 ID | +| MemberCount | int | 群成员数量 | +| Ex | string | 扩展字段 | +| NeedVerification | [GroupVerification](docs/sdks/enum/groupVerification.mdx) | 进群验证方式 | +| LookMemberInfo | [AllowType](docs/sdks/enum/allowType.mdx) | 是否允许查看成员资料 | +| ApplyMemberFriend | [AllowType](docs/sdks/enum/allowType.mdx) | 是否允许通过群添加好友 | +| NotificationUpdateTime | int | 群公告更新时间 | +| NotificationUserID | string | 群公告发布者ID | diff --git a/docs/sdks/class/group/groupMemberInfo.mdx b/docs/sdks/class/group/groupMemberInfo.mdx index e547233ce0..ba907b78df 100644 --- a/docs/sdks/class/group/groupMemberInfo.mdx +++ b/docs/sdks/class/group/groupMemberInfo.mdx @@ -19,14 +19,14 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | ------------------------------------ | -------------------------------------------------- | -| groupID | string | 群 ID | -| userID | string | 群成员 ID | -| nickname | string | 群成员昵称 | -| faceURL | string | 群成员头像 | -| roleLevel | int | 群成员角色 1 普通成员；2 群主；3 管理员 | -| joinTime | int | 群成员进群时间 | -| joinSource | [int](docs/sdks/enum/joinSource.mdx) | 入群方式 2：邀请加入 3：搜索加入 4：通过二维码加入 | -| inviterUserID | string | 邀请者 ID | -| muteEndTime | int | 禁言结束时间 | -| operatorUserID | string | 同意进群的用户 ID | -| ex | string | 扩展信息 | +| GroupID | string | 群 ID | +| UserID | string | 群成员 ID | +| Nickname | string | 群成员昵称 | +| FaceURL | string | 群成员头像 | +| RoleLevel | [RoleLevel](docs/sdks/enum/roleLevel.mdx) | 群成员角色等级 | +| JoinTime | int | 群成员进群时间（毫秒） | +| JoinSource | [JoinSource](docs/sdks/enum/joinSource.mdx) | 入群方式 | +| InviterUserID | string | 邀请者 ID | +| MuteEndTime | int | 禁言结束时间（毫秒） | +| OperatorUserID | string | 同意进群的用户 ID | +| Ex | string | 扩展信息 | diff --git a/docs/sdks/class/group/SearchGroupMembersParam.mdx b/docs/sdks/class/group/searchGroupMembersParam.mdx similarity index 100% rename from docs/sdks/class/group/SearchGroupMembersParam.mdx rename to docs/sdks/class/group/searchGroupMembersParam.mdx diff --git a/docs/sdks/class/group/SearchGroupsParam.mdx b/docs/sdks/class/group/searchGroupsParam.mdx similarity index 100% rename from docs/sdks/class/group/SearchGroupsParam.mdx rename to docs/sdks/class/group/searchGroupsParam.mdx diff --git a/docs/sdks/class/group/SetGroupMemberInfo.mdx b/docs/sdks/class/group/setGroupMemberInfo.mdx similarity index 59% rename from docs/sdks/class/group/SetGroupMemberInfo.mdx rename to docs/sdks/class/group/setGroupMemberInfo.mdx index 54e2f9a661..ea3bfe0acb 100644 --- a/docs/sdks/class/group/SetGroupMemberInfo.mdx +++ b/docs/sdks/class/group/setGroupMemberInfo.mdx @@ -19,9 +19,9 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | ------------------------------------ | -------------------------------------------------- | -| groupID | string | 群 ID | -| userID | string | 群成员 ID | -| nickname | string | 群成员昵称 | -| faceURL | string | 群成员头像 | -| roleLevel | int | 群成员角色 1 普通成员；2 群主；3 管理员 | -| ex | string | 扩展信息 | +| GroupID | string | 群 ID | +| UserID | string | 群成员 ID | +| Nickname | string | 群成员昵称 | +| FaceURL | string | 群成员头像 | +| RoleLevel | [RoleLevel](docs/sdks/enum/roleLevel.mdx) | 群成员角色等级 | +| Ex | string | 扩展信息 | diff --git a/docs/sdks/class/init/config.mdx b/docs/sdks/class/init/config.mdx index a2999d24a0..d8dbe2477b 100644 --- a/docs/sdks/class/init/config.mdx +++ b/docs/sdks/class/init/config.mdx @@ -18,11 +18,11 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 是否必填 | 描述 | | ------------------- | ----------------------------------- | -------- | -------------------------------------------------------------------- | -| platformID | [int](/docs/sdks/enum/platform.mdx) | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7 | -| apiAddr | string | 是 | IM api 地址，一般为`http://xxx:10002`或`https://xxx/api` | -| wsAddr | string | 是 | IM ws 地址，一般为`ws://xxx:10001`或`wss://xxx/msg_gateway` | -| dataDir | string | 是 | IM 客户端 DB 存放目录 | -| logLevel | int | 否 | SDK 日志打印级别 | -| isLogStandardOutput | bool | 否 | 是否将日志打印到控制台 | -| logFilePath | string | 否 | 本地保存日志文件路径 | -| logRemainCount | int | 否 | 本地保存日志文件个数 | +| PlatformID | [IMPlatformID](/docs/sdks/enum/platform.mdx) | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7 | +| ApiAddr | string | 是 | IM api 地址，一般为`http://xxx:10002`或`https://xxx/api` | +| WsAddr | string | 是 | IM ws 地址，一般为`ws://xxx:10001`或`wss://xxx/msg_gateway` | +| DataDir | string | 是 | IM 客户端 DB 存放目录 | +| LogLevel | int | 否 | SDK 日志打印级别 | +| IsLogStandardOutput | bool | 否 | 是否将日志打印到控制台 | +| LogFilePath | string | 否 | 本地保存日志文件路径 | +| LogRemainCount | int | 否 | 本地保存日志文件个数 | diff --git a/docs/sdks/class/message/advancedHistoryInfo.mdx b/docs/sdks/class/message/advancedHistoryInfo.mdx index b541b1c10a..e7b66f584e 100644 --- a/docs/sdks/class/message/advancedHistoryInfo.mdx +++ b/docs/sdks/class/message/advancedHistoryInfo.mdx @@ -14,115 +14,12 @@ toc_max_heading_level: 2 ::: - - - - -### AdvancedMessage - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------- | ---------------------- | -| isEnd | bool | 是否拉取到最后一条消息 | -| lastMinSeq | int | 用于下一次请求参数 | -| errCode | int | 错误码，为 0 时正常 | -| errMsg | String | 错误信息 | -| messageList | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | 消息列表 | - - - - - -### OIMGetAdvancedHistoryMessageListInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ------------------------------------------------------------------------ | ---------------------- | -| isEnd | BOOL | 是否拉取到最后一条消息 | -| lastMinSeq | NSInteger | 用于下一次请求参数 | -| errCode | NSInteger | 错误码，为 0 时正常 | -| errMsg | NSString | 错误信息 | -| messageList | NSArray < [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) \* > | 消息列表 | - - - - - ### AdvancedMessage -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------- | ---- | -| isEnd | boolean | | -| lastMinSeq | int | | -| errCode | int | | -| errMsg | String | | -| messageList | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | | - - - - - -### AdvancedGetMessageResult - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------- | ---------------------- | -| isEnd | boolean | 是否拉取到最后一条消息 | -| lastMinSeq | number | 用于下一次请求参数 | -| errCode | number | 错误码，为 0 时正常 | -| errMsg | string | 错误信息 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 消息列表 | - - - - - -### AdvancedGetMessageResult - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------- | ---------------------- | -| isEnd | boolean | 是否拉取到最后一条消息 | -| lastMinSeq | number | 用于下一次请求参数 | -| errCode | number | 错误码，为 0 时正常 | -| errMsg | string | 错误信息 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 消息列表 | - - - - - - -### AdvancedGetMessageResult - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------- | ---------------------- | -| isEnd | boolean | 是否拉取到最后一条消息 | -| lastMinSeq | number | 用于下一次请求参数 | -| errCode | number | 错误码，为 0 时正常 | -| errMsg | string | 错误信息 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 消息列表 | - - - - - -### AdvancedHistoryMessageData - | 字段名称 | 字段类型 | 描述 | | ----------- | -------------------------------------------------------- | ---------------------- | -| IsEnd | bool | 是否拉取到最后一条消息 | -| LastMinSeq | int | 用于下一次请求参数 | +| IsEnd | bool | 消息拉取是否到底 | | ErrCode | int | 错误码，为 0 时正常 | | ErrMsg | string | 错误信息 | -| MessageList | [Message](docs/sdks/class/message/messageInfo.mdx)[] | 消息列表 | +| MessageList | `[]`[Message](docs/sdks/class/message/messageInfo.mdx) | 消息列表 | - - diff --git a/docs/sdks/class/message/atElem.mdx b/docs/sdks/class/message/atElem.mdx deleted file mode 100644 index 5f38609aae..0000000000 --- a/docs/sdks/class/message/atElem.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -sidebar_position: 2 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# AtElem - -## 功能介绍 - -:::info - -@信息。 - -::: - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | ----------------- | -| text | String | 消息内容 | -| atUserList | List | 被@的用户 ID 集合 | -| atUsersInfo | List<[AtUserInfo](docs/sdks/class/message/atInfo.mdx)> | 被@的用户集合 | -| quoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | bool | 自己是否被@了 | - - - - - -### OIMAtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------------- | ----------------- | -| text | NSString | 消息内容 | -| atUserList | NSArray | 被@的用户 ID 集合 | -| atUsersInfo | NSArray< [OIMAtInfo](docs/sdks/class/message/atInfo.mdx) \* > | 被@的用户集合 | -| quoteMessage | [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | BOOL | 自己是否被@了 | -| isAtAll | BOOL | 是否@全体成员 | - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | ----------------- | -| text | String | 消息内容 | -| atUserList | List | 被@的用户 ID 集合 | -| atUsersInfo | List<[AtUserInfo](docs/sdks/class/message/atInfo.mdx)> | 被@的用户集合 | -| quoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | boolean - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | --------------------- | -| text | string | 消息内容 | -| atUserList | string[] | 被@的用户 userID 列表 | -| atUsersInfo | [AtUserInfo](docs/sdks/class/message/atInfo.mdx)[] | 被@的用户信息列表 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | boolean | 自己是否被@了 | - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | --------------------- | -| text | string | 消息内容 | -| atUserList | string[] | 被@的用户 userID 列表 | -| atUsersInfo | [AtUserInfo](docs/sdks/class/message/atInfo.mdx)[] | 被@的用户信息列表 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | boolean | 自己是否被@了 | - - - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | --------------------- | -| text | string | 消息内容 | -| atUserList | string[] | 被@的用户 userID 列表 | -| atUsersInfo | [AtUserInfo](docs/sdks/class/message/atInfo.mdx)[] | 被@的用户信息列表 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| isAtSelf | boolean | 自己是否被@了 | - - - - - -### AtTextElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | ------------------------------------------------------ | ----------------- | -| Text | string | 消息内容 | -| AtUserList | string[] | 被@的用户 ID 集合 | -| AtUsersInfo | [AtUserInfo](docs/sdks/class/message/atInfo.mdx)[] | 被@的用户集合 | -| QuoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | -| IsAtSelf | bool | 自己是否被@了 | - - - diff --git a/docs/sdks/class/message/atInfo.mdx b/docs/sdks/class/message/atInfo.mdx index 5b6878c30d..dcea850450 100644 --- a/docs/sdks/class/message/atInfo.mdx +++ b/docs/sdks/class/message/atInfo.mdx @@ -10,99 +10,15 @@ toc_max_heading_level: 2 :::info -@成员信息。 +@消息详细群成员信息。 ::: - - - -### AtUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | -------------------- | -| atUserID | String | at 成员的 ID | -| groupNickname | String | at 成员的昵称/群名片 | - - - - - -### OIMAtInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | -------------------- | -| atUserID | NSString | at 成员的 ID | -| groupNickname | NSString | at 成员的昵称/群名片 | - - - - - -### AtUserInfo +### AtInfo | 字段名称 | 字段类型 | 描述 | | ------------- | -------- | -------------------- | | atUserID | String | at 成员的 ID | | groupNickname | String | at 成员的昵称/群名片 | - - - - -### AtUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | ------------- | -| atUserID | string | at 成员的 ID | -| groupNickname | string | at 成员的昵称 | - - - - - -### AtUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | ------------- | -| atUserID | string | at 成员的 ID | -| groupNickname | string | at 成员的昵称 | - - - - - - -### AtUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | ------------- | -| atUserID | string | at 成员的 ID | -| groupNickname | string | at 成员的昵称 | - - - - - -### AtInfo - -| 字段名称 | 字段类型 | 描述 | -| ------------- | -------- | -------------------- | -| AtUserID | string | at 成员的 ID | -| GroupNickname | string | at 成员的昵称/群名片 | - - - - diff --git a/docs/sdks/class/message/atTextElem.mdx b/docs/sdks/class/message/atTextElem.mdx new file mode 100644 index 0000000000..df4fd35640 --- /dev/null +++ b/docs/sdks/class/message/atTextElem.mdx @@ -0,0 +1,25 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# AtTextElem + +## 功能介绍 + +:::info + +@消息详情。 + +::: + +### AtTextElem + +| 字段名称 | 字段类型 | 描述 | +| ------------ | ------------------------------------------------------ | ----------------- | +| Text | string | 消息内容 | +| AtUserList | `[]`string | 被@的用户 ID 列表 | +| AtUsersInfo | `[]`[AtInfo](docs/sdks/class/message/atInfo.mdx) | 被@的用户信息列表 | +| QuoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 引用消息 | + diff --git a/docs/sdks/class/message/attachedInfoElem.mdx b/docs/sdks/class/message/attachedInfoElem.mdx index 233c9b8139..ce4075f635 100644 --- a/docs/sdks/class/message/attachedInfoElem.mdx +++ b/docs/sdks/class/message/attachedInfoElem.mdx @@ -14,111 +14,14 @@ toc_max_heading_level: 2 ::: - - ### AttachedInfoElem -| 字段名称 | 字段类型 | 描述 | | ---------------- | ---------------------------------------------------------------- | ---------------------------------- | -| groupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | +| 字段名称 | 字段类型 | 描述 | +| ---------------- | ---------------------------------------------------------------- | ---------------------------------- | | isPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 | | burnDuration | int | 阅后即焚销毁时间 | | hasReadTime | int | 已读时间戳 | +| Progress | [UploadProgress](docs/sdks/class/message/uploadProgress.mdx) | 已读时间戳 | - - - - -### OIMAttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------------------------------------------------------------- | ---------------------------------- | -| groupHasReadInfo | [OIMGroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| isPrivateChat | BOOL | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | NSTimeInterval | 阅后即焚销毁时间 | -| hasReadTime | NSTimeInterval | 已读时间戳 | -| messageEntityList | - | 暂未使用 | - - - - - -### AttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | ---------------------------------------------------------------- | ---------------------------------- | -| groupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| isPrivateChat | boolean | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | int | 阅后即焚销毁时间 | -| hasReadTime | int | 已读时间戳 | - - - - - -### AttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------- | -| groupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| isPrivateChat | boolean | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | number | 阅后即焚销毁时间, 客户端自行计时, 到达时间后调用 api 删除消息 | -| hasReadTime | number | 消息已读时间戳 | -| messageEntityList | - | 暂未使用 | - - - - - -### AttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------- | -| groupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| isPrivateChat | boolean | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | number | 阅后即焚销毁时间, 客户端自行计时, 到达时间后调用 api 删除消息 | -| hasReadTime | number | 消息已读时间戳 | -| messageEntityList | - | 暂未使用 | - - - - - -### AttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------- | -| groupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| isPrivateChat | boolean | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | number | 阅后即焚销毁时间, 客户端自行计时, 到达时间后调用 api 删除消息 | -| hasReadTime | number | 消息已读时间戳 | -| messageEntityList | - | 暂未使用 | - - - - - -### AttachedInfoElem - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | ---------------------------------------------------------------- | ---------------------------------- | -| GroupHasReadInfo | [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群消息已读信息 | -| IsPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 | -| BurnDuration | int | 阅后即焚销毁时间 | -| HasReadTime | int | 已读时间戳 | - - - - diff --git a/docs/sdks/class/message/cardElem.mdx b/docs/sdks/class/message/cardElem.mdx index a534e83eef..eb67f41cbb 100644 --- a/docs/sdks/class/message/cardElem.mdx +++ b/docs/sdks/class/message/cardElem.mdx @@ -14,109 +14,13 @@ toc_max_heading_level: 2 ::: - - - - -### CardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | String | 用户 ID | -| nickname | String | 昵称 | -| faceURL | String | 头像 | -| ex | String | 拓展字段 | - - - - - -### OIMCardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | NSString | 用户 ID | -| nickname | NSString | 昵称 | -| faceURL | NSString | 头像 | -| ex | NSString | 拓展字段 | - - - - - -### CardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | String | 用户 ID | -| nickname | String | 昵称 | -| faceURL | String | 头像 | -| ex | String | 拓展字段 | - - - - - -### CardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 拓展字段 | - - - - - -### CardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 拓展字段 | - - - - ### CardElem | 字段名称 | 字段类型 | 描述 | | -------- | -------- | -------- | | UserID | string | 用户 ID | -| Nickname | String | 昵称 | +| Nickname | string | 昵称 | | FaceURL | string | 头像 | | Ex | string | 拓展字段 | - - - - -### CardElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 拓展字段 | - - - - - diff --git a/docs/sdks/class/message/ConversationArgs.mdx b/docs/sdks/class/message/conversationArgs.mdx similarity index 61% rename from docs/sdks/class/message/ConversationArgs.mdx rename to docs/sdks/class/message/conversationArgs.mdx index ce0db41a1d..e23bf1fe47 100644 --- a/docs/sdks/class/message/ConversationArgs.mdx +++ b/docs/sdks/class/message/conversationArgs.mdx @@ -1,3 +1,4 @@ + --- sidebar_position: 2 toc_min_heading_level: 2 @@ -10,25 +11,15 @@ toc_max_heading_level: 2 :::info -会话参数 +获取一个会话部分消息的请求参数 ::: - - - ### ConversationArgs | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ------------ | | ConversationID| string | 会话 ID | -| ClientMsgIDList | string[] | 消息 ID 列表 | +| ClientMsgIDList | []string | 消息 ID 列表 | - - diff --git a/docs/sdks/class/message/customElem.mdx b/docs/sdks/class/message/customElem.mdx index 6c6cbd3e30..f87b2c2f0d 100644 --- a/docs/sdks/class/message/customElem.mdx +++ b/docs/sdks/class/message/customElem.mdx @@ -14,93 +14,6 @@ toc_max_heading_level: 2 ::: - - - - -### CustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ---- | -| data | String | 自定义 JSON string | -| extension | String | 拓展信息 | -| description | String | 描述信息 | - - - - - -### OIMCustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ---- | -| data | NSString | 自定义 JSON string | -| extension | NSString | 拓展信息 | -| description | NSString | 描述信息 | - - - - - -### CustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ---- | -| data | String | 数据 | -| extension | String | 拓展 | -| description | String | 描述 | - - - - - - -### CustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ------------------ | -| data | string | 自定义 json string | -| extension | string | 拓展信息 | -| description | string | 描述信息 | - - - - - -### CustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ------------------ | -| data | string | 自定义 json string | -| extension | string | 拓展信息 | -| description | string | 描述信息 | - - - - - -### CustomElem - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------- | ------------------ | -| data | string | 自定义 json string | -| extension | string | 拓展信息 | -| description | string | 描述信息 | - - - - ### CustomElem @@ -110,6 +23,3 @@ values={[ | Extension | string | 拓展信息 | | Description | string | 描述信息 | - - - diff --git a/docs/sdks/class/message/faceElem.mdx b/docs/sdks/class/message/faceElem.mdx index a41d77a846..982691f318 100644 --- a/docs/sdks/class/message/faceElem.mdx +++ b/docs/sdks/class/message/faceElem.mdx @@ -14,94 +14,11 @@ toc_max_heading_level: 2 ::: - - - ### FaceElem | 字段名称 | 字段类型 | 描述 | | -------- | -------- | -------------------------------------- | -| index | int | 位置表情，用户端对端自定义内嵌的表情包 | -| data | String | 其他表情，如 URL 表情直接返回 url | - - - - - -### OIMFaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | --------- | -------------------------------------- | -| index | NSInteger | 表情下标，用户端对端自定义内嵌的表情包 | -| data | NSString | 其他表情，如 URL 表情直接返回 url | - - - - - -### FaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------------------------------- | -| index | int | 表情下标，用户端对端自定义内嵌的表情包 | -| data | String | 其他表情，如 URL 表情直接返回 url | - - - - - -### FaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------------------------------- | -| index | number | 表情下标，用户端对端自定义内嵌的表情包 | -| data | string | 其他表情，如 URL 表情直接返回 url | - - - - - -### FaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------------------------------- | -| index | number | 表情下标，用户端对端自定义内嵌的表情包 | -| data | string | 其他表情，如 URL 表情直接返回 url | - - - - - -### FaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------------------------------- | -| Index | int | 位置表情，用户端对端自定义内嵌的表情包 | +| Index | int | 表情下标，用户端对端自定义内嵌的表情包 | | Data | string | 其他表情，如 URL 表情直接返回 url | - - - - -### FaceElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------------------------------- | -| index | number | 表情下标，用户端对端自定义内嵌的表情包 | -| data | string | 其他表情，如 URL 表情直接返回 url | - - - - diff --git a/docs/sdks/class/message/textElem.mdx b/docs/sdks/class/message/textElem.mdx index a5eda8c263..afb04bf09b 100644 --- a/docs/sdks/class/message/textElem.mdx +++ b/docs/sdks/class/message/textElem.mdx @@ -14,84 +14,11 @@ toc_max_heading_level: 2 ::: - - - - -### TextElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | String | 文字消息 | - - - - - -### OIMTextElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | NSString | 文字消息 | - - - - - -### TextElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | String | 文字消息 | - - - - ### TextElem -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | string | 文字消息 | - - - - - -### TextElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | string | 文字消息 | - - - - -### TextElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| content | string | 文字消息 | - - - - -### TextElem - | 字段名称 | 字段类型 | 描述 | | -------- | -------- | -------- | | Content | string | 文字消息 | - - + diff --git a/docs/sdks/class/message/typingElem.mdx b/docs/sdks/class/message/typingElem.mdx index 50acc62e40..e29a49f68f 100644 --- a/docs/sdks/class/message/typingElem.mdx +++ b/docs/sdks/class/message/typingElem.mdx @@ -14,86 +14,10 @@ toc_max_heading_level: 2 ::: - - - - -### TypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| msgTips | String | 提示 | - - - - - -### OIMTypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| msgTips | NSString | 提示 | - - - - - -### TypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| msgTips | String | 提示 | - - - - ### TypingElem | 字段名称 | 字段类型 | 描述 | | -------- | -------- | ---- | -| msgTips | string | 提示 | - - - - - -### TypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| msgTips | string | 提示 | - - - -### TypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| msgTips | string | 提示 | - - - - -### TypingElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| MsgTips | string | 提示 | - - - - +| MsgTips | string | 正在输入的控制信息 | - diff --git a/docs/sdks/class/message/uploadProgress.mdx b/docs/sdks/class/message/uploadProgress.mdx new file mode 100644 index 0000000000..46533d8834 --- /dev/null +++ b/docs/sdks/class/message/uploadProgress.mdx @@ -0,0 +1,24 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# UploadProgress + +## 功能介绍 + +:::info + +媒体消息上传进度信息，仅仅对于图片，视频，音频，文件等媒体消息有效，文本消息不支持。 + +::: + +### UploadProgress + +| 字段名称 | 字段类型 | 描述 | +| ----------- | -------------------------------------------------------- | ---------------------- | +| Total | int | 消息的总字节数 | +| Current | int | 当前已经上传的字节数 | +| UploadID | string | 消息关联的上传id | + diff --git a/docs/sdks/class/message/videoElem.mdx b/docs/sdks/class/message/videoElem.mdx index a3c511eda0..c748b41f16 100644 --- a/docs/sdks/class/message/videoElem.mdx +++ b/docs/sdks/class/message/videoElem.mdx @@ -14,164 +14,23 @@ toc_max_heading_level: 2 ::: - - - ### VideoElem -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------ | -| videoUUID | String | 唯一 ID | -| videoPath | String | 本地资源地址 | -| videoType | String | 资源类型 | -| videoSize | int | 大小 | -| duration | int | 时长 | -| videoUrl | String | 视频远程地址 | -| snapshotUUID | String | 唯一 ID | -| snapshotPath | String | 类型 | -| snapshotSize | int | 大小 | -| snapshotWidth | int | 宽度 | -| snapshotHeight | int | 高度 | -| snapshotUrl | String | 视频缩略图地址 | - - - - - -### OIMVideoElem - -| 字段名称 | 字段类型 | 描述 | -| -------------- | --------- | ------------ | -| videoUUID | NSString | 唯一 ID | -| videoPath | NSString | 本地资源地址 | -| videoType | NSString | 资源类型 | -| videoSize | NSInteger | 大小 | -| duration | NSInteger | 时长 | -| videoUrl | CGFloat | 视频远程地址 | -| snapshotUUID | NSString | 唯一 ID | -| snapshotPath | NSString | 类型 | -| snapshotSize | NSInteger | 大小 | -| snapshotWidth | CGFloat | 宽度 | -| snapshotHeight | CGFloat | 高度 | -| snapshotUrl | CGFloat | 视频缩略图地址 | - - - - - - -### VideoElem - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------ | -| videoUUID | String | 唯一 ID | -| videoPath | String | 本地资源地址 | -| videoType | String | 资源类型 | -| videoSize | int | 大小 | -| duration | int | 时长 | -| videoUrl | String | 图片地址 | -| snapshotUUID | String | 唯一 ID | -| snapshotPath | String | 类型 | -| snapshotSize | int | 大小 | -| snapshotWidth | int | 宽度 | -| snapshotHeight | int | 高度 | -| snapshotUrl | String | 视频缩略图地址 | - - - - - -### VideoElem - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------ | -| videoUUID | string | 唯一 ID | -| videoPath | string | 本地资源地址 | -| videoType | string | 资源类型 | -| videoSize | number | 大小 | -| duration | number | 时长 | -| videoUrl | string | 图片地址 | -| snapshotUUID | string | 唯一 ID | -| snapshotPath | string | 类型 | -| snapshotSize | number | 大小 | -| snapshotWidth | number | 宽度 | -| snapshotHeight | number | 高度 | -| snapshotUrl | string | 视频缩略图地址 | - - - - - -### VideoElem - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------ | -| videoUUID | string | 唯一 ID | -| videoPath | string | 本地资源地址 | -| videoType | string | 资源类型 | -| videoSize | number | 大小 | -| duration | number | 时长 | -| videoUrl | string | 图片地址 | -| snapshotUUID | string | 唯一 ID | -| snapshotPath | string | 类型 | -| snapshotSize | number | 大小 | -| snapshotWidth | number | 宽度 | -| snapshotHeight | number | 高度 | -| snapshotUrl | string | 视频缩略图地址 | - - - - - -### VideoElem - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------ | -| videoUUID | string | 唯一 ID | -| videoPath | string | 本地资源地址 | -| videoType | string | 资源类型 | -| videoSize | number | 大小 | -| duration | number | 时长 | -| videoUrl | string | 图片地址 | -| snapshotUUID | string | 唯一 ID | -| snapshotPath | string | 类型 | -| snapshotSize | number | 大小 | -| snapshotWidth | number | 宽度 | -| snapshotHeight | number | 高度 | -| snapshotUrl | string | 视频缩略图地址 | - - - - - -### VideoBaseInfo - | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ------------ | | VideoUUID | string | 唯一 ID | -| VideoPath | string | 本地资源地址 | -| VideoType | string | 资源类型 | +| VideoPath | string | 视频本地路径 | +| VideoType | string | 视频类型 | | VideoSize | int | 大小 | | Duration | int | 时长 | | VideoUrl | string | 视频远程地址 | -| SnapshotUUID | string | 唯一 ID | -| SnapshotPath | string | 类型 | +| SnapshotUUID | string | 缩略图唯一 ID | +| SnapshotPath | string | 缩略图本地路径 | | SnapshotSize | int | 大小 | | SnapshotWidth | int | 宽度 | | SnapshotHeight | int | 高度 | | SnapshotUrl | string | 视频缩略图地址 | +| SnapshotType | string | 视频类型 | + - - diff --git a/docs/sdks/class/relation/ApplyToAddFriendReq.mdx b/docs/sdks/class/relation/applyToAddFriendReq.mdx similarity index 54% rename from docs/sdks/class/relation/ApplyToAddFriendReq.mdx rename to docs/sdks/class/relation/applyToAddFriendReq.mdx index c60e06c53e..5beb9f8b3a 100644 --- a/docs/sdks/class/relation/ApplyToAddFriendReq.mdx +++ b/docs/sdks/class/relation/applyToAddFriendReq.mdx @@ -10,7 +10,7 @@ toc_max_heading_level: 2 :::info -同意好友请求参数 +添加好友的申请参数 ::: @@ -18,7 +18,7 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ----------------------- | -| fromUserID | string | 当前登录用户 ID | -| toUserID | string | 好友 ID | -| reqMsg| string | 好友的昵称 | -| ex| string | 好友的昵称 | +| FromUserID | string | 当前登录用户 ID | +| ToUserID | string | 好友 ID | +| ReqMsg| string | 申请信息 | +| Ex| string | 扩展信息 | diff --git a/docs/sdks/class/relation/blackInfo.mdx b/docs/sdks/class/relation/blackInfo.mdx index 2e615bfc6b..f9f3dfaeaa 100644 --- a/docs/sdks/class/relation/blackInfo.mdx +++ b/docs/sdks/class/relation/blackInfo.mdx @@ -18,13 +18,12 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ----------------------- | -| ownerUserID | string | 当前登录用户 ID | -| blockUserID | string | 黑名单用户 ID | -| nickname | string | 用户昵称 | -| faceURL | string | 头像 | -| createTime | int | 拉黑时间 | -| addSource | int | 拉黑方式 | -| operatorUserID | string | 使之成为黑名单的用户 ID | -| attachedInfo | string | 暂未使用 | -| ex | string | 扩展字段 | +| OwnerUserID | string | 当前登录用户 ID | +| BlockUserID | string | 黑名单用户 ID | +| Nickname | string | 用户昵称 | +| FaceURL | string | 头像 | +| CreateTime | int | 拉黑时间 （毫秒） | +| AddSource | int | 拉黑方式（保留字段，忽略） | +| OperatorUserID | string | 使之成为黑名单的用户ID可能为管理员 | +| Ex | string | 扩展字段 | diff --git a/docs/sdks/class/relation/friendApplication.mdx b/docs/sdks/class/relation/friendApplication.mdx index 79b98f48e4..26c2988630 100644 --- a/docs/sdks/class/relation/friendApplication.mdx +++ b/docs/sdks/class/relation/friendApplication.mdx @@ -18,17 +18,17 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ------------- | -------- | ----------------------------------- | -| fromUserID | string | 添加者ID | -| fromNickname | string | 添加者昵称 | -| fromFaceURL | string | 添加者头像 | -| toUserID | string | 被添加者ID | -| toNickname | string | 被添加者昵称 | -| toFaceURL | string | 被添加者头像 | -| handleResult | int | 处理结果（1 同意/-1 拒绝/0 未处理） | -| reqMsg | string | 申请添加好友时附带的消息 | -| createTime | int | 创建时间(毫秒) | -| handlerUserID | string | 处理者ID | -| handleMsg | string | 处理好友申请时附带的消息 | -| handleTime | int | 处理时间(毫秒) | -| ex | string | 扩展字段 | -| attachedInfo | string | 暂未使用 | +| FromUserID | string | 添加者ID | +| FromNickname | string | 添加者昵称 | +| FromFaceURL | string | 添加者头像 | +| ToUserID | string | 被添加者ID | +| ToNickname | string | 被添加者昵称 | +| ToFaceURL | string | 被添加者头像 | +| HandleResult | [HandleResult](docs/sdks/enum/handleResult.mdx) | 处理结果 | +| ReqMsg | string | 申请添加好友时附带的消息 | +| CreateTime | int | 创建时间(毫秒) | +| HandlerUserID | string | 处理者ID | +| HandleMsg | string | 处理好友申请时附带的消息 | +| HandleTime | int | 处理时间(毫秒) | +| Ex | string | 扩展字段 | +| AttachedInfo | string | 暂未使用 | diff --git a/docs/sdks/class/relation/friendInfo.mdx b/docs/sdks/class/relation/friendInfo.mdx index 8e98388823..2d463e712d 100644 --- a/docs/sdks/class/relation/friendInfo.mdx +++ b/docs/sdks/class/relation/friendInfo.mdx @@ -18,13 +18,13 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ----------------------- | -| ownerUserID | string | 当前登录用户 ID | -| friendUserID | string | 好友 ID | -| nickname | string | 好友的昵称 | -| faceURL | string | 头像 | -| remark | string | 好友备注 | -| createTime | int | 成为好友时间 | -| addSource | int | 成为好友的方式 （1：管理员导入；2：申请添加） | -| operatorUserID | string | 使双方成为好友的用户 ID | -| attachedInfo | string | 暂未使用 | -| ex | string | 扩展字段 | +| OwnerUserID | string | 当前登录用户 ID | +| FriendUserID | string | 好友 ID | +| Nickname | string | 好友的昵称 | +| FaceURL | string | 头像 | +| Remark | string | 好友备注 | +| CreateTime | int | 成为好友时间 | +| AddSource | [AddSource](docs/sdks/enum/addSource.mdx) | 成为好友的方式 | +| OperatorUserID | string | 使双方成为好友的用户 ID | +| AttachedInfo | string | 暂未使用 | +| Ex | string | 扩展字段 | diff --git a/docs/sdks/class/relation/ProcessFriendApplicationParams.mdx b/docs/sdks/class/relation/processFriendApplicationParams.mdx similarity index 77% rename from docs/sdks/class/relation/ProcessFriendApplicationParams.mdx rename to docs/sdks/class/relation/processFriendApplicationParams.mdx index 91fb841c07..5cfc497d76 100644 --- a/docs/sdks/class/relation/ProcessFriendApplicationParams.mdx +++ b/docs/sdks/class/relation/processFriendApplicationParams.mdx @@ -18,5 +18,5 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ----------------------- | -| toUserID | string | 用户 ID | -| handleMsg | string |信息 | +| ToUserID | string | 用户 ID | +| HandleMsg | string |处理信息 | diff --git a/docs/sdks/class/relation/SearchFriendsParam.mdx b/docs/sdks/class/relation/searchFriendsParam.mdx similarity index 61% rename from docs/sdks/class/relation/SearchFriendsParam.mdx rename to docs/sdks/class/relation/searchFriendsParam.mdx index 6510036097..41a50a2f22 100644 --- a/docs/sdks/class/relation/SearchFriendsParam.mdx +++ b/docs/sdks/class/relation/searchFriendsParam.mdx @@ -18,8 +18,8 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ----------------------- | -| keywordList | string[] | 搜索关键词，目前仅支持一个关键词搜索，不能为空 | -| isSearchUserID| bool |是否以关键词搜索 UserID| -| isSearchNickname| bool |是否以关键词搜索昵称，默认 false | -| isSearchRemark| bool |是否以关键词搜索备注，默认 false | +| KeywordList | string[] | 搜索关键词，目前仅支持一个关键词搜索，不能为空 | +| IsSearchUserID| bool |是否以关键词搜索 UserID| +| IsSearchNickname| bool |是否以关键词搜索昵称，默认 false | +| IsSearchRemark| bool |是否以关键词搜索备注，默认 false | diff --git a/docs/sdks/class/relation/updateFriendsReq.mdx b/docs/sdks/class/relation/updateFriendsReq.mdx index 77077a41f1..f49b429d30 100644 --- a/docs/sdks/class/relation/updateFriendsReq.mdx +++ b/docs/sdks/class/relation/updateFriendsReq.mdx @@ -18,9 +18,9 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| ownerUserID | string | 当前登录用户 ID | -| remark | string | 备注 | -| isPinned | bool | 是否置顶 | -| friendUserIDs | []string | 好友的User ID列表 | -| ex | string | 扩展字段 | +| OwnerUserID | string | 当前登录用户 ID | +| Remark | string | 备注 | +| IsPinned | bool | 是否置顶 | +| FriendUserIDs | []string | 好友的User ID列表 | +| Ex | string | 扩展字段 | diff --git a/docs/sdks/class/relation/UserIdResult.mdx b/docs/sdks/class/relation/userIdResult.mdx similarity index 59% rename from docs/sdks/class/relation/UserIdResult.mdx rename to docs/sdks/class/relation/userIdResult.mdx index ca77be11b9..8a252f89a2 100644 --- a/docs/sdks/class/relation/UserIdResult.mdx +++ b/docs/sdks/class/relation/userIdResult.mdx @@ -9,12 +9,12 @@ toc_max_heading_level: 2 ## 功能介绍 :::info - +检查是否是好友的返回参数 ::: #### UserIDResult | 字段名称 | 字段类型 | 描述 | | -------- | -------- | ---------------------------- | -| userID | string | 用户 userID | -| result | int | 1 表示好友（并且不是黑名单） | +| UserID | string | 用户 userID | +| Result | int | 1 表示好友（并且不是黑名单），0代表非好友 | diff --git a/docs/sdks/class/user/fullUserInfo.mdx b/docs/sdks/class/user/fullUserInfo.mdx deleted file mode 100644 index bd39763f43..0000000000 --- a/docs/sdks/class/user/fullUserInfo.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 2 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# FullUserInfo - -## 功能介绍 - -:::info - -整合了 PublicInfo， FriendInfo 和 BlackInfo - -getuserinfo 时， - 如果是好友，publicInfo 和 friendInfo 会设置， - 如果是黑名单，publicinfo 和 blackInfo 会设置 - 如果既是好友，也是黑名单，则 publicInfo， friendInfo，blackInfo 都会设置 - -getfriend 时 - 如果是黑名单，则 friendInfo 和 blackInfo 会设置， 但 publicInfo 不设置 - -::: - - - - - -### FullUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | ------------------------------------------------------ | ------------------------------------------------------ | -| publicInfo | [PublicInfo](docs/sdks/class/user/publicInfo.mdx) | 用户基本信息| -| friendInfo | [FriendInfo](docs/sdks/class/relation/friendInfo.mdx) | 好友信息 | -| blackInfo | [BlacklistInfo](docs/sdks/class/relation/blackInfo.mdx) | 黑名单信息 | - - - - - -### OIMFullUserInfo - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | ------------------------------------------------------ | ------------------------------------------------------ | -| publicInfo | [OIMPublicInfo](docs/sdks/class/user/publicInfo.mdx) | 用户基本信息| -| friendInfo | [OIMFriendInfo](docs/sdks/class/relation/friendInfo.mdx) | 好友信息 | -| blackInfo | [OIMBlackInfo](docs/sdks/class/relation/blackInfo.mdx) | 黑名单信息 | - - - - - -### 参数详解 - - - - diff --git a/docs/sdks/class/user/index.mdx b/docs/sdks/class/user/index.mdx index 1605a1807f..64c399e9ad 100644 --- a/docs/sdks/class/user/index.mdx +++ b/docs/sdks/class/user/index.mdx @@ -18,5 +18,4 @@ toc_max_heading_level: 2 | ----------------------------------------------------- | ------------------------ | | [UserInfo](docs/sdks/class/user/userInfo.mdx) | 用户信息属性 | | [PublicInfo](docs/sdks/class/user/publicInfo.mdx) | 用户公开信息属性 | -| [FullUserInfo](docs/sdks/class/user/fullUserInfo.mdx) | 多维度用户属性 | | [UserStatusInfo](docs/sdks/class/user/userStatusInfo.mdx) | 用户在线状态属性 | diff --git a/docs/sdks/class/user/publicInfo.mdx b/docs/sdks/class/user/publicInfo.mdx index 89ddd10d18..98054c6d74 100644 --- a/docs/sdks/class/user/publicInfo.mdx +++ b/docs/sdks/class/user/publicInfo.mdx @@ -14,108 +14,12 @@ toc_max_heading_level: 2 ::: - - - - -### PublicUserInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| userID | String | 用户 ID | -| nickname | String | 昵称 | -| faceURL | String | 头像 | -| ex | String | 用户扩展字段 | - - - - - -### OIMPublicInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| userID | NSString | 用户 ID | -| nickname | NSString | 昵称 | -| faceURL | NSString | 头像 | -| ex | NSString | 用户扩展字段 | - - - - - -### PublicUserInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| userID | String | 用户 ID | -| nickname | String | 昵称 | -| faceURL | String | 头像 | -| ex | String | 用户扩展字段 | - - - - - ### PublicUserInfo | 字段名称 | 字段类型 | 描述 | | -------- | -------- | --------------------------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 用户扩展字段 | - - - - - -### PublicUserInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 用户扩展字段 | - - - - - -### PublicUserInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| userID | string | 用户 ID | -| nickname | string | 昵称 | -| faceURL | string | 头像 | -| ex | string | 用户扩展字段 | - - - - - -### PublicUserInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | --------------------------- | -| UserID | string| 用户 ID | -| Nickname | string| 昵称 | -| FaceURL | string| 头像 | -| Ex | string| 用户扩展字段 | -| CreateTime| string| 创建时间| - - - +| UserID | string | 用户 ID | +| Nickname | string | 昵称 | +| FaceURL | string | 头像 | +| Ex | string | 用户扩展字段 | +| CreateTime | int | 创建时间 | diff --git a/docs/sdks/class/user/userInfo.mdx b/docs/sdks/class/user/userInfo.mdx index 88e62f0222..39071d603a 100644 --- a/docs/sdks/class/user/userInfo.mdx +++ b/docs/sdks/class/user/userInfo.mdx @@ -23,8 +23,6 @@ toc_max_heading_level: 2 | FaceURL | string | 用户头像 | | Ex | string | 用户扩展字段 | | CreateTime | int | 用户注册时间（毫秒） | -| AppMangerLevel | int | 内部字段，可忽略 | -| AttachedInfo | string | SDK 内部扩展字段，应用层无需关注 | -| GlobalRecvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 全局消息接收选项 | +| GlobalRecvMsgOpt | [RecvMsgOpt](docs/sdks/enum/recvMsgOpt.mdx) | 全局消息接收选项 | diff --git a/docs/sdks/class/user/userStatusInfo.mdx b/docs/sdks/class/user/userStatusInfo.mdx index 00d8b898ea..1e84ba7039 100644 --- a/docs/sdks/class/user/userStatusInfo.mdx +++ b/docs/sdks/class/user/userStatusInfo.mdx @@ -20,4 +20,4 @@ toc_max_heading_level: 2 | ----------- | -------- | ----------- | | UserID | string | 用户ID | | Status | int | 0 表示该用户所有平台都离线，1 表示在线 | -| PlatformIDs | `[]`[int](/docs/sdks/enum/platform.mdx) | 用户在线的平台ID列表 | +| PlatformIDs | `[]`[IMPlatformID](/docs/sdks/enum/platform.mdx) | 用户在线的平台ID列表 | diff --git a/docs/sdks/enum/addSource.mdx b/docs/sdks/enum/addSource.mdx new file mode 100644 index 0000000000..cb3e87d914 --- /dev/null +++ b/docs/sdks/enum/addSource.mdx @@ -0,0 +1,21 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# AddSource + +:::info + +成为好友的方式 + +::: + +## 好友添加方式 + +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +| BecomeFriendByImport | 1 | 通过管理员导入添加 | +| BecomeFriendByApply | 2 | 申请添加 | + diff --git a/docs/sdks/enum/allowType.mdx b/docs/sdks/enum/allowType.mdx index d1b97c7cc9..9ec0e191b7 100644 --- a/docs/sdks/enum/allowType.mdx +++ b/docs/sdks/enum/allowType.mdx @@ -12,97 +12,10 @@ toc_max_heading_level: 2 ::: -## 群成员权限 +## 群成员查看信息权限 -| 枚举值 | 描述 | -| ------ | ------ | -| 0 | 允许 | -| 1 | 不允许 | +| 枚举值名称 | 枚举值 | 描述 | +| ------| ------ | ------ | +|Allow| 0 | 允许 | +|Prohibit| 1 | 不允许 | - - - - -### OIMAllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| OIMAllowTypeAllowed | 0 | -| OIMAllowTypeNotAllowed | 1 | - - - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| allow | 0 | -| notAllowed | 1 | - - - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Allowed | 0 | -| NotAllowed | 1 | - - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Allowed | 0 | -| NotAllowed | 1 | - - - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Allowed | 0 | -| NotAllowed | 1 | - - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Allowed | 0 | -| NotAllowed | 1 | - - - -### AllowType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Allowed | 0 | -| NotAllowed | 1 | - - - - diff --git a/docs/sdks/enum/conversationType.mdx b/docs/sdks/enum/conversationType.mdx index e0f16bf04c..15cf18dd34 100644 --- a/docs/sdks/enum/conversationType.mdx +++ b/docs/sdks/enum/conversationType.mdx @@ -14,108 +14,9 @@ toc_max_heading_level: 2 ## 会话类型 -| 枚举值 | 描述 | -| ------ | -------- | -| 1 | 单聊会话 | -| 3 | 群聊会话 | -| 4 | 通知会话 | - - - - - -### ConversationType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| single | 1 | -| superGroup | 3 | -| notification | 4 | - - - - - -### OIMConversationType - -| 枚举值名称 | 枚举值 | -| ------------------------------- | ------ | -| OIMConversationTypeC2C | 1 | -| OIMConversationTypeSuperGroup | 3 | -| OIMConversationTypeNotification | 4 | - - - - - -### ConversationType - -| 枚举值名称 | 枚举值 | 描述 | -| ---------------- | ------ | -------- | -| SINGLE_CHAT | 1 | 单聊 | -| SUPER_GROUP_CHAT | 3 | 群聊 | -| NOTIFICATION | 4 | 系统通知 | - - - - - -### SessionType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Single | 1 | -| Group | 3 | -| Notification | 4 | - - - - - -### SessionType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Single | 1 | -| Group | 3 | -| Notification | 4 | - - - - - -### SessionType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Single | 1 | -| Group | 3 | -| Notification | 4 | - - - - - -### SessionType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Single | 1 | -| Group | 3 | -| Notification | 4 | - - - - +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +| SingleChatType | 1 | 单聊会话 | +| ReadGroupChatType | 3 | 群聊会话 | +| NotificationChatType | 4 | 通知会话 | diff --git a/docs/sdks/enum/groupAtType.mdx b/docs/sdks/enum/groupAtType.mdx index db19b0886f..cbaf7ec31e 100644 --- a/docs/sdks/enum/groupAtType.mdx +++ b/docs/sdks/enum/groupAtType.mdx @@ -8,129 +8,19 @@ toc_max_heading_level: 2 :::info -@类型。 + 会话上的@信息或者群公告。 ::: -## @类型选项 {#GroupAtType} +## @类型选项 -| 枚举值 | 描述 | -| ------ | --------- | -| 0 | 无@相关 | -| 1 | @我 | -| 2 | @所有 | -| 3 | @所有且@我 | -| 4 | 群公告 | +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +| AtNormal | 0 | 无@相关 | +| AtMe | 1 | @我 | +| AtAll | 2 | @所有 | +|AtAllAtMe| 3 | @所有且@我 | +|GroupNotification| 4 | 群公告 | - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ----------------- | ------ | -| atNormal | 0 | -| atMe | 1 | -| atAll | 2 | -| atAllAtMe | 3 | -| groupNotification | 4 | - - - - - -### OIMGroupType - -| 枚举值名称 | 枚举值 | -| ------------------------------- | ------ | -| OIMGroupAtTypeAtNormal | 0 | -| OIMGroupAtTypeAtMe | 1 | -| OIMGroupAtTypeAtAll | 2 | -| OIMGroupAtTypeAtAllAtMe | 3 | -| OIMGroupAtTypeGroupNotification | 4 | - - - - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ----------------- | ------ | -| AT_NORMAL | 0 | -| AT_ME | 1 | -| AT_ALL | 2 | -| AT_ALL_AT_ME | 3 | -| GROUP_NOTIFICATION | 4 | - - - - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| AtNormal | 0 | -| AtMe | 1 | -| AtAll | 2 | -| AtAllAtMe | 3 | -| AtGroupNotice | 4 | - - - - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| AtNormal | 0 | -| AtMe | 1 | -| AtAll | 2 | -| AtAllAtMe | 3 | -| AtGroupNotice | 4 | - - - - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| AtNormal | 0 | -| AtMe | 1 | -| AtAll | 2 | -| AtAllAtMe | 3 | -| AtGroupNotice | 4 | - - - - - -### GroupAtType - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| AtNormal | 0 | -| AtMe | 1 | -| AtAll | 2 | -| AtAllAtMe | 3 | -| AtGroupNotice | 4 | - - - - diff --git a/docs/sdks/enum/groupMemberFilter.mdx b/docs/sdks/enum/groupMemberFilter.mdx index 9706420e35..e51e28324a 100644 --- a/docs/sdks/enum/groupMemberFilter.mdx +++ b/docs/sdks/enum/groupMemberFilter.mdx @@ -14,131 +14,13 @@ toc_max_heading_level: 2 ## 筛选成员选项 {#GroupMemberFilter} -| 枚举值 | 描述 | -| ------ | ------------------ | -| 0 | 所有成员 | -| 1 | 群主 | -| 2 | 群管理员 | -| 3 | 群普通成员 | -| 4 | 群管理员和普通成员 | -| 5 | 群主和群管理员 | +| 枚举值名称 | 枚举值 | 描述 | +| ------| ------ | ------------------ | +| GroupFilterAll | 0 | 所有成员 | +| GroupFilterOwner | 1 | 群主 | +| GroupFilterAdmin | 2 |群管理员 | +| GroupFilterOrdinaryUsers | 3 |群普通成员 | +| GroupFilterAdminAndOrdinaryUsers | 4 | 群管理员和普通成员 | +| GroupFilterOwnerAndAdmin | 5 | 群主和群管理员 | +| GroupFilterNotSelf |6 | 除开自己以外的所有成员 | - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| all | 0 | -| owner | 1 | -| admin | 2 | -| member | 3 | -| adminAndNomal | 4 | -| adminAndOwner | 5 | - - - - - -### OIMGroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------------------------------- | ------ | -| OIMGroupMemberFilterAll | 0 | -| OIMGroupMemberFilterOwner | 1 | -| OIMGroupMemberFilterAdmin | 2 | -| OIMGroupMemberFilterMember | 3 | -| OIMGroupMemberFilterAdminAndMember | 4 | -| OIMGroupMemberFilterSuperAndAdmin | 5 | - - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| All | 0 | -| Owner | 1 | -| Admin | 2 | -| Nomal | 3 | -| AdminAndNomal | 4 | -| AdminAndOwner | 5 | - - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| All | 0 | -| Owner | 1 | -| Admin | 2 | -| Nomal | 3 | -| AdminAndNomal | 4 | -| AdminAndOwner | 5 | - - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| All | 0 | -| Owner | 1 | -| Admin | 2 | -| Nomal | 3 | -| AdminAndNomal | 4 | -| AdminAndOwner | 5 | - - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| All | 0 | -| Owner | 1 | -| Admin | 2 | -| Nomal | 3 | -| AdminAndNomal | 4 | -| AdminAndOwner | 5 | - - - - - -### GroupMemberFilter - -| 枚举值名称 | 枚举值 | -| ------------- | ------ | -| All | 0 | -| Owner | 1 | -| Admin | 2 | -| Nomal | 3 | -| AdminAndNomal | 4 | -| AdminAndOwner | 5 | - - - - diff --git a/docs/sdks/enum/groupStatus.mdx b/docs/sdks/enum/groupStatus.mdx index 36bd66a0b0..456360f18c 100644 --- a/docs/sdks/enum/groupStatus.mdx +++ b/docs/sdks/enum/groupStatus.mdx @@ -14,115 +14,10 @@ toc_max_heading_level: 2 ## 群状态选项 {#GroupStatus} -| 枚举值 | 描述 | -| ------ | ---------------- | -| 0 | 正常 | -| 1 | 封禁（暂未使用） | -| 2 | 解散 | -| 3 | 禁言 | +| 枚举值名称 | 枚举值 | 描述 | +| ------| ------ | ---------------- | +|GroupOk| 0 | 正常 | +|GroupBanChat| 1 | 封禁（暂未使用） | +|GroupStatusDismissed| 2 | 解散 | +|GroupStatusMuted| 3 | 禁言 | - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| nomal | 0 | -| baned | 1 | -| dismissed | 2 | -| muted | 3 | - - - - - -### OIMGroupStatus - -| 枚举值名称 | 枚举值 | -| ----------------------- | ------ | -| OIMGroupStatusOk | 0 | -| OIMGroupStatusBanChat | 1 | -| OIMGroupStatusDismissed | 2 | -| OIMGroupStatusMuted | 3 | - - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| -------------- | ------ | -| GROUP_OK | 0 | -| GROUP_BANNED | 1 | -| GROUP_DISSOLVE | 2 | -| GROUP_MUTED | 3 | - - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Nomal | 0 | -| Baned | 1 | -| Dismissed | 2 | -| Muted | 3 | - - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Nomal | 0 | -| Baned | 1 | -| Dismissed | 2 | -| Muted | 3 | - - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Nomal | 0 | -| Baned | 1 | -| Dismissed | 2 | -| Muted | 3 | - - - - - -### GroupStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Nomal | 0 | -| Baned | 1 | -| Dismissed | 2 | -| Muted | 3 | - - - - diff --git a/docs/sdks/enum/groupType.mdx b/docs/sdks/enum/groupType.mdx index 16e0b4ba96..72ab669689 100644 --- a/docs/sdks/enum/groupType.mdx +++ b/docs/sdks/enum/groupType.mdx @@ -8,97 +8,13 @@ toc_max_heading_level: 2 :::info -群类型。 +群类型（目前固定位写扩散群）。 ::: ## 群类型选项 {#GroupType} -| 枚举值 | 描述 | -| ------ | -------------------- | -| 2 | 固定为2（支持大群） | +| 枚举值名称 | 枚举值 | 描述 | +| ------| ------ | -------------------- | +|WorkingGroup| 2 | 固定为2（支持大群） | - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| work | 2 | - - - - - -### OIMGroupType - -| 枚举值名称 | 枚举值 | -| ------------------- | ------ | -| OIMGroupTypeWorking | 2 | - - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| WORK | 2 | - - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Group | 2 | - - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Group | 2 | - - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Group | 2 | - - - - - -### GroupType - -| 枚举值名称 | 枚举值 | -| ------------ | ------ | -| Group | 2 | - - - - diff --git a/docs/sdks/enum/groupVerification.mdx b/docs/sdks/enum/groupVerification.mdx index d8a5a99e58..e822e5303e 100644 --- a/docs/sdks/enum/groupVerification.mdx +++ b/docs/sdks/enum/groupVerification.mdx @@ -14,106 +14,9 @@ toc_max_heading_level: 2 ## 进群验证选项 {#GroupVerification} -| 枚举值 | 描述 | -| ------ | ------------------------------------ | -| 0 | 申请进群需要群主或管理员同意；群成员邀请可以直接进群 | -| 1 | 申请进群需要群主或管理员同意；群主和管理员邀请可以直接进群；普通成员邀请进群需群主或管理员同意 | -| 2 | 直接进群 | +| 枚举值名称 | 枚举值 | 描述 | +|------ | ------ | ------------------------------------ | +|ApplyNeedVerificationInviteDirectly| 0 | 申请进群需要群主或管理员同意；群成员邀请可以直接进群 | +|AllNeedVerification| 1 | 申请进群需要群主或管理员同意；群主和管理员邀请可以直接进群；普通成员邀请进群需群主或管理员同意 | +|Directly| 2 | 直接进群 | - - - - -### GroupVerification - -| 枚举值名称 | 枚举值 | -| ----------------------------------- | ------ | -| applyNeedVerificationInviteDirectly | 0 | -| allNeedVerification | 1 | -| directly | 2 | - - - - - -### OIMGroupVerificationType - -| 枚举值名称 | 枚举值 | -| ----------------------------------------------------------- | ------ | -| OIMGroupVerificationTypeApplyNeedVerificationInviteDirectly | 0 | -| OIMGroupVerificationTypeAllNeedVerification | 1 | -| OIMGroupVerificationTypeDirectly | 2 | - - - - - -### GroupVerification - -| 枚举值名称 | 枚举值 | -| ----------------------------------- | ------ | -| APPLY_NEED_VERIFICATION_INVITE_DIRECTLY | 0 | -| ALL_NEED_VERIFICATION | 1 | -| DIRECTLY | 2 | - - - - - -### GroupVerificationType - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| ApplyNeedInviteNot | 0 | -| AllNeed | 1 | -| AllNot | 2 | - - - - - -### GroupVerificationType - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| ApplyNeedInviteNot | 0 | -| AllNeed | 1 | -| AllNot | 2 | - - - - - -### GroupVerificationType - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| ApplyNeedInviteNot | 0 | -| AllNeed | 1 | -| AllNot | 2 | - - - - - -### GroupVerificationType - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| ApplyNeedInviteNot | 0 | -| AllNeed | 1 | -| AllNot | 2 | - - - diff --git a/docs/sdks/enum/handleResult.mdx b/docs/sdks/enum/handleResult.mdx index 6c3e5bb1b6..c004a885fe 100644 --- a/docs/sdks/enum/handleResult.mdx +++ b/docs/sdks/enum/handleResult.mdx @@ -8,113 +8,15 @@ toc_max_heading_level: 2 :::info -申请处理状态。 +群申请或好友申请处理状态。 ::: -## 群权限选项 {#HandleResult} +## 群申请或好友申请处理状态 {#HandleResult} -| 枚举值 | 描述 | -| ------ | -------- | -| -1 | 已拒绝 | -| 0 | 等待处理 | -| 1 | 已同意 | +| 枚举值名称 | 枚举值 | 描述 | +|------ | ------ | ------------------------------------ | +|ResponseRefuse| -1 | 已拒绝 | +|ResponseDefault| 0 | 等待处理 | +|ResponseAgree| 1 | 已同意 | - - - - -### ApplicationStatus - -| 枚举值名称 | 枚举值 | -| --------------------------- | ------ | -| decline | -1 | -| normal | 0 | -| accept | 1 | - - - - - -### OIMApplicationStatus - -| 枚举值名称 | 枚举值 | -| --------------------------- | ------ | -| OIMApplicationStatusDecline | -1 | -| OIMApplicationStatusNormal | 0 | -| OIMApplicationStatusAccept | 1 | - - - - - -### ApplyHandleResult - -| 枚举值名称 | 枚举值 | -| ----------- | ------ | -| Unprocessed | -1 | -| Agree | 0 | -| Reject | 1 | - - - - - -### ApplicationHandleResult - -| 枚举值名称 | 枚举值 | -| ----------- | ------ | -| Unprocessed | -1 | -| Agree | 0 | -| Reject | 1 | - - - - - -### ApplicationHandleResult - -| 枚举值名称 | 枚举值 | -| ----------- | ------ | -| Unprocessed | -1 | -| Agree | 0 | -| Reject | 1 | - - - - - -### ApplicationHandleResult - -| 枚举值名称 | 枚举值 | -| ----------- | ------ | -| Unprocessed | -1 | -| Agree | 0 | -| Reject | 1 | - - - - - -### ApplicationHandleResult - -| 枚举值名称 | 枚举值 | -| ----------- | ------ | -| Unprocessed | -1 | -| Agree | 0 | -| Reject | 1 | - - - - diff --git a/docs/sdks/enum/joinSource.mdx b/docs/sdks/enum/joinSource.mdx index d8b7fd965f..ad7931d806 100644 --- a/docs/sdks/enum/joinSource.mdx +++ b/docs/sdks/enum/joinSource.mdx @@ -14,111 +14,10 @@ toc_max_heading_level: 2 ## 进群方式选项 {#JoinSource} -| 枚举值 | 描述 | -| ------ | ---------- | -| 2 | 通过邀请进群 | -| 3 | 通过搜索进群 | -| 4 | 通过二维码扫描进群 | +| 枚举值名称 | 枚举值 | 描述 | +|------ | ------ | ------------------------------------ | +|JoinByAdmin| 1 | 通过管理员操作进群 | +|JoinByInvitation| 2 | 通过邀请进群 | +|JoinBySearch| 3 | 通过搜索进群 | +|JoinByQRCode| 4 | 通过二维码扫描进群 | - - - - -### JoinSource - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| invited | 2 | -| search | 3 | -| QRCode | 4 | - - - - -### JoinSource - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Invitation | 2 | -| Search | 3 | -| QrCode | 4 | - - - - - -### OIMJoinType - -| 枚举值名称 | 枚举值 | -| ------------------ | ------ | -| OIMJoinTypeInvited | 2 | -| OIMJoinTypeSearch | 3 | -| OIMJoinTypeQRCode | 4 | - - - - - -### 枚举详解 - - - - - -### GroupJoinSource - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Invitation | 2 | -| Search | 3 | -| QrCode | 4 | - - - - - -### GroupJoinSource - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Invitation | 2 | -| Search | 3 | -| QrCode | 4 | - - - - - -### GroupJoinSource - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Invitation | 2 | -| Search | 3 | -| QrCode | 4 | - - - - - -### GroupJoinSource - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Invitation | 2 | -| Search | 3 | -| QrCode | 4 | - - - diff --git a/docs/sdks/enum/logLevel.mdx b/docs/sdks/enum/logLevel.mdx index 00f371e2ff..b8e7513483 100644 --- a/docs/sdks/enum/logLevel.mdx +++ b/docs/sdks/enum/logLevel.mdx @@ -10,9 +10,10 @@ | 枚举值名称 | 枚举值 | 描述 | | ---------- | ------ | --------------------- | +| WithSQL | 6 | 打印 数据库sql 级别的日志 | | Debug | 5 | 打印 Debug 级别的日志 | | Info | 4 | 打印 Info 级别的日志 | | Warn | 3 | 打印 Warn 级别的日志 | | Error | 2 | 打印 Error 级别的日志 | -| Fatal | 1 | 打印 Fatal 级别的日志 | -| Panic | 0 | 打印 Panic 级别的日志 | +| Panic | 1 | 打印 Panic 级别的日志 | +| Fatal | 0 | 打印 Fatal 级别的日志 | diff --git a/docs/sdks/enum/messageContentType.mdx b/docs/sdks/enum/messageContentType.mdx index bed1965f43..9acba4c4e6 100644 --- a/docs/sdks/enum/messageContentType.mdx +++ b/docs/sdks/enum/messageContentType.mdx @@ -14,389 +14,37 @@ toc_max_heading_level: 2 ## 消息类型 {#MessageContentType} -| 枚举值 | 描述 | -| ------ | ------------------ | -| 101 | 文本消息 | -| 102 | 图片消息 | -| 103 | 语音消息 | -| 104 | 视频消息 | -| 105 | 文件消息 | -| 106 | @消息 | -| 107 | 合并消息 | -| 108 | 名片消息 | -| 109 | 位置消息 | -| 110 | 自定义消息 | -| 113 | 输入状态 | -| 114 | 引用消息 | -| 115 | 表情消息 | -| 1201 | 双方成为好友通知 | -| 1400 | 系统通知 | -| 1501 | 群创建通知 | -| 1502 | 群信息改变通知 | -| 1504 | 群成员退出通知 | -| 1507 | 群主更换通知 | -| 1508 | 群成员被踢通知 | -| 1509 | 邀请群成员通知 | -| 1510 | 群成员进群通知 | -| 1511 | 解散群通知 | -| 1512 | 群成员禁言通知 | -| 1513 | 取消群成员禁言通知 | -| 1514 | 群禁言通知 | -| 1515 | 取消群禁言通知 | -| 1519 | 群公告改变通知 | -| 1520 | 群名称改变通知 | -| 1701 | 阅后即焚开启或关闭通知 | -| 2101 | 撤回消息通知 | +| 枚举值名称 | 枚举值 | 描述 | +| ---------- | ------------- | --------------------- | +|Text| 101 | 文本消息 | +|Picture| 102 | 图片消息 | +|Sound| 103 | 语音消息 | +|Video| 104 | 视频消息 | +|File| 105 | 文件消息 | +|AtText| 106 | @消息 | +|Merger| 107 | 合并消息 | +|Card| 108 | 名片消息 | +|Location| 109 | 位置消息 | +|Custom| 110 | 自定义消息 | +|Typing| 113 | 输入状态 | +|Quote| 114 | 引用消息 | +|Face| 115 | 表情消息 | +|FriendApplicationApprovedNotification| 1201 | 双方成为好友通知 | +|OANotification| 1400 | 系统通知 | +|GroupCreatedNotification| 1501 | 群创建通知 | +|GroupInfoSetNotification| 1502 | 群信息改变通知 | +|MemberQuitNotification| 1504 | 群成员退出通知 | +|GroupOwnerTransferredNotification| 1507 | 群主更换通知 | +|MemberKickedNotification| 1508 | 群成员被踢通知 | +|MemberInvitedNotification| 1509 | 邀请群成员通知 | +|MemberEnterNotification| 1510 | 群成员进群通知 | +|GroupDismissedNotification| 1511 | 解散群通知 | +|GroupMemberMutedNotification| 1512 | 群成员禁言通知 | +|GroupMemberCancelMutedNotification| 1513 | 取消群成员禁言通知 | +|GroupMutedNotification| 1514 | 群禁言通知 | +|GroupCancelMutedNotification| 1515 | 取消群禁言通知 | +|GroupInfoSetAnnouncementNotification| 1519 | 群公告改变通知 | +|GroupInfoSetNameNotification| 1520 | 群名称改变通知 | +|ConversationPrivateChatNotification| 1701 | 阅后即焚开启或关闭通知 | +|RevokeNotification| 2101 | 撤回消息通知 | - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| text | 101 | -| picture | 102 | -| voice | 103 | -| video | 104 | -| file | 105 | -| atText | 106 | -| merger | 107 | -| card | 108 | -| location | 109 | -| custom | 110 | -| typing | 113 | -| quote | 114 | -| customFace | 115 | -| advancedText | 117 | -| customMsgNotTriggerConversation | 119 | -| customMsgOnlineOnly | 120 | -| friendApplicationApprovedNotification | 1201 | -| friendApplicationRejectedNotification | 1202 | -| friendApplicationNotification | 1203 | -| friendAddedNotification | 1204 | -| friendDeletedNotification | 1205 | -| friendRemarkSetNotification | 1206 | -| blackAddedNotification | 1207 | -| blackDeletedNotification | 1208 | -| conversationChangeNotification | 1300 | -| userInfoUpdatedNotification | 1303 | -| oaNotification | 1400 | -| groupCreatedNotification | 1501 | -| groupInfoSetNotification | 1502 | -| joinGroupApplicationNotification | 1503 | -| memberQuitNotification | 1504 | -| groupApplicationAcceptedNotification | 1505 | -| groupApplicationRejectedNotification | 1506 | -| groupOwnerTransferredNotification | 1507 | -| memberKickedNotification | 1508 | -| memberInvitedNotification | 1509 | -| memberEnterNotification | 1510 | -| dismissGroupNotification | 1511 | -| groupMemberMutedNotification | 1512 | -| groupMemberCancelMutedNotification | 1513 | -| groupMutedNotification | 1514 | -| groupCancelMutedNotification | 1515 | -| groupMemberInfoChangedNotification | 1516 | -| groupMemberSetToAdminNotification | 1517 | -| groupMemberSetToOrdinaryUserNotification | 1518 | -| groupInfoSetAnnouncementNotification | 1519 | -| groupInfoSetNameNotification | 1520 | -| burnAfterReadingNotification | 1701 | -| businessNotification | 2001 | -| revokeMessageNotification | 2101 | -| signalHasReadReceiptNotification | 2150 | -| groupHasReadReceiptNotification | 2155 | - - - - - -### OIMMessageContentType - -| 枚举值名称 | 枚举值 | -| ------------------------------------------------------------- | ------ | -| OIMMessageContentTypeText | 101 | -| OIMMessageContentTypeImage | 102 | -| OIMMessageContentTypeAudio | 103 | -| OIMMessageContentTypeVideo | 104 | -| OIMMessageContentTypeFile | 105 | -| OIMMessageContentTypeAt | 106 | -| OIMMessageContentTypeMerge | 107 | -| OIMMessageContentTypeCard | 108 | -| OIMMessageContentTypeLocation | 109 | -| OIMMessageContentTypeCustom | 110 | -| OIMMessageContentTypeRevokeReciept | 111 | -| OIMMessageContentTypeC2CReciept | 112 | -| OIMMessageContentTypeTyping | 113 | -| OIMMessageContentTypeQuote | 114 | -| OIMMessageContentTypeFace | 115 | -| OIMMessageContentTypeAdvancedText | 117 | -| OIMMessageContentTypeAdvancedRevoke | 118 | -| OIMMessageContentTypeCustomMsgNotTriggerConversation | 119 | -| OIMMessageContentTypeCustomMsgOnlineOnly | 120 | -| OIMMessageContentTypeFriendAppApproved | 1201 | -| OIMMessageContentTypeFriendAppRejected | 1202 | -| OIMMessageContentTypeFriendApplication | 1203 | -| OIMMessageContentTypeFriendAdded | 1204 | -| OIMMessageContentTypeFriendDeleted | 1205 | -| OIMMessageContentTypeFriendRemarkSet | 1206 | -| OIMMessageContentTypeBlackAdded | 1207 | -| OIMMessageContentTypeBlackDeleted | 1208 | -| OIMMessageContentTypeConversationOptChange | 1300 | -| OIMMessageContentTypeUserInfoUpdated | 1303 | -| OIMMessageContentTypeOANotification | 1400 | -| OIMMessageContentTypeGroupCreated | 1501 | -| OIMMessageContentTypeGroupInfoSet | 1502 | -| OIMMessageContentTypeJoinGroupApplication | 1503 | -| OIMMessageContentTypeMemberQuit | 1504 | -| OIMMessageContentTypeGroupAppAccepted | 1505 | -| OIMMessageContentTypeGroupAppRejected | 1506 | -| OIMMessageContentTypeGroupOwnerTransferred | 1507 | -| OIMMessageContentTypeMemberKicked | 1508 | -| OIMMessageContentTypeMemberInvited | 1509 | -| OIMMessageContentTypeMemberEnter | 1510 | -| OIMMessageContentTypeDismissGroup | 1511 | -| OIMMessageContentTypeGroupMemberMutedNotification | 1512 | -| OIMMessageContentTypeGroupMemberCancelMutedNotification | 1513 | -| OIMMessageContentTypeGroupMutedNotification | 1514 | -| OIMMessageContentTypeGroupCancelMutedNotification | 1515 | -| OIMMessageContentTypeGroupMemberInfoSetNotification | 1516 | -| OIMMessageContentTypeGroupMemberSetToAdminNotification | 1517 | -| OIMMessageContentTypeGroupMemberSetToOrdinaryUserNotification | 1518 | -| OIMMessageContentTypeSuperGroupUpdateNotification | 1651 | -| OIMMessageContentTypeIsPrivateMessage | 1701 | -| OIMMessageContentTypeBusiness | 2001 | -| OIMMessageContentTypeRevoke | 2101 | -| OIMMessageContentTypeHasReadReceipt | 2150 | -| OIMMessageContentTypeGroupHasReadReceipt | 2155 | - - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| text | 101 | -| picture | 102 | -| voice | 103 | -| video | 104 | -| file | 105 | -| atText | 106 | -| merger | 107 | -| card | 108 | -| location | 109 | -| custom | 110 | -| typing | 113 | -| quote | 114 | -| customFace | 115 | -| advancedText | 117 | -| customMsgNotTriggerConversation | 119 | -| customMsgOnlineOnly | 120 | -| friendApplicationApprovedNotification | 1201 | -| friendApplicationRejectedNotification | 1202 | -| friendApplicationNotification | 1203 | -| friendAddedNotification | 1204 | -| friendDeletedNotification | 1205 | -| friendRemarkSetNotification | 1206 | -| blackAddedNotification | 1207 | -| blackDeletedNotification | 1208 | -| conversationChangeNotification | 1300 | -| userInfoUpdatedNotification | 1303 | -| oaNotification | 1400 | -| groupCreatedNotification | 1501 | -| groupInfoSetNotification | 1502 | -| joinGroupApplicationNotification | 1503 | -| memberQuitNotification | 1504 | -| groupApplicationAcceptedNotification | 1505 | -| groupApplicationRejectedNotification | 1506 | -| groupOwnerTransferredNotification | 1507 | -| memberKickedNotification | 1508 | -| memberInvitedNotification | 1509 | -| memberEnterNotification | 1510 | -| dismissGroupNotification | 1511 | -| groupMemberMutedNotification | 1512 | -| groupMemberCancelMutedNotification | 1513 | -| groupMutedNotification | 1514 | -| groupCancelMutedNotification | 1515 | -| groupMemberInfoChangedNotification | 1516 | -| groupMemberSetToAdminNotification | 1517 | -| groupMemberSetToOrdinaryUserNotification | 1518 | -| groupNoticeChangedNotification | 1519 | -| groupNameChangedNotification | 1520 | -| burnAfterReadingNotification | 1701 | -| businessNotification | 2001 | -| revokeMessageNotification | 2101 | -| signalHasReadReceiptNotification | 2150 | -| groupHasReadReceiptNotification | 2155 | - - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| TextMessage | 101 | -| PictureMessage | 102 | -| VoiceMessage | 103 | -| VideoMessage | 104 | -| FileMessage | 105 | -| AtTextMessage | 106 | -| MergeMessage | 107 | -| CardMessage | 108 | -| LocationMessage | 109 | -| CustomMessage | 110 | -| TypingMessage | 113 | -| QuoteMessage | 114 | -| FaceMessage | 115 | -| FriendAdded | 1201 | -| OANotification | 1400 | -| GroupCreated | 1501 | -| MemberQuit | 1504 | -| GroupOwnerTransferred | 1507 | -| MemberKicked | 1508 | -| MemberInvited | 1509 | -| MemberEnter | 1510 | -| GroupDismissed | 1511 | -| GroupMemberMuted | 1512 | -| GroupMemberCancelMuted | 1513 | -| GroupMuted | 1514 | -| GroupCancelMuted | 1515 | -| GroupAnnouncementUpdated | 1519 | -| GroupNameUpdated | 1518 | -| BurnMessageChange | 1701 | -| RevokeMessage | 2101 | - - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| TextMessage | 101 | -| PictureMessage | 102 | -| VoiceMessage | 103 | -| VideoMessage | 104 | -| FileMessage | 105 | -| AtTextMessage | 106 | -| MergeMessage | 107 | -| CardMessage | 108 | -| LocationMessage | 109 | -| CustomMessage | 110 | -| TypingMessage | 113 | -| QuoteMessage | 114 | -| FaceMessage | 115 | -| FriendAdded | 1201 | -| OANotification | 1400 | -| GroupCreated | 1501 | -| MemberQuit | 1504 | -| GroupOwnerTransferred | 1507 | -| MemberKicked | 1508 | -| MemberInvited | 1509 | -| MemberEnter | 1510 | -| GroupDismissed | 1511 | -| GroupMemberMuted | 1512 | -| GroupMemberCancelMuted | 1513 | -| GroupMuted | 1514 | -| GroupCancelMuted | 1515 | -| GroupAnnouncementUpdated | 1519 | -| GroupNameUpdated | 1518 | -| BurnMessageChange | 1701 | -| RevokeMessage | 2101 | - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| TextMessage | 101 | -| PictureMessage | 102 | -| VoiceMessage | 103 | -| VideoMessage | 104 | -| FileMessage | 105 | -| AtTextMessage | 106 | -| MergeMessage | 107 | -| CardMessage | 108 | -| LocationMessage | 109 | -| CustomMessage | 110 | -| TypingMessage | 113 | -| QuoteMessage | 114 | -| FaceMessage | 115 | -| FriendAdded | 1201 | -| OANotification | 1400 | -| GroupCreated | 1501 | -| MemberQuit | 1504 | -| GroupOwnerTransferred | 1507 | -| MemberKicked | 1508 | -| MemberInvited | 1509 | -| MemberEnter | 1510 | -| GroupDismissed | 1511 | -| GroupMemberMuted | 1512 | -| GroupMemberCancelMuted | 1513 | -| GroupMuted | 1514 | -| GroupCancelMuted | 1515 | -| GroupAnnouncementUpdated | 1519 | -| GroupNameUpdated | 1518 | -| BurnMessageChange | 1701 | -| RevokeMessage | 2101 | - - - - -### MessageType - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| TextMessage | 101 | -| PictureMessage | 102 | -| VoiceMessage | 103 | -| VideoMessage | 104 | -| FileMessage | 105 | -| AtTextMessage | 106 | -| MergeMessage | 107 | -| CardMessage | 108 | -| LocationMessage | 109 | -| CustomMessage | 110 | -| TypingMessage | 113 | -| QuoteMessage | 114 | -| FaceMessage | 115 | -| FriendAdded | 1201 | -| OANotification | 1400 | -| GroupCreated | 1501 | -| MemberQuit | 1504 | -| GroupOwnerTransferred | 1507 | -| MemberKicked | 1508 | -| MemberInvited | 1509 | -| MemberEnter | 1510 | -| GroupDismissed | 1511 | -| GroupMemberMuted | 1512 | -| GroupMemberCancelMuted | 1513 | -| GroupMuted | 1514 | -| GroupCancelMuted | 1515 | -| GroupAnnouncementUpdated | 1519 | -| GroupNameUpdated | 1518 | -| BurnMessageChange | 1701 | -| RevokeMessage | 2101 | - - - diff --git a/docs/sdks/enum/messageStatus.mdx b/docs/sdks/enum/messageStatus.mdx index e9dca10865..b05b726835 100644 --- a/docs/sdks/enum/messageStatus.mdx +++ b/docs/sdks/enum/messageStatus.mdx @@ -14,108 +14,10 @@ toc_max_heading_level: 2 ## 消息状态 -| 枚举值 | 描述 | -| ------ | ---------------------- | -| 1 | 发送中 | -| 2 | 发送成功 | -| 3 | 发送失败 | +| 枚举值名称 | 枚举值 | 描述 | +| ---------- | ------------- | --------------------- | +|MsgStatusSending| 1 | 发送中 | +|MsgStatusSendSuccess| 2 | 发送成功 | +|MsgStatusSendFailed| 3 | 发送失败 | - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| --------------------------- | ------ | -| sending | 1 | -| sendSuccess | 2 | -| sendFailure | 3 | - - - - - -### OIMConversationType - -| 枚举值名称 | 枚举值 | -| --------------------------- | ------ | -| OIMMessageStatusSending | 1 | -| OIMMessageStatusSendSuccess | 2 | -| OIMMessageStatusSendFailure | 3 | - - - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| SENDING | 1 | -| SUCCEEDED | 2 | -| FAILED | 3 | - - - - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Sending | 1 | -| Succeed | 2 | -| Failed | 3 | - - - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Sending | 1 | -| Succeed | 2 | -| Failed | 3 | - - - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Sending | 1 | -| Succeed | 2 | -| Failed | 3 | - - - - - -### MessageStatus - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Sending | 1 | -| Succeed | 2 | -| Failed | 3 | - - - - diff --git a/docs/sdks/enum/platform.mdx b/docs/sdks/enum/platform.mdx index 092b3c124a..5ce1dc973f 100644 --- a/docs/sdks/enum/platform.mdx +++ b/docs/sdks/enum/platform.mdx @@ -12,14 +12,16 @@ toc_max_heading_level: 2 ::: -| 枚举值名称 | 枚举值 | 描述 | -| ----------- | ------ | ---------- | -| ios | 1 | iOS | -| android | 2 | Android | -| windows | 3 | Windows | -| osx | 4 | OSX | -| web | 5 | WEB | -| mini_web | 6 | 小程序 | -| linux | 7 | Linux | -| android_pad | 8 | AndroidPad | -| ipad | 9 | iPad | +## 终端类型 + +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +| iOS | 1 | iOS | +| Android | 2 | Android | +| Windows | 3 | Windows | +| macOS | 4 | macOS | +| Web | 5 | Web | +| MiniWeb | 6 | 小程序| +| Linux | 7 | Linux | +| AndroidPad | 8 | AndroidPad | +| iPad | 9 | iPad| diff --git a/docs/sdks/enum/recvMsgOpt.mdx b/docs/sdks/enum/recvMsgOpt.mdx index 9cba83edb7..979e7283c1 100644 --- a/docs/sdks/enum/recvMsgOpt.mdx +++ b/docs/sdks/enum/recvMsgOpt.mdx @@ -18,6 +18,6 @@ toc_max_heading_level: 2 | 枚举值名称 | 枚举值 | 描述 | | ------ | -------------------------------------------------------- |------------------| | ReceiveMessage | 0 | 正常接受消息 | -| NotReceiveMessage | 0 | 保留字段可忽略 | +| NotReceiveMessage | 1 | 保留字段可忽略 | | ReceiveNotNotifyMessage | 2 | 接收消息，但无离线推送。在会话上时，该会话不计入总未读数 | diff --git a/docs/sdks/enum/roleLevel.mdx b/docs/sdks/enum/roleLevel.mdx index 7c11354cb0..03708fe379 100644 --- a/docs/sdks/enum/roleLevel.mdx +++ b/docs/sdks/enum/roleLevel.mdx @@ -12,109 +12,11 @@ toc_max_heading_level: 2 ::: -## 群权限选项 {#RoleLevel} +## 群成员角色等级 {#RoleLevel} -| 枚举值 | 描述 | -| ------ | -------- | -| 100 | 群主 | -| 60 | 群管理员 | -| 20 | 群普通成员 | +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +|GroupOwner| 100 | 群主 | +|GroupAdmin| 60 | 群管理员 | +|GroupOrdinaryUsers| 20 | 群普通成员 | - - - -### GroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| owner | 100 | -| admin | 60 | -| member | 20 | - - - - - -### OIMGroupMemberRole - -| 枚举值名称 | 枚举值 | -| ------------------------ | ------ | -| OIMGroupMemberRoleOwner | 100 | -| OIMGroupMemberRoleAdmin | 60 | -| OIMGroupMemberRoleMember | 20 | - - - - - -### 枚举详解 - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| OWNER | 100 | -| ADMIN | 60 | -| MEMBER | 20 | - - - - - - -### GroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Owner | 100 | -| Admin | 60 | -| Nomal | 20 | - - - - - -### GroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Owner | 100 | -| Admin | 60 | -| Nomal | 20 | - - - - - -### GroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Owner | 100 | -| Admin | 60 | -| Nomal | 20 | - - - - - -### GroupMemberRole - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| Owner | 100 | -| Admin | 60 | -| Nomal | 20 | - - - - diff --git a/docs/sdks/enum/viewType.mdx b/docs/sdks/enum/viewType.mdx index f46565a46a..14dc93bb51 100644 --- a/docs/sdks/enum/viewType.mdx +++ b/docs/sdks/enum/viewType.mdx @@ -14,96 +14,8 @@ toc_max_heading_level: 2 ## 当前操作类型 -| 枚举值 | 描述 | -| ------ | ----------- | -| 0 | 拉取历史消息 | -| 1 | 搜索历史消息 | +| 枚举值名称 | 枚举值 | 描述 | +| ------ | -------------------------------------------------------- |------------------| +|ViewHistory| 0 | 拉取历史消息 | +|ViewSearch| 1 | 搜索历史消息 | - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| ---------- | ------ | -| History | 0 | -| Search | 1 | - - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - -### ViewType - -| 枚举值名称 | 枚举值 | -| --------- | ------ | -| History | 0 | -| Search | 1 | - - - - diff --git a/docs/sdks/listener/advancedMsgListener.mdx b/docs/sdks/listener/advancedMsgListener.mdx index 7e8211f566..ecddfe1153 100644 --- a/docs/sdks/listener/advancedMsgListener.mdx +++ b/docs/sdks/listener/advancedMsgListener.mdx @@ -17,7 +17,7 @@ toc_max_heading_level: 2 | 模块名称 | 模块功能简介 | | ------------------------------------------------------------------------- | ---------------- | | [onRecvNewMessage](docs/sdks/callback/onRecvNewMessage.mdx) | 收到新消息 | +| [onRecvOnlineOnlyMessage](docs/sdks/callback/onRecvOnlineOnlyMessage.mdx) | 收到仅仅在线才接口的消息 | | [onRecvOfflineNewMessage](docs/sdks/callback/onRecvOfflineNewMessage.mdx) | 收到离线消息 | | [onRecvC2CReadReceipt](docs/sdks/callback/onRecvC2CReadReceipt.mdx) | 单聊消息已读回执 | -| [onRecvGroupReadReceipt](docs/sdks/callback/onRecvGroupReadReceipt.mdx) | 群聊消息已读回执 | | [onNewRecvMessageRevoked](docs/sdks/callback/onNewRecvMessageRevoked.mdx) | 撤回消息回调 | diff --git a/docs/sdks/listener/connectListener.mdx b/docs/sdks/listener/connectListener.mdx index 97d3f493d3..20d3db52bf 100644 --- a/docs/sdks/listener/connectListener.mdx +++ b/docs/sdks/listener/connectListener.mdx @@ -19,3 +19,4 @@ SDK 连接状态监听器，当连接状态变化时回调。 | [onConnecting](docs/sdks/callback/onConnecting.mdx) | SDK 正在连接服务器 | | [onKickedOffline](docs/sdks/callback/onKickedOffline.mdx) | 账号已在其他地方登录，当前设备被踢下线 | | [onUserTokenExpired](docs/sdks/callback/onUserTokenExpired.mdx) | 登录凭证过期，需要重新登录 | +| [onUserTokenInvalid](docs/sdks/callback/onUserTokenInvalid.mdx) | 登录凭证无效，需要重新登录 | diff --git a/docs/sdks/listener/conversationListener.mdx b/docs/sdks/listener/conversationListener.mdx index ef2b2deba7..984eba9db2 100644 --- a/docs/sdks/listener/conversationListener.mdx +++ b/docs/sdks/listener/conversationListener.mdx @@ -16,10 +16,11 @@ toc_max_heading_level: 2 | 模块名称 | 模块功能简介 | | ------------------------------------------------------------------------------------------- | -------------------------- | -| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器会话开始 | -| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器会话完成 | -| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器会话失败 | +| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器数据开始 | +| [onSyncServerProgress](docs/sdks/callback/onSyncServerProgress.mdx) | 同步服务器数据进度 | +| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器数据完成 | +| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器数据失败 | | [onNewConversation](docs/sdks/callback/onNewConversation.mdx) | 有新的会话 | | [onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) | 某些会话的关键信息发生变化 | | [onTotalUnreadMessageCountChanged](docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx) | 会话未读总数变更通知 | -| [onInputStatusChanged](docs/sdks/callback/onInputStatusChanged.mdx) | 输入状态改变通知 | +| [onConversationUserInputStatusChanged](docs/sdks/callback/onInputStatusChanged.mdx) | 输入状态改变通知 | diff --git a/docs/sdks/listener/groupListener.mdx b/docs/sdks/listener/groupListener.mdx index 6d4d4fb6cb..0b8082ffeb 100644 --- a/docs/sdks/listener/groupListener.mdx +++ b/docs/sdks/listener/groupListener.mdx @@ -19,8 +19,8 @@ toc_max_heading_level: 2 | [onGroupMemberAdded](docs/sdks/callback/onGroupMemberAdded.mdx) | 有新成员加入群 | | [onGroupMemberDeleted](docs/sdks/callback/onGroupMemberDeleted.mdx) | 有成员离开群 | | [onGroupMemberInfoChanged](docs/sdks/callback/onGroupMemberInfoChanged.mdx) | 某成员信息发生变更 | -| [onJoinedGroupAdded](docs/sdks/callback/onJoinedGroupAdded.mdx) | 群成员变更 | -| [onJoinedGroupDeleted](docs/sdks/callback/onJoinedGroupDeleted.mdx) | 群成员变更 | +| [onJoinedGroupAdded](docs/sdks/callback/onJoinedGroupAdded.mdx) | 新加入的群通知 | +| [onJoinedGroupDeleted](docs/sdks/callback/onJoinedGroupDeleted.mdx) | 加入的群减少的通知 | | [onGroupInfoChanged](docs/sdks/callback/onGroupInfoChanged.mdx) | 群信息变更 | | [onGroupApplicationAccepted](docs/sdks/callback/onGroupApplicationAccepted.mdx) | 群申请被接受通知 | | [onGroupApplicationAdded](docs/sdks/callback/onGroupApplicationAdded.mdx) | 新的群申请通知 | diff --git a/docs/sdks/listener/userListener.mdx b/docs/sdks/listener/userListener.mdx index cabed05aa9..8a70d0d9cf 100644 --- a/docs/sdks/listener/userListener.mdx +++ b/docs/sdks/listener/userListener.mdx @@ -16,5 +16,5 @@ toc_max_heading_level: 2 | 模块名称 | 模块功能简介 | | ------------------------------------------------------------------- | -------------------------- | -| [onSelfUserInfoUpdate](docs/sdks/callback/onSelfUserInfoUpdate.mdx) | 个人信息变更通知 | +| [onSelfInfoUpdated](docs/sdks/callback/onSelfInfoUpdated.mdx) | 个人信息变更通知 | | [onUserStatusChanged](docs/sdks/callback/onUserStatusChanged.mdx) | 已订阅用户在线状态变更通知 |