Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
.www.
wechaty
提交
6c38cddd
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,发现更多精彩内容 >>
提交
6c38cddd
编写于
11月 13, 2016
作者:
ruiruibupt
提交者:
GitHub
11月 13, 2016
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update README.md
Format adjusting
上级
6bf91223
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
70 addition
and
73 deletion
+70
-73
README.md
README.md
+70
-73
未找到文件。
README.md
浏览文件 @
6c38cddd
...
...
@@ -109,168 +109,165 @@ Get to know more about NPM at [Wiki](https://github.com/wechaty/wechaty/wiki/NPM
1.
[
error
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-error
)
Emit when there's an error occurred.
Emit when there's an error occurred.
1
.
[
friend
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-friend
)
2
.
[
friend
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-friend
)
Emit when got a new friend request, or friendship is confirmed.
Emit when got a new friend request, or friendship is confirmed.
1
.
[
login
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-login
)
3
.
[
login
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-login
)
Emit when bot login full successful.
Emit when bot login full successful.
1
.
[
logout
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-logout
)
4
.
[
logout
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-logout
)
Emit when bot detected log out.
Emit when bot detected log out.
1
.
[
message
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-message
)
5
.
[
message
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-message
)
Emit when there's a new message.
Emit when there's a new message.
1
.
[
room-join
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-join
)
6
.
[
room-join
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-join
)
Emit when someone join the room
Emit when someone join the room
1
.
[
room-leave
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-leave
)
7
.
[
room-leave
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-leave
)
Emit when someone leave the room
Emit when someone leave the room
1
.
[
room-topic
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-topic
)
8
.
[
room-topic
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-topic
)
Emit when someone change the room's topic
Emit when someone change the room's topic
1
.
[
scan
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-scan
)
9
.
[
scan
](
https://github.com/wechaty/wechaty/wiki/API#wechaty-event-scan
)
Emit when the bot needs to show you a QR Code for scanning
Emit when the bot needs to show you a QR Code for scanning
## [Contact](https://github.com/wechaty/wechaty/wiki/API#class-contact)
1.
[
id:string
](
https://github.com/wechaty/wechaty/wiki/API#contactid-string
)
get uniq id from a contact
get uniq id from a contact
1
.
[
name():string
](
https://github.com/wechaty/wechaty/wiki/API#contactname-string
)
2
.
[
name():string
](
https://github.com/wechaty/wechaty/wiki/API#contactname-string
)
get name from a contact
get name from a contact
1
.
[
remark():string
](
https://github.com/wechaty/wechaty/wiki/API#contactremark-string
)
3
.
[
remark():string
](
https://github.com/wechaty/wechaty/wiki/API#contactremark-string
)
get remark name from a contact
get remark name from a contact
1
.
[
remark(remark:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactremarkremark-string-promise
)
4
.
[
remark(remark:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactremarkremark-string-promise
)
set remark name to a contact
set remark name to a contact
1
.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactready-promise
)
5
.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactready-promise
)
confirm get all the contact data needed, will be resolved when all data is ready
confirm get all the contact data needed, will be resolved when all data is ready
1
.
[
say(content:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactsaycontent-string-promise
)
6
.
[
say(content:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#contactsaycontent-string-promise
)
say content to a contact
say content to a contact
## [FriendRequest](https://github.com/wechaty/wechaty/wiki/API#class-friendrequest)
1.
[
hello:string
](
https://github.com/wechaty/wechaty/wiki/API#friendrequesthello-string
)
get content from friendrequest
get content from friendrequest
1
.
[
accept():void
](
https://github.com/wechaty/wechaty/wiki/API#friendrequestaccept-void
)
2
.
[
accept():void
](
https://github.com/wechaty/wechaty/wiki/API#friendrequestaccept-void
)
accept a friendrequest
accept a friendrequest
1
.
[
send(contact:Contact,hello:string):void
](
https://github.com/wechaty/wechaty/wiki/API#friendrequestsendcontact-contact-hello-string-void
)
3
.
[
send(contact:Contact,hello:string):void
](
https://github.com/wechaty/wechaty/wiki/API#friendrequestsendcontact-contact-hello-string-void
)
send a new friend request
send a new friend request
## [Message](https://github.com/wechaty/wechaty/wiki/API#class-message)
1.
[
from():Contact
](
https://github.com/wechaty/wechaty/wiki/API#1-messagefrom-contact
)
get the sender from a message
get the sender from a message
1
.
[
from(contact:Contact):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messagefromcontact-contact-void
)
2
.
[
from(contact:Contact):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messagefromcontact-contact-void
)
set a sender to the message
set a sender to the message
1
.
[
from(contactId:string):void
](
https://github.com/wechaty/wechaty/wiki/API#3-messagefromcontactid-string-void
)
3
.
[
from(contactId:string):void
](
https://github.com/wechaty/wechaty/wiki/API#3-messagefromcontactid-string-void
)
set a sender to the message by contact id
set a sender to the message by contact id
1
.
[
to():Contact
](
https://github.com/wechaty/wechaty/wiki/API#1-messageto-contactroom
)
4
.
[
to():Contact
](
https://github.com/wechaty/wechaty/wiki/API#1-messageto-contactroom
)
get the destination of the message
get the destination of the message
1
.
[
to(contact:Contact):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messagetocontact-contact-void
)
5
.
[
to(contact:Contact):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messagetocontact-contact-void
)
set the destination as contact for the message
set the destination as contact for the message
1
.
[
to(contact:string):void
](
https://github.com/wechaty/wechaty/wiki/API#4-messagetocontactorroomid-string-void
)
6
.
[
to(contact:string):void
](
https://github.com/wechaty/wechaty/wiki/API#4-messagetocontactorroomid-string-void
)
set the destination as contact by 'weixin', for the message
set the destination as contact by 'weixin', for the message
7.
[
content():string
](
https://github.com/wechaty/wechaty/wiki/API#1-messagecontent-string
)
1.
[
content():string
](
https://github.com/wechaty/wechaty/wiki/API#1-messagecontent-string
)
get the content of the message
get the content of the message
8.
[
content(content:string):string
](
https://github.com/wechaty/wechaty/wiki/API#2-messagecontentcontent-string-string
)
1.
[
content(content:string):string
](
https://github.com/wechaty/wechaty/wiki/API#2-messagecontentcontent-string-string
)
set the content for the message
set the content for the message
9.
[
room():Room|null
](
https://github.com/wechaty/wechaty/wiki/API#1-messageroom-room--null
)
1.
[
room():Room|null
](
https://github.com/wechaty/wechaty/wiki/API#1-messageroom-room--null
)
get the room from a message.
get the room from a message.
10.
[
room(room:Room):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messageroomroom-room-void
)
1.
[
room(room:Room):void
](
https://github.com/wechaty/wechaty/wiki/API#2-messageroomroom-room-void
)
set the room for a message.
set the room for a message.
11.
[
room(roomId:string):void
](
https://github.com/wechaty/wechaty/wiki/API#3-messageroomroomid-string-void
)
1.
[
room(roomId:string):void
](
https://github.com/wechaty/wechaty/wiki/API#3-messageroomroomid-string-void
)
set the room by id for a Message
set the room by id for a Message
12.
[
say(content:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#messagesaycontent-string-promise
)
1.
[
say(content:string):Promise
](
https://github.com/wechaty/wechaty/wiki/API#messagesaycontent-string-promise
)
reply a message to the sender.
reply a message to the sender.
13.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#messageready-promise
)
1.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#messageready-promise
)
confirm get all the data needed, will be resolved when all message data is ready.
confirm get all the data needed, will be resolved when all message data is ready.
1.
[
self(message:Message):boolean
](
https://github.com/wechaty/wechaty/wiki/API#messageselfmessage-message-boolean
)
check if a message is sent by self
14.
[
self(message:Message):boolean
](
https://github.com/wechaty/wechaty/wiki/API#messageselfmessage-message-boolean
)
check if a message is sent by self
## [Room](https://github.com/wechaty/wechaty/wiki/API#class-room)
1.
[
say(content:string,replyTo:Contact|ContactArray):Promise
](
https://github.com/wechaty/wechaty/wiki/API#roomsaycontent-string-replyto-contactcontact-promise
)
say content inside Room.
1.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#roomready-promise
)
say content inside Room.
confirm get all the data needed, will be resolved when all data is ready
2.
[
ready():Promise
](
https://github.com/wechaty/wechaty/wiki/API#roomready-promise
)
1.
[
refresh():Promise
](
https://github.com/wechaty/wechaty/wiki/API#roomrefresh-promise
)
confirm get all the data needed, will be resolved when all data is ready
force reload data for Room
3.
[
refresh():Promise
](
https://github.com/wechaty/wechaty/wiki/API#roomrefresh-promise
)
force reload data for Room
### [Room Event](https://github.com/wechaty/wechaty/wiki/API#room-event)
1.
[
join
](
https://github.com/wechaty/wechaty/wiki/API#event-join
)
Emit when someone join the room
Emit when someone join the room
1
.
[
leave
](
https://github.com/wechaty/wechaty/wiki/API#event-leave
)
2
.
[
leave
](
https://github.com/wechaty/wechaty/wiki/API#event-leave
)
Emit when someone leave the room
Emit when someone leave the room
1
.
[
topic
](
https://github.com/wechaty/wechaty/wiki/API#event-topic
)
3
.
[
topic
](
https://github.com/wechaty/wechaty/wiki/API#event-topic
)
Emit when someone change the room topic
Emit when someone change the room topic
# Test
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录