Skip to content

Commit 28735cc

Browse files
BloominggBloomingg
committed
refactor: prue jssdk quickstart and api docs
1 parent 449fbec commit 28735cc

File tree

286 files changed

+648
-671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

286 files changed

+648
-671
lines changed

‎docs/sdks/api/conversation/changeInputStates.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,8 @@ const IMSDK = getSDK();
181181
// const { instance: IMSDK } = getWithRenderProcess();
182182

183183
// use in mini program
184-
// import { OpenIMSDK } from 'open-im-sdk';
185-
// const IMSDK = new OpenIMSDK();
184+
// import { getSDK } from '@openim/client-sdk';
185+
// const IMSDK = getSDK();
186186

187187
IMSDK.changeInputStates({
188188
conversationID: 'conversationID',

‎docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ const IMSDK = getSDK();
170170
// const { instance: IMSDK } = getWithRenderProcess();
171171

172172
// use in mini program
173-
// import { OpenIMSDK } from 'open-im-sdk';
174-
// const IMSDK = new OpenIMSDK();
173+
// import { getSDK } from '@openim/client-sdk';
174+
// const IMSDK = getSDK();
175175

176176
IMSDK.clearConversationAndDeleteAllMsg('conversationID')
177177
.then(({ data }) => {

‎docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ const IMSDK = getSDK();
164164
// const { instance: IMSDK } = getWithRenderProcess();
165165

166166
// use in mini program
167-
// import { OpenIMSDK } from 'open-im-sdk';
168-
// const IMSDK = new OpenIMSDK();
167+
// import { getSDK } from '@openim/client-sdk';
168+
// const IMSDK = getSDK();
169169

170170
IMSDK.deleteConversationAndDeleteAllMsg('conversationID')
171171
.then(({ data }) => {

‎docs/sdks/api/conversation/getAllConversationList.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ const IMSDK = getSDK();
161161
// const { instance: IMSDK } = getWithRenderProcess();
162162

163163
// use in mini program
164-
// import { OpenIMSDK } from 'open-im-sdk';
165-
// const IMSDK = new OpenIMSDK();
164+
// import { getSDK } from '@openim/client-sdk';
165+
// const IMSDK = getSDK();
166166

167167
IMSDK.getAllConversationList()
168168
.then(({ data }) => {

‎docs/sdks/api/conversation/getConversationIDBySessionType.mdx‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ values={[
2121
{ label: 'Android', value: 'Android', },
2222
{ label: 'Flutter', value: 'Flutter', },
2323
{ label: 'uni-app', value: 'uni-app', },
24-
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
24+
{ label: 'Browser/Electron', value: 'Web', },
2525
{ label: 'React-Native', value: 'React-Native', },
2626
{ label: 'Unity', value: 'Unity', },
2727
]
@@ -162,10 +162,6 @@ const IMSDK = getSDK();
162162
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
163163
// const { instance: IMSDK } = getWithRenderProcess();
164164

165-
// use in mini program
166-
// import { OpenIMSDK } from 'open-im-sdk';
167-
// const IMSDK = new OpenIMSDK();
168-
169165
IMSDK.getConversationIDBySessionType({
170166
sourceID: 'user1',
171167
sessionType: 1,

‎docs/sdks/api/conversation/getConversationListSplit.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,8 @@ const IMSDK = getSDK();
177177
// const { instance: IMSDK } = getWithRenderProcess();
178178

179179
// use in mini program
180-
// import { OpenIMSDK } from 'open-im-sdk';
181-
// const IMSDK = new OpenIMSDK();
180+
// import { getSDK } from '@openim/client-sdk';
181+
// const IMSDK = getSDK();
182182

183183
IMSDK.getConversationListSplit({
184184
offset: 0,

‎docs/sdks/api/conversation/getInputStates.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,8 @@ const IMSDK = getSDK();
177177
// const { instance: IMSDK } = getWithRenderProcess();
178178

179179
// use in mini program
180-
// import { OpenIMSDK } from 'open-im-sdk';
181-
// const IMSDK = new OpenIMSDK();
180+
// import { getSDK } from '@openim/client-sdk';
181+
// const IMSDK = getSDK();
182182

183183
IMSDK.getInputstates({
184184
conversationID: 'conversationID',

‎docs/sdks/api/conversation/getMultipleConversation.mdx‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ values={[
2121
{ label: 'Android', value: 'Android', },
2222
{ label: 'Flutter', value: 'Flutter', },
2323
{ label: 'uni-app', value: 'uni-app', },
24-
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
24+
{ label: 'Browser/Electron', value: 'Web', },
2525
{ label: 'React-Native', value: 'React-Native', },
2626
{ label: 'Unity', value: 'Unity', },
2727
]
@@ -163,10 +163,6 @@ const IMSDK = getSDK();
163163
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
164164
// const { instance: IMSDK } = getWithRenderProcess();
165165

166-
// use in mini program
167-
// import { OpenIMSDK } from 'open-im-sdk';
168-
// const IMSDK = new OpenIMSDK();
169-
170166
IMSDK.getMultipleConversation(['conversationID'])
171167
.then(({ data }) => {
172168
// 调用成功

‎docs/sdks/api/conversation/getOneConversation.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,8 @@ const IMSDK = getSDK();
174174
// const { instance: IMSDK } = getWithRenderProcess();
175175

176176
// use in mini program
177-
// import { OpenIMSDK } from 'open-im-sdk';
178-
// const IMSDK = new OpenIMSDK();
177+
// import { getSDK } from '@openim/client-sdk';
178+
// const IMSDK = getSDK();
179179

180180
IMSDK.getOneConversation({
181181
sourceID: 'user1',

‎docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ const IMSDK = getSDK();
154154
// const { instance: IMSDK } = getWithRenderProcess();
155155

156156
// use in mini program
157-
// import { OpenIMSDK } from 'open-im-sdk';
158-
// const IMSDK = new OpenIMSDK();
157+
// import { getSDK } from '@openim/client-sdk';
158+
// const IMSDK = getSDK();
159159

160160
IMSDK.getTotalUnreadMsgCount()
161161
.then(({ data }) => {

0 commit comments

Comments
 (0)