Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
.www.
wechaty
提交
794db5cf
W
wechaty
项目概览
.www.
/
wechaty
与 Fork 源项目一致
Fork自
wechaty / wechaty
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
W
wechaty
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
794db5cf
编写于
7月 23, 2018
作者:
Huan (李卓桓)
浏览文件
操作
浏览文件
下载
差异文件
Merge branch 'master' of github.com:Chatie/wechaty
上级
812a8dba
79df8098
变更
3
显示空白变更内容
内联
并排
Showing
3 changed file
with
54 addition
and
2 deletion
+54
-2
scripts/generate-docs.sh
scripts/generate-docs.sh
+1
-1
src/user/contact-self.ts
src/user/contact-self.ts
+52
-0
src/user/contact.ts
src/user/contact.ts
+1
-1
未找到文件。
scripts/generate-docs.sh
浏览文件 @
794db5cf
...
...
@@ -10,5 +10,5 @@ else
echo
"Generating docs ..."
npm run dist
echo
-e
'# Wechaty v'
$(
jq
-r
.version package.json
)
' Documentation\n\n* <https://blog.chatie.io>\n\n'
>
docs/index.md
jsdoc2md dist/src/wechaty.js dist/src/user/
{
room,contact,friendship,message
}
.js
>>
docs/index.md
jsdoc2md dist/src/wechaty.js dist/src/user/
{
room,contact,
contact-self,
friendship,message
}
.js
>>
docs/index.md
fi
src/user/contact-self.ts
浏览文件 @
794db5cf
...
...
@@ -27,6 +27,17 @@ import {
Contact
,
}
from
'
./contact
'
/**
* Bot itself will be encapsulated as a ContactSelf.
*
* > Tips: this class is extends Contact
* @example
* const bot = new Wechaty()
* await bot.start()
* bot.on('login', (user: ContactSelf) => {
* console.log(`user ${user} login`)
* })
*/
export
class
ContactSelf
extends
Contact
{
constructor
(
id
:
string
,
...
...
@@ -37,6 +48,33 @@ export class ContactSelf extends Contact {
public
async
avatar
()
:
Promise
<
FileBox
>
public
async
avatar
(
file
:
FileBox
)
:
Promise
<
void
>
/**
* GET / SET bot avatar
*
* @param {FileBox} [file]
* @returns {(Promise<void | FileBox>)}
*
* @example <caption> GET the avatar for bot, return {Promise<FileBox>}</caption>
* // Save avatar to local file like `1-name.jpg`
*
* bot.on('login', (user: ContactSelf) => {
* console.log(`user ${user} login`)
* const file = await user.avatar()
* const name = file.name
* await file.toFile(name, true)
* console.log(`Save bot avatar: ${contact.name()} with avatar file: ${name}`)
* })
*
* @example <caption>SET the avatar for a bot</caption>
* import { FileBox } from 'file-box'
* bot.on('login', (user: ContactSelf) => {
* console.log(`user ${user} login`)
* const fileBox = FileBox.fromUrl('https://chatie.io/wechaty/images/bot-qr-code.png')
* await user.avatar(fileBox)
* console.log(`Change bot avatar successfully!`)
* })
*
*/
public
async
avatar
(
file
?:
FileBox
):
Promise
<
void
|
FileBox
>
{
log
.
verbose
(
'
Contact
'
,
'
avatar(%s)
'
,
file
?
file
.
name
:
''
)
...
...
@@ -52,6 +90,20 @@ export class ContactSelf extends Contact {
await
this
.
puppet
.
contactAvatar
(
this
.
id
,
file
)
}
/**
* Get bot qrcode
*
* @returns {Promise<string>}
*
* @example
* import { generate } from 'qrcode-terminal'
* bot.on('login', (user: ContactSelf) => {
* console.log(`user ${user} login`)
* const qrcode = await user.qrcode()
* console.log(`Following is the bot qrcode!`)
* generate(qrcode, { small: true })
* })
*/
public
async
qrcode
():
Promise
<
string
>
{
log
.
verbose
(
'
Contact
'
,
'
qrcode()
'
)
...
...
src/user/contact.ts
浏览文件 @
794db5cf
...
...
@@ -341,7 +341,7 @@ export class Contact extends Accessory implements Sayable {
*
* import { FileBox } from 'file-box'
* const fileBox1 = FileBox.fromUrl('https://chatie.io/wechaty/images/bot-qr-code.png')
* const fileBox2 = FileBox.from
Local
('/tmp/text.txt')
* const fileBox2 = FileBox.from
File
('/tmp/text.txt')
* await contact.say(fileBox1)
* await contact.say(fileBox2)
*
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录