Wechaty

Main bot class, A Bot is a wechat client depends on which puppet you use.

Classes

Wechaty

Main bot class.

A Bot is a wechat client depends on which puppet you use. It may equals

web-wechat, when you use: puppet-puppeteer/puppet-wechat4u
ipad-wechat, when you use: puppet-padchat
ios-wechat, when you use: puppet-ioscat

See more:

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

Typedefs

PuppetName

The term Puppet in Wechaty is an Abstract Class for implementing protocol plugins. The plugins are the component that helps Wechaty to control the Wechat(that's the reason we call it puppet). The plugins are named PuppetXXX, for example:

WechatyOptions

The option parameter to create a wechaty instance WechatyEventName

Wechaty Class Event Type WechatyEventFunction

Wechaty Class Event Function

Wechaty

Main bot class.

A Bot is a wechat client depends on which puppet you use. It may equals

web-wechat, when you use: puppet-puppeteer/puppet-wechat4u
ipad-wechat, when you use: puppet-padchat
ios-wechat, when you use: puppet-ioscat

See more:

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

Kind: global class

Wechaty
- new Wechaty([options])
- instance
  - .on(event, listener) ⇒ Wechaty
  - .start() ⇒ Promise <void>
  - .stop() ⇒ Promise <void>
  - .logout() ⇒ Promise <void>
  - .logonoff() ⇒ boolean
  - .userSelf() ⇒ ContactSelf
  - .say(textOrContactOrFileOrUrl) ⇒ Promise <void>
- static
  - .instance([options])

new Wechaty([options])

Creates an instance of Wechaty.

Param	Type	Default
[options]	`WechatyOptions`	`{}`

Example (The World's Shortest ChatBot Code: 6 lines of JavaScript)

import { Wechaty }  from 'wechaty'
const bot = new Wechaty()
bot.on('scan',    (qrcode, status) => console.log(['https://api.qrserver.com/v1/create-qr-code/?data=',encodeURIComponent(qrcode),'&size=220x220&margin=20',].join('')))
bot.on('login',   user => console.log(`User ${user} logined`))
bot.on('message', message => console.log(`Message: ${message}`))
bot.start()

wechaty.on(event, listener) ⇒ `Wechaty`

When the bot get message, it will emit the following Event.

You can do anything you want when in these events functions. The main Event name as follows:

scan: Emit when the bot needs to show you a QR Code for scanning. After scan the qrcode, you can login
login: Emit when bot login full successful.
logout: Emit when bot detected log out.
message: Emit when there's a new message.

see more in WechatyEventName

Kind: instance method of Wechaty
Returns: Wechaty - - this for chaining, see advanced chaining usage

Param	Type	Description
event	`WechatyEventName`	Emit WechatyEvent
listener	`WechatyEventFunction`	Depends on the WechatyEvent

Example (Event:scan)

// Scan Event will emit when the bot needs to show you a QR Code for scanning

bot.on('scan', (url, code) => {
  console.log(`[${code}] Scan ${url} to login.` )
})

Example (Event:login )

// Login Event will emit when bot login full successful.

bot.on('login', (user) => {
  console.log(`user ${user} login`)
})

Example (Event:logout )

// Logout Event will emit when bot detected log out.

bot.on('logout', (user) => {
  console.log(`user ${user} logout`)
})

Example (Event:message )

// Message Event will emit when there's a new message.

wechaty.on('message', (message) => {
  console.log(`message ${message} received`)
})

Example (Event:friendship )

// Friendship Event will emit when got a new friend request, or friendship is confirmed.

bot.on('friendship', async (friendship) => {
  const contact = friendship.contact()
  if (friendship.type() === bot.Friendship.Type.Receive) { // 1. receive new friendship request from new contact
    let result = await friendship.accept()
    if (result) {
      console.log(`Request from ${contact.name()} is accept succesfully!`)
    } else {
      console.log(`Request from ${contact.name()} failed to accept!`)
    }
  } else if (friendship.type() === bot.Friendship.Type.Confirm) { // 2. confirm friendship
    console.log(`New friendship confirmed with ${contact.name()}`)
  }
})

Example (Event:room-join )

// room-join Event will emit when someone join the room.

bot.on('room-join', async (room, inviteeList, inviter) => {
  const nameList = inviteeList.map(c => c.name()).join(',')
  console.log(`Room ${await room.topic()} got new member ${nameList}, invited by ${inviter}`)
})

Example (Event:room-leave )

// room-leave Event will emit when someone leave the room.

bot.on('room-leave', async (room, leaverList, remover) => {
  const nameList = leaverList.map(c => c.name()).join(',')
  console.log(`Room ${await room.topic()} lost member ${nameList}, the remover is: ${remover}`)
})

Example (Event:room-topic )

// room-topic Event will emit when someone change the room's topic.

bot.on('room-topic', async (room, topic, oldTopic, changer) => {
  console.log(`Room ${await room.topic()} topic changed from ${oldTopic} to ${topic} by ${changer.name()}`)
})

Example (Event:room-invite, RoomInvitation has been encapsulated as a RoomInvitation Class. )

// room-invite Event will emit when there's an room invitation.

bot.on('room-invite', async roomInvitation => {
  try {
    console.log(`received room-invite event.`)
    await roomInvitation.accept()
  } catch (e) {
    console.error(e)
  }
}

Example (Event:error )

// error Event will emit when there's an error occurred.

bot.on('error', (error) => {
  console.error(error)
})