add API docs Chinese version #1530
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,104 @@ | ||||||
| --- | ||||||
| title: ContactSelf | ||||||
| --- | ||||||
|
|
||||||
| 机器人自己的信息将会封装一个ContactSelf 类。这个类继承自 Contact。 | ||||||
|
|
||||||
| ## ContactSelf | ||||||
|
|
||||||
| > 备注：这个类继承自 Contact | ||||||
|
|
||||||
| **Kind**: global class | ||||||
|
|
||||||
| * [ContactSelf](/zh/docs/api/contact-self.md#contactself) | ||||||
| * [intance](/zh/docs/api/contact-self.md#contactself) | ||||||
|
There was a problem hiding this comment. There's a typo in the word "instance" (written as "intance"). Correcting this typo will improve the documentation's accuracy. - * [intance](/zh/docs/api/contact-self.md#contactself)
+ * [instance](/zh/docs/api/contact-self.md#contactself)Committable suggestion
Suggested change
|
||||||
| * [contactSelf.avatar\(\[file\]\) ⇒ `Promise <void | FileBox>`](/zh/docs/api/contact-self.md#contactselfavatarfile-⇒-promise) | ||||||
| * [contactSelf.qrcode\(\) ⇒ `Promise <string>`](/zh/docs/api/contact-self.md#contactselfqrcode-⇒-promise) | ||||||
| * [contactSelf.signature\(signature\) ⇒ `Promise <string>`](/zh/docs/api/contact-self.md#contactselfsignaturesignature) | ||||||
| * [contactSelf.name\(\[name\]\) ⇒ `Promise <void> | string`](/zh/docs/api/contact-self.md#contactselfname-⇒-promisestring) | ||||||
|
|
||||||
| ### contactSelf.avatar\(\[file\]\) ⇒ `Promise <void | FileBox>` | ||||||
|
|
||||||
| 设置机器人的头像 | ||||||
|
|
||||||
| **Kind**: [`ContactSelf`](/zh/docs/api/contact-self.md#ContactSelf)的实例方法 | ||||||
|
|
||||||
| | Param | Type | | ||||||
| | :--- | :--- | | ||||||
| | \[file\] | `FileBox` | | ||||||
|
|
||||||
| **示例** _\( GET the avatar for bot, return {Promise<FileBox>}\)_ | ||||||
|
|
||||||
| ```javascript | ||||||
| bot.on('login', async user => { | ||||||
| console.log(`user ${user} login`) | ||||||
| const file = await user.avatar() | ||||||
| const name = file.name | ||||||
| await file.toFile(name, true) | ||||||
| console.log(`Save bot avatar: ${user.name()} with avatar file: ${name}`) | ||||||
| }) | ||||||
|
|
||||||
| ### contactSelf.qrcode\(\) ⇒ `Promise <string>` | ||||||
|
|
||||||
| 获取机器人的二维码。 | ||||||
|
|
||||||
| **Kind**: [`ContactSelf`](/zh/docs/api/contact-self.md#ContactSelf)的实例方法 | ||||||
|
|
||||||
| #### 示例 | ||||||
|
|
||||||
| ```javascript | ||||||
| import { generate } from 'qrcode-terminal' | ||||||
| bot.on('login', async user => { | ||||||
| console.log(`user ${user} login`) | ||||||
| const qrcode = await user.qrcode() | ||||||
| console.log(`Following is the bot qrcode!`) | ||||||
| generate(qrcode, { small: true }) | ||||||
| }) | ||||||
| ``` | ||||||
|
|
||||||
| ### contactSelf.signature\(signature\) ⇒ `Promise <void>` | ||||||
|
|
||||||
| 修改机器人签名。 | ||||||
|
|
||||||
| **Kind**: [`ContactSelf`](/zh/docs/api/contact-self.md#ContactSelf)的实例方法 | ||||||
|
|
||||||
| | Param | Description | | ||||||
| | :--- | :--- | | ||||||
| | signature | 机器人要修改的签名内容 | | ||||||
|
|
||||||
| #### 示例 | ||||||
|
|
||||||
| ```javascript | ||||||
| bot.on('login', async user => { | ||||||
| console.log(`user ${user} login`) | ||||||
| try { | ||||||
| await user.signature(`Signature changed by wechaty on ${new Date()}`) | ||||||
| } catch (e) { | ||||||
| console.error('change signature failed', e) | ||||||
| } | ||||||
| }) | ||||||
| ``` | ||||||
|
|
||||||
| ### contactSelf.name\(\[name\]\) ⇒ `Promise<void> | string` | ||||||
|
|
||||||
| 修改机器人昵称。 | ||||||
|
|
||||||
| **Kind**: [`ContactSelf`](/zh/docs/api/contact-self.md#contactself)的实例方法 | ||||||
|
|
||||||
| | Param | Description | | ||||||
| | :--- | :--- | | ||||||
| | \[name\] | 机器人要修改的昵称内容 | | ||||||
|
|
||||||
| #### 示例 | ||||||
|
|
||||||
| ```javascript | ||||||
| bot.on('login', async user => { | ||||||
| console.log(`user ${user} login`) | ||||||
| const oldName = user.name() // get bot name | ||||||
| try { | ||||||
| await user.name(`${oldName}-${new Date().getTime()}`) // change bot name | ||||||
| } catch (e) { | ||||||
| console.error('change name failed', e) | ||||||
| } | ||||||
| }) | ||||||
| ``` | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updates to the links for
ContactSelfand its methods to include the full path/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/api/are a significant improvement for navigation within the documentation. This ensures that users are directed to the correct version of the documentation based on their language preference.However, there's a typo in the word "instance" on line 16, which is currently spelled as "intance". Correcting this typo will improve the readability and professionalism of the documentation.
Committable suggestion