Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
wechaty
wechaty
提交
9801232b
W
wechaty
项目概览
wechaty
/
wechaty
上一次同步 大约 3 年
通知
304
Star
10499
Fork
6
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
152
列表
看板
标记
里程碑
合并请求
1
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
W
wechaty
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
152
Issue
152
列表
看板
标记
里程碑
合并请求
1
合并请求
1
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
9801232b
编写于
7月 29, 2018
作者:
Huan (李卓桓)
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
remove useless func docs
上级
04aeed98
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
1 addition
and
68 deletion
+1
-68
docs/index.md
docs/index.md
+1
-68
未找到文件。
docs/index.md
浏览文件 @
9801232b
# Wechaty v0.19.11
4
Documentation
# Wechaty v0.19.11
5
Documentation
*
<https://blog.chatie.io>
...
...
@@ -410,7 +410,6 @@ All wechat rooms(groups) will be encapsulated as a Room.
*
[
.memberAll(query)
](
#Room+memberAll
)
⇒
<code>
Promise.
<
Array.
<
Contact
>>
</code>
*
[
.member(queryArg)
](
#Room+member
)
⇒
<code>
Promise.
<
(null\|Contact)
>
</code>
*
[
.memberList()
](
#Room+memberList
)
⇒
<code>
Promise.
<
Array.
<
Contact
>>
</code>
*
[
.sync()
](
#Room+sync
)
⇒
<code>
Promise.
<
void
>
</code>
*
[
.owner()
](
#Room+owner
)
⇒
[
<code>Contact</code>
](
#Contact
)
\|
<code>
null
</code>
*
_static_
*
[
.create(contactList, [topic])
](
#Room.create
)
⇒
[
<code>Promise.<Room></code>
](
#Room
)
...
...
@@ -793,16 +792,6 @@ Get all room member from the room
```
js
await
room
.
memberList
()
```
<a
name=
"Room+sync"
></a>
### room.sync() ⇒ <code>Promise.<void></code>
Force reload data for Room, Sync data for Room
**Kind**
: instance method of
[
<code>Room</code>
](
#Room
)
**Example**
```
js
await
room
.
sync
()
```
<a
name=
"Room+owner"
></a>
### room.owner() ⇒ [<code>Contact</code>](#Contact) \| <code>null</code>
...
...
@@ -919,17 +908,12 @@ All wechat contacts(friend) will be encapsulated as a Contact.
*
[
.say(textOrContactOrFile)
](
#Contact+say
)
⇒
<code>
Promise.
<
void
>
</code>
*
[
.name()
](
#Contact+name
)
⇒
<code>
string
</code>
*
[
.alias(newAlias)
](
#Contact+alias
)
⇒
<code>
Promise.
<
(null\|string\|void)
>
</code>
*
~~
[
.stranger()
](
#Contact+stranger
)
~~
*
[
.friend()
](
#Contact+friend
)
⇒
<code>
boolean
</code>
\|
<code>
null
</code>
*
~~
[
.official()
](
#Contact+official
)
~~
*
~~
[
.personal()
](
#Contact+personal
)
~~
*
[
.type()
](
#Contact+type
)
⇒
<code>
ContactType.Unknown
</code>
\|
<code>
ContactType.Personal
</code>
\|
<code>
ContactType.Official
</code>
*
[
.gender()
](
#Contact+gender
)
⇒
<code>
ContactGender.Unknown
</code>
\|
<code>
ContactGender.Male
</code>
\|
<code>
ContactGender.Female
</code>
*
[
.province()
](
#Contact+province
)
⇒
<code>
string
</code>
\|
<code>
null
</code>
*
[
.city()
](
#Contact+city
)
⇒
<code>
string
</code>
\|
<code>
null
</code>
*
[
.avatar()
](
#Contact+avatar
)
⇒
<code>
Promise.
<
FileBox
>
</code>
*
~~
[
.refresh()
](
#Contact+refresh
)
~~
*
[
.sync()
](
#Contact+sync
)
⇒
<code>
Promise.
<
this
>
</code>
*
[
.self()
](
#Contact+self
)
⇒
<code>
boolean
</code>
*
_static_
*
[
.load(id)
](
#Contact.load
)
⇒
[
<code>Contact</code>
](
#Contact
)
...
...
@@ -1022,14 +1006,6 @@ try {
console.log(`failed to delete ${contact.name()}
'
s
alias
!
`)
}
```
<a
name=
"Contact+stranger"
></a>
### ~~contact.stranger()~~
***Deprecated**
*
Should use
[
friend
](
#Contact+friend
)
instead
**Kind**
: instance method of
[
<code>Contact</code>
](
#Contact
)
<a
name=
"Contact+friend"
></a>
### contact.friend() ⇒ <code>boolean</code> \| <code>null</code>
...
...
@@ -1045,22 +1021,6 @@ False for not friend of the bot, null for unknown.
```
js
const
isFriend
=
contact
.
friend
()
```
<a
name=
"Contact+official"
></a>
### ~~contact.official()~~
***Deprecated**
*
Check if it's a offical account, should use
[
type
](
#Contact+type
)
instead
**Kind**
: instance method of
[
<code>Contact</code>
](
#Contact
)
<a
name=
"Contact+personal"
></a>
### ~~contact.personal()~~
***Deprecated**
*
Check if it's a personal account, should use
[
type
](
#Contact+type
)
instead
**Kind**
: instance method of
[
<code>Contact</code>
](
#Contact
)
<a
name=
"Contact+type"
></a>
### contact.type() ⇒ <code>ContactType.Unknown</code> \| <code>ContactType.Personal</code> \| <code>ContactType.Official</code>
...
...
@@ -1120,24 +1080,6 @@ const name = file.name
await
file
.
toFile
(
name
,
true
)
console
.
log
(
`Contact:
${
contact
.
name
()}
with avatar file:
${
name
}
`
)
```
<a
name=
"Contact+refresh"
></a>
### ~~contact.refresh()~~
***Deprecated**
*
Force reload(re-ready()) data for Contact, use
[
sync
](
#Contact+sync
)
instead
**Kind**
: instance method of
[
<code>Contact</code>
](
#Contact
)
<a
name=
"Contact+sync"
></a>
### contact.sync() ⇒ <code>Promise.<this></code>
Force reload(re-ready()) data for Contact,
**Kind**
: instance method of
[
<code>Contact</code>
](
#Contact
)
**Example**
```
js
await
contact
.
sync
()
```
<a
name=
"Contact+self"
></a>
### contact.self() ⇒ <code>boolean</code>
...
...
@@ -1442,7 +1384,6 @@ All wechat messages will be encapsulated as a Message.
*
[
.type()
](
#Message+type
)
⇒
<code>
MessageType
</code>
*
[
.self()
](
#Message+self
)
⇒
<code>
boolean
</code>
*
[
.mention()
](
#Message+mention
)
⇒
<code>
Promise.
<
Array.
<
Contact
>>
</code>
*
~~
[
.mentioned()
](
#Message+mentioned
)
~~
*
[
.forward(to)
](
#Message+forward
)
⇒
<code>
Promise.
<
void
>
</code>
*
[
.age()
](
#Message+age
)
⇒
<code>
number
</code>
*
~~
[
.file()
](
#Message+file
)
~~
...
...
@@ -1639,14 +1580,6 @@ Message event table as follows
const
contactList
=
await
message
.
mention
()
console
.
log
(
contactList
)
```
<a
name=
"Message+mentioned"
></a>
### ~~message.mentioned()~~
***Deprecated**
*
should use
[
mention
](
#Message+mention
)
instead
**Kind**
: instance method of
[
<code>Message</code>
](
#Message
)
<a
name=
"Message+forward"
></a>
### message.forward(to) ⇒ <code>Promise.<void></code>
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录