Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added wechaty-class section #913

Merged
merged 9 commits into from
Sep 8, 2021
18 changes: 18 additions & 0 deletions docusaurus/docs/api/wechaty-class.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Classes

### Wechaty

Wechaty is the main bot class.

A `Bot` is a wechat client that depends on which type of puppet is used. The form the Bot takes is widely divided into 3 main categories-

* **web-wechat** - when Puppet-Puppeteer or Puppet-wechat4u is used
* **ipad-wechat** - when Puppet-padchat is used
* **ios-wechat** - when Puppet-ioscat is used

To understand puppet and its uses do visit the below link-

### [What is a Puppet in Wechaty](https://github.com/wechaty/wechaty-getting-started/wiki/FAQ-EN#31-what-is-a-puppet-in-wechaty)?

> If you want to know how to send message, see Message
> If you want to know how to get contact, see Contact