Wechaty v0.62.1 Documentation

• Website - https://wechaty.js.org
• Docs Site - https://wechaty.js.org/docs/
• API References - https://wechaty.github.io/wechaty/

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

Room

All WeChat rooms(groups) will be encapsulated as a Room.

Examples/Room-Bot

Contact

All wechat contacts(friend) will be encapsulated as a Contact. Examples/Contact-Bot

ContactSelf

Bot itself will be encapsulated as a ContactSelf.

Tips: this class is extends Contact

Friendship

Send, receive friend request, and friend confirmation events.

1. send request
2. receive request(in friend event)
3. confirmation friendship(friend event)

Examples/Friend-Bot

Message

All wechat messages will be encapsulated as a Message.

Examples/Ding-Dong-Bot

RoomInvitation

accept room invitation

Constants

cuid_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

wechaty_puppet_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

events_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

events_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Functions

guardWechatify()

Huan(202008): we will bind the wechaty puppet with user modules (Contact, Room, etc) together inside the start() method

Typedefs

PuppetModuleName

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 XXXPuppet, for example:

• PuppetPuppeteer:
• PuppetPadchat

WechatyOptions

The option parameter to create a wechaty instance

RoomQueryFilter

The filter to find the room: {topic: string | RegExp}

RoomEventName

Room Class Event Type

RoomEventFunction

Room Class Event Function

RoomMemberQueryFilter

The way to search member by Room.member()

ContactQueryFilter

The way to search Contact

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
    • .wechatifiedContact
    • .name()
    • .use(…plugins) ⇒ Wechaty
    • .start() ⇒ Promise.<void>
    • .stop() ⇒ Promise.<void>
    • .logout() ⇒ Promise.<void>
    • .logonoff() ⇒ boolean
    • .userSelf() ⇒ ContactSelf
    • .say(something) ⇒ Promise.<void>
  • static
    • .instance([options])
    • .use(…plugins) ⇒ Wechaty

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://wechaty.js.org/qrcode/' + encodeURIComponent(qrcode)))
bot.on('login',   user => console.log(`User ${user} logged in`))
bot.on('message', message => console.log(`Message: ${message}`))
bot.start()

wechaty.wechatifiedContact

1. Setup Wechaty User Classes

Kind: instance property of Wechaty

wechaty.name()

Wechaty bot name set by options.name default: wechaty

Kind: instance method of Wechaty

wechaty.use(…plugins) ⇒ Wechaty

For wechaty ecosystem, allow user to define a 3rd party plugin for the current wechaty instance.

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

Param	Type	Description
…plugins	Array.<WechatyPlugin>	The plugins you want to use

Example

// The same usage with Wechaty.use().

wechaty.start() ⇒ Promise.<void>

When you start the bot, bot will begin to login, need you WeChat scan qrcode to login

Tips: All the bot operation needs to be triggered after start() is done

Kind: instance method of Wechaty
Example

await bot.start()
// do other stuff with bot here

wechaty.stop() ⇒ Promise.<void>

Stop the bot

Kind: instance method of Wechaty
Example

await bot.stop()

wechaty.logout() ⇒ Promise.<void>

Logout the bot

Kind: instance method of Wechaty
Example

await bot.logout()

wechaty.logonoff() ⇒ boolean

Get the logon / logoff state

Kind: instance method of Wechaty
Example

if (bot.logonoff()) {
  console.log('Bot logged in')
} else {
  console.log('Bot not logged in')
}

wechaty.userSelf() ⇒ ContactSelf

Get current user

Kind: instance method of Wechaty
Example

const contact = bot.userSelf()
console.log(`Bot is ${contact.name()}`)

wechaty.say(something) ⇒ Promise.<void>

Send message to userSelf, in other words, bot send message to itself.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Wechaty

Param	Type	Description
something	string | Contact | FileBox | UrlLink | MiniProgram	send text, Contact, or file to bot. </br> You can use FileBox to send file

Example

const bot = new Wechaty()
await bot.start()
// after logged in

// 1. send text to bot itself
await bot.say('hello!')

// 2. send Contact to bot itself
const contact = await bot.Contact.find()
await bot.say(contact)

// 3. send Image to bot itself from remote url
import { FileBox }  from 'wechaty'
const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
await bot.say(fileBox)

// 4. send Image to bot itself from local file
import { FileBox }  from 'wechaty'
const fileBox = FileBox.fromFile('/tmp/text.jpg')
await bot.say(fileBox)

// 5. send Link to bot itself
const linkPayload = new UrlLink ({
  description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
  thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
  title       : 'Welcome to Wechaty',
  url         : 'https://github.com/wechaty/wechaty',
})
await bot.say(linkPayload)

// 6. send MiniProgram to bot itself
const miniPayload = new MiniProgram ({
  username           : 'gh_xxxxxxx',     //get from mp.weixin.qq.com
  appid              : '',               //optional, get from mp.weixin.qq.com
  title              : '',               //optional
  pagepath           : '',               //optional
  description        : '',               //optional
  thumbnailurl       : '',               //optional
})
await bot.say(miniPayload)

Wechaty.instance([options])

Get the global instance of Wechaty

Kind: static method of Wechaty

Param	Type	Default
[options]	WechatyOptions	{}

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

const { Wechaty } = require('wechaty')

Wechaty.instance() // Global instance
.on('scan', (url, status) => console.log(`Scan QR Code to login: ${status}\n${url}`))
.on('login',       user => console.log(`User ${user} logged in`))
.on('message',  message => console.log(`Message: ${message}`))
.start()

Wechaty.use(…plugins) ⇒ Wechaty

For wechaty ecosystem, allow user to define a 3rd party plugin for the all wechaty instances

Kind: static method of Wechaty
Returns: Wechaty - - this for chaining,

Param	Type	Description
…plugins	Array.<WechatyPlugin>	The plugins you want to use

Example

// Report all chat message to my server.

function WechatyReportPlugin(options: { url: string }) {
  return function (this: Wechaty) {
    this.on('message', message => http.post(options.url, { data: message }))
  }
}

bot.use(WechatyReportPlugin({ url: 'http://somewhere.to.report.your.data.com' })

Room

All WeChat rooms(groups) will be encapsulated as a Room.

Examples/Room-Bot

Kind: global class
Properties

Name	Type	Description
id	string	Room id. This function is depending on the Puppet Implementation, see puppet-compatible-table

• Room
  • instance
    • .sync() ⇒ Promise.<void>
    • .say(textOrContactOrFileOrUrlOrMini, [mention]) ⇒ Promise.<(void\|Message)>
    • .add(contact) ⇒ Promise.<void>
    • .remove(contact) ⇒ Promise.<void>
    • .del()
    • .quit() ⇒ Promise.<void>
    • .topic([newTopic]) ⇒ Promise.<(string\|void)>
    • .announce([text]) ⇒ Promise.<(void\|string)>
    • .qrCode() ⇒ Promise.<string>
    • .alias(contact) ⇒ Promise.<(string\|null)>
    • .has(contact) ⇒ Promise.<boolean>
    • .memberAll([query]) ⇒ Promise.<Array.<Contact>>
    • .member(queryArg) ⇒ Promise.<(null\|Contact)>
    • .owner() ⇒ Contact | null
    • .avatar() ⇒ FileBox
  • static
    • .create(contactList, [topic]) ⇒ Promise.<Room>
    • .findAll([query]) ⇒ Promise.<Array.<Room>>
    • .find(query) ⇒ Promise.<(Room\|null)>

room.sync() ⇒ Promise.<void>

Force reload data for Room, Sync data from puppet API again.

Kind: instance method of Room
Example

await room.sync()

room.say(textOrContactOrFileOrUrlOrMini, [mention]) ⇒ Promise.<(void\|Message)>

Send message inside Room, if set [replyTo], wechaty will mention the contact as well.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Room

Param	Type	Description
textOrContactOrFileOrUrlOrMini	string | Contact | FileBox	Send text or media file inside Room. You can use FileBox to send file
[mention]	Contact | Array.<Contact>	Optional parameter, send content inside Room, and mention @replyTo contact or contactList.

Example

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'wechaty'})

// 1. Send text inside Room

await room.say('Hello world!')
const msg = await room.say('Hello world!') // only supported by puppet-padplus

// 2. Send media file inside Room
import { FileBox }  from 'wechaty'
const fileBox1 = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
const fileBox2 = FileBox.fromLocal('/tmp/text.txt')
await room.say(fileBox1)
const msg1 = await room.say(fileBox1) // only supported by puppet-padplus
await room.say(fileBox2)
const msg2 = await room.say(fileBox2) // only supported by puppet-padplus

// 3. Send Contact Card in a room
const contactCard = await bot.Contact.find({name: 'lijiarui'}) // change 'lijiarui' to any of the room member
await room.say(contactCard)
const msg = await room.say(contactCard) // only supported by puppet-padplus

// 4. Send text inside room and mention @mention contact
const contact = await bot.Contact.find({name: 'lijiarui'}) // change 'lijiarui' to any of the room member
await room.say('Hello world!', contact)
const msg = await room.say('Hello world!', contact) // only supported by puppet-padplus

// 5. Send text inside room and mention someone with Tagged Template
const contact2 = await bot.Contact.find({name: 'zixia'}) // change 'zixia' to any of the room member
await room.say`Hello ${contact}, here is the world ${contact2}`
const msg = await room.say`Hello ${contact}, here is the world ${contact2}` // only supported by puppet-padplus

// 6. send url link in a room

const urlLink = new UrlLink ({
  description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
  thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
  title       : 'Welcome to Wechaty',
  url         : 'https://github.com/wechaty/wechaty',
})
await room.say(urlLink)
const msg = await room.say(urlLink) // only supported by puppet-padplus

// 7. send mini program in a room

const miniProgram = new MiniProgram ({
  username           : 'gh_xxxxxxx',     //get from mp.weixin.qq.com
  appid              : '',               //optional, get from mp.weixin.qq.com
  title              : '',               //optional
  pagepath           : '',               //optional
  description        : '',               //optional
  thumbnailurl       : '',               //optional
})
await room.say(miniProgram)
const msg = await room.say(miniProgram) // only supported by puppet-padplus

room.add(contact) ⇒ Promise.<void>

Add contact in a room

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

see Web version of WeChat closed group interface

Kind: instance method of Room

Param	Type
contact	Contact

Example

const bot = new Wechaty()
await bot.start()
// after logged in...
const contact = await bot.Contact.find({name: 'lijiarui'}) // change 'lijiarui' to any contact in your WeChat
const room = await bot.Room.find({topic: 'WeChat'})        // change 'WeChat' to any room topic in your WeChat
if (room) {
  try {
     await room.add(contact)
  } catch(e) {
     console.error(e)
  }
}

room.remove(contact) ⇒ Promise.<void>

Remove a contact from the room It works only when the bot is the owner of the room

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

see Web version of WeChat closed group interface

Kind: instance method of Room

Param	Type
contact	Contact

Example

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'WeChat'})          // change 'WeChat' to any room topic in your WeChat
const contact = await bot.Contact.find({name: 'lijiarui'})   // change 'lijiarui' to any room member in the room you just set
if (room) {
  try {
     await room.remove(contact)
  } catch(e) {
     console.error(e)
  }
}

room.del()

Deprecated

Kind: instance method of Room

room.quit() ⇒ Promise.<void>

Bot quit the room itself

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Room
Example

await room.quit()

room.topic([newTopic]) ⇒ Promise.<(string\|void)>

SET/GET topic from the room

Kind: instance method of Room

Param	Type	Description
[newTopic]	string	If set this para, it will change room topic.

Example (When you say anything in a room, it will get room topic. )

const bot = new Wechaty()
bot
.on('message', async m => {
  const room = m.room()
  if (room) {
    const topic = await room.topic()
    console.log(`room topic is : ${topic}`)
  }
})
.start()

Example (When you say anything in a room, it will change room topic. )

const bot = new Wechaty()
bot
.on('message', async m => {
  const room = m.room()
  if (room) {
    const oldTopic = await room.topic()
    await room.topic('change topic to wechaty!')
    console.log(`room topic change from ${oldTopic} to ${room.topic()}`)
  }
})
.start()

room.announce([text]) ⇒ Promise.<(void\|string)>

SET/GET announce from the room

Tips: It only works when bot is the owner of the room.

This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Room

Param	Type	Description
[text]	string	If set this para, it will change room announce.

Example (When you say anything in a room, it will get room announce. )

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'your room'})
const announce = await room.announce()
console.log(`room announce is : ${announce}`)

Example (When you say anything in a room, it will change room announce. )

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'your room'})
const oldAnnounce = await room.announce()
await room.announce('change announce to wechaty!')
console.log(`room announce change from ${oldAnnounce} to ${room.announce()}`)

room.qrCode() ⇒ Promise.<string>

Get QR Code Value of the Room from the room, which can be used as scan and join the room.

Tips:

1. This function is depending on the Puppet Implementation, see puppet-compatible-table
2. The return should be the QR Code Data, instead of the QR Code Image. (the data should be less than 8KB. See: https://stackoverflow.com/a/12764370/1123955 )

Kind: instance method of Room

room.alias(contact) ⇒ Promise.<(string\|null)>

Return contact’s roomAlias in the room

Kind: instance method of Room
Returns: Promise.<(string\|null)> - - If a contact has an alias in room, return string, otherwise return null

Param	Type
contact	Contact

Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const room = m.room()
  const contact = m.from()
  if (room) {
    const alias = await room.alias(contact)
    console.log(`${contact.name()} alias is ${alias}`)
  }
})
.start()

room.has(contact) ⇒ Promise.<boolean>

Check if the room has member contact, the return is a Promise and must be await-ed

Kind: instance method of Room
Returns: Promise.<boolean> - Return true if has contact, else return false.

Param	Type
contact	Contact

Example (Check whether 'lijiarui' is in the room 'wechaty')

const bot = new Wechaty()
await bot.start()
// after logged in...
const contact = await bot.Contact.find({name: 'lijiarui'})   // change 'lijiarui' to any of contact in your WeChat
const room = await bot.Room.find({topic: 'wechaty'})         // change 'wechaty' to any of the room in your WeChat
if (contact && room) {
  if (await room.has(contact)) {
    console.log(`${contact.name()} is in the room wechaty!`)
  } else {
    console.log(`${contact.name()} is not in the room wechaty!`)
  }
}

room.memberAll([query]) ⇒ Promise.<Array.<Contact>>

Find all contacts in a room

definition

• name the name-string set by user-self, should be called name, equal to Contact.name()
• roomAlias the name-string set by user-self in the room, should be called roomAlias
• contactAlias the name-string set by bot for others, should be called alias, equal to Contact.alias()

Kind: instance method of Room

Param	Type	Description
[query]	RoomMemberQueryFilter | string	Optional parameter, When use memberAll(name:string), return all matched members, including name, roomAlias, contactAlias

Example

const roomList:Contact[] | null = await room.findAll()
if(roomList)
 console.log(`room all member list: `, roomList)
const memberContactList: Contact[] | null =await room.findAll(`abc`)
console.log(`contact list with all name, room alias, alias are abc:`, memberContactList)

room.member(queryArg) ⇒ Promise.<(null\|Contact)>

Find all contacts in a room, if get many, return the first one.

Kind: instance method of Room

Param	Type	Description
queryArg	RoomMemberQueryFilter | string	When use member(name:string), return all matched members, including name, roomAlias, contactAlias

Example (Find member by name)

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'wechaty'})           // change 'wechaty' to any room name in your WeChat
if (room) {
  const member = await room.member('lijiarui')             // change 'lijiarui' to any room member in your WeChat
  if (member) {
    console.log(`wechaty room got the member: ${member.name()}`)
  } else {
    console.log(`cannot get member in wechaty room!`)
  }
}

Example (Find member by MemberQueryFilter)

const bot = new Wechaty()
await bot.start()
// after logged in...
const room = await bot.Room.find({topic: 'wechaty'})          // change 'wechaty' to any room name in your WeChat
if (room) {
  const member = await room.member({name: 'lijiarui'})        // change 'lijiarui' to any room member in your WeChat
  if (member) {
    console.log(`wechaty room got the member: ${member.name()}`)
  } else {
    console.log(`cannot get member in wechaty room!`)
  }
}

room.owner() ⇒ Contact | null

Get room’s owner from the room.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Room
Example

const owner = room.owner()

room.avatar() ⇒ FileBox

Get avatar from the room.

Kind: instance method of Room
Example

const fileBox = await room.avatar()
const name = fileBox.name
fileBox.toFile(name)

Room.create(contactList, [topic]) ⇒ Promise.<Room>

Create a new room.

Kind: static method of Room

Param	Type
contactList	Array.<Contact>
[topic]	string

Example (Creat a room with 'lijiarui' and 'huan', the room topic is 'ding - created')

const helperContactA = await Contact.find({ name: 'lijiarui' })  // change 'lijiarui' to any contact in your WeChat
const helperContactB = await Contact.find({ name: 'huan' })  // change 'huan' to any contact in your WeChat
const contactList = [helperContactA, helperContactB]
console.log('Bot', 'contactList: %s', contactList.join(','))
const room = await Room.create(contactList, 'ding')
console.log('Bot', 'createDingRoom() new ding room created: %s', room)
await room.topic('ding - created')
await room.say('ding - created')

Room.findAll([query]) ⇒ Promise.<Array.<Room>>

Find room by by filter: {topic: string | RegExp}, return all the matched room

Kind: static method of Room

Param	Type
[query]	RoomQueryFilter

Example

const bot = new Wechaty()
await bot.start()
// after logged in
const roomList = await bot.Room.findAll()                    // get the room list of the bot
const roomList = await bot.Room.findAll({topic: 'wechaty'})  // find all of the rooms with name 'wechaty'

Room.find(query) ⇒ Promise.<(Room\|null)>

Try to find a room by filter: {topic: string | RegExp}. If get many, return the first one.

Kind: static method of Room
Returns: Promise.<(Room\|null)> - If can find the room, return Room, or return null

Param	Type
query	RoomQueryFilter

Example

const bot = new Wechaty()
await bot.start()
// after logged in...
const roomList = await bot.Room.find()
const roomList = await bot.Room.find({topic: 'wechaty'})

Contact

All wechat contacts(friend) will be encapsulated as a Contact. Examples/Contact-Bot

Kind: global class
Properties

Name	Type	Description
id	string	Get Contact id. This function is depending on the Puppet Implementation, see puppet-compatible-table

• Contact
  • instance
    • .say(something) ⇒ Promise.<(void\|Message)>
    • .name() ⇒ string
    • .alias(newAlias) ⇒ Promise.<(null\|string\|void)>
    • .friend() ⇒ boolean | null
    • .type() ⇒ ContactType.Unknown | ContactType.Personal | ContactType.Official
    • .gender() ⇒ ContactGender.Unknown | ContactGender.Male | ContactGender.Female
    • .province() ⇒ string | null
    • .city() ⇒ string | null
    • .avatar() ⇒ Promise.<FileBox>
    • .tags() ⇒ Promise.<Array.<Tag>>
    • .sync() ⇒ Promise.<this>
    • .self() ⇒ boolean
  • static
    • .find(query) ⇒ Promise.<(Contact\|null)>
    • .findAll([queryArg]) ⇒ Promise.<Array.<Contact>>
    • .tags() ⇒ Promise.<Array.<Tag>>

contact.say(something) ⇒ Promise.<(void\|Message)>

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Contact

Param	Type	Description
something	string | Contact | FileBox | UrlLink | MiniProgram	send text, Contact, or file to contact. </br> You can use FileBox to send file

Example

const bot = new Wechaty()
await bot.start()
const contact = await bot.Contact.find({name: 'lijiarui'})  // change 'lijiarui' to any of your contact name in wechat

// 1. send text to contact

await contact.say('welcome to wechaty!')
const msg = await contact.say('welcome to wechaty!') // only supported by puppet-padplus

// 2. send media file to contact

import { FileBox }  from 'wechaty'
const fileBox1 = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
const fileBox2 = FileBox.fromFile('/tmp/text.txt')
await contact.say(fileBox1)
const msg1 = await contact.say(fileBox1) // only supported by puppet-padplus
await contact.say(fileBox2)
const msg2 = await contact.say(fileBox2) // only supported by puppet-padplus

// 3. send contact card to contact

const contactCard = bot.Contact.load('contactId')
const msg = await contact.say(contactCard) // only supported by puppet-padplus

// 4. send url link to contact

const urlLink = new UrlLink ({
  description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
  thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
  title       : 'Welcome to Wechaty',
  url         : 'https://github.com/wechaty/wechaty',
})
await contact.say(urlLink)
const msg = await contact.say(urlLink) // only supported by puppet-padplus

// 5. send mini program to contact

const miniProgram = new MiniProgram ({
  username           : 'gh_xxxxxxx',     //get from mp.weixin.qq.com
  appid              : '',               //optional, get from mp.weixin.qq.com
  title              : '',               //optional
  pagepath           : '',               //optional
  description        : '',               //optional
  thumbnailurl       : '',               //optional
})
await contact.say(miniProgram)
const msg = await contact.say(miniProgram) // only supported by puppet-padplus

contact.name() ⇒ string

Get the name from a contact

Kind: instance method of Contact
Example

const name = contact.name()

contact.alias(newAlias) ⇒ Promise.<(null\|string\|void)>

GET / SET / DELETE the alias for a contact

Tests show it will failed if set alias too frequently(60 times in one minute).

Kind: instance method of Contact

Param	Type
newAlias	none | string | null

Example ( GET the alias for a contact, return {(Promise<string | null>)})

const alias = await contact.alias()
if (alias === null) {
  console.log('You have not yet set any alias for contact ' + contact.name())
} else {
  console.log('You have already set an alias for contact ' + contact.name() + ':' + alias)
}

Example (SET the alias for a contact)

try {
  await contact.alias('lijiarui')
  console.log(`change ${contact.name()}'s alias successfully!`)
} catch (e) {
  console.log(`failed to change ${contact.name()} alias!`)
}

Example (DELETE the alias for a contact)

try {
  const oldAlias = await contact.alias(null)
  console.log(`delete ${contact.name()}'s alias successfully!`)
  console.log('old alias is ${oldAlias}`)
} catch (e) {
  console.log(`failed to delete ${contact.name()}'s alias!`)
}

contact.friend() ⇒ boolean | null

Check if contact is friend

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Contact
Returns: boolean | null -
True for friend of the bot
False for not friend of the bot, null for unknown.
Example

const isFriend = contact.friend()

contact.type() ⇒ ContactType.Unknown | ContactType.Personal | ContactType.Official

Return the type of the Contact

Tips: ContactType is enum here.</br>

Kind: instance method of Contact
Example

const bot = new Wechaty()
await bot.start()
const isOfficial = contact.type() === bot.Contact.Type.Official

contact.gender() ⇒ ContactGender.Unknown | ContactGender.Male | ContactGender.Female

Contact gender

Tips: ContactGender is enum here. </br>

Kind: instance method of Contact
Example

const gender = contact.gender() === bot.Contact.Gender.Male

contact.province() ⇒ string | null

Get the region ‘province’ from a contact

Kind: instance method of Contact
Example

const province = contact.province()

contact.city() ⇒ string | null

Get the region ‘city’ from a contact

Kind: instance method of Contact
Example

const city = contact.city()

contact.avatar() ⇒ Promise.<FileBox>

Get avatar picture file stream

Kind: instance method of Contact
Example

// Save avatar to local file like `1-name.jpg`

const file = await contact.avatar()
const name = file.name
await file.toFile(name, true)
console.log(`Contact: ${contact.name()} with avatar file: ${name}`)

contact.tags() ⇒ Promise.<Array.<Tag>>

Get all tags of contact

Kind: instance method of Contact
Example

const tags = await contact.tags()

contact.sync() ⇒ Promise.<this>

Force reload data for Contact, Sync data from low-level API again.

Kind: instance method of Contact
Example

await contact.sync()

contact.self() ⇒ boolean

Check if contact is self

Kind: instance method of Contact
Returns: boolean - True for contact is self, False for contact is others
Example

const isSelf = contact.self()

Contact.find(query) ⇒ Promise.<(Contact\|null)>

Try to find a contact by filter: {name: string | RegExp} / {alias: string | RegExp}

Find contact by name or alias, if the result more than one, return the first one.

Kind: static method of Contact
Returns: Promise.<(Contact\|null)> - If can find the contact, return Contact, or return null

Param	Type
query	ContactQueryFilter

Example

const bot = new Wechaty()
await bot.start()
const contactFindByName = await bot.Contact.find({ name:"ruirui"} )
const contactFindByAlias = await bot.Contact.find({ alias:"lijiarui"} )

Contact.findAll([queryArg]) ⇒ Promise.<Array.<Contact>>

Find contact by name or alias

If use Contact.findAll() get the contact list of the bot.

definition

• name the name-string set by user-self, should be called name
• alias the name-string set by bot for others, should be called alias

Kind: static method of Contact

Param	Type
[queryArg]	ContactQueryFilter

Example

const bot = new Wechaty()
await bot.start()
const contactList = await bot.Contact.findAll()                      // get the contact list of the bot
const contactList = await bot.Contact.findAll({ name: 'ruirui' })    // find all of the contacts whose name is 'ruirui'
const contactList = await bot.Contact.findAll({ alias: 'lijiarui' }) // find all of the contacts whose alias is 'lijiarui'

Contact.tags() ⇒ Promise.<Array.<Tag>>

Get tags for all contact

Kind: static method of Contact
Example

const tags = await wechaty.Contact.tags()

ContactSelf

Bot itself will be encapsulated as a ContactSelf.

Tips: this class is extends Contact

Kind: global class

• ContactSelf
  • .avatar([file]) ⇒ Promise.<(void\|FileBox)>
  • .qrcode() ⇒ Promise.<string>
  • .signature(signature)

contactSelf.avatar([file]) ⇒ Promise.<(void\|FileBox)>

GET / SET bot avatar

Kind: instance method of ContactSelf

Param	Type
[file]	FileBox

Example ( GET the avatar for bot, return {Promise<FileBox>})

// 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 (SET the avatar for a bot)

import { FileBox }  from 'wechaty'
bot.on('login', (user: ContactSelf) => {
  console.log(`user ${user} login`)
  const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
  await user.avatar(fileBox)
  console.log(`Change bot avatar successfully!`)
})

contactSelf.qrcode() ⇒ Promise.<string>

Get bot qrcode

Kind: instance method of ContactSelf
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 })
})

contactSelf.signature(signature)

Change bot signature

Kind: instance method of ContactSelf

Param	Description
signature	The new signature that the bot will change to

Example

bot.on('login', async user => {
  console.log(`user ${user} login`)
  try {
    await user.signature(`Signature changed by wechaty on ${new Date()}`)
  } catch (e) {
    console.error('change signature failed', e)
  }
})

Friendship

Send, receive friend request, and friend confirmation events.

1. send request
2. receive request(in friend event)
3. confirmation friendship(friend event)

Examples/Friend-Bot

Kind: global class

• Friendship
  • instance
    • .accept() ⇒ Promise.<void>
    • .hello() ⇒ string
    • .contact() ⇒ Contact
    • .type() ⇒ FriendshipType
    • .toJSON() ⇒ FriendshipPayload
  • static
    • .search(condition) ⇒ Promise.<Contact>
    • .add(contact, options) ⇒ Promise.<void>
    • .fromJSON()

friendship.accept() ⇒ Promise.<void>

Accept Friend Request

Kind: instance method of Friendship
Example

const bot = new Wechaty()
bot.on('friendship', async friendship => {
  try {
    console.log(`received friend event.`)
    switch (friendship.type()) {

    // 1. New Friend Request

    case Friendship.Type.Receive:
      await friendship.accept()
      break

    // 2. Friend Ship Confirmed

    case Friendship.Type.Confirm:
      console.log(`friend ship confirmed`)
      break
    }
  } catch (e) {
    console.error(e)
  }
}
.start()

friendship.hello() ⇒ string

Get verify message from

Kind: instance method of Friendship
Example (If request content is `ding`, then accept the friendship)

const bot = new Wechaty()
bot.on('friendship', async friendship => {
  try {
    console.log(`received friend event from ${friendship.contact().name()}`)
    if (friendship.type() === Friendship.Type.Receive && friendship.hello() === 'ding') {
      await friendship.accept()
    }
  } catch (e) {
    console.error(e)
  }
}
.start()

friendship.contact() ⇒ Contact

Get the contact from friendship

Kind: instance method of Friendship
Example

const bot = new Wechaty()
bot.on('friendship', async friendship => {
  const contact = friendship.contact()
  const name = contact.name()
  console.log(`received friend event from ${name}`)
}
.start()

friendship.type() ⇒ FriendshipType

Return the Friendship Type

Tips: FriendshipType is enum here. </br>

• FriendshipType.Unknown </br>
• FriendshipType.Confirm </br>
• FriendshipType.Receive </br>
• FriendshipType.Verify </br>

Kind: instance method of Friendship
Example (If request content is `ding`, then accept the friendship)

const bot = new Wechaty()
bot.on('friendship', async friendship => {
  try {
    if (friendship.type() === Friendship.Type.Receive && friendship.hello() === 'ding') {
      await friendship.accept()
    }
  } catch (e) {
    console.error(e)
  }
}
.start()

friendship.toJSON() ⇒ FriendshipPayload

get friendShipPayload Json

Kind: instance method of Friendship
Example

const bot = new Wechaty()
bot.on('friendship', async friendship => {
  try {
    // JSON.stringify(friendship) as well.
    const payload = await friendship.toJSON()
  } catch (e) {
    console.error(e)
  }
}
.start()

Friendship.search(condition) ⇒ Promise.<Contact>

Search a Friend by phone or weixin.

The best practice is to search friend request once per minute. Remember not to do this too frequently, or your account may be blocked.

Kind: static method of Friendship

Param	Type	Description
condition	FriendshipSearchCondition	Search friend by phone or weixin.

Example

const friend_phone = await bot.Friendship.search({phone: '13112341234'})
const friend_weixin = await bot.Friendship.search({weixin: 'weixin_account'})

console.log(`This is the new friend info searched by phone : ${friend_phone}`)
await bot.Friendship.add(friend_phone, 'hello')

Friendship.add(contact, options) ⇒ Promise.<void>

Send a Friend Request to a contact with message hello.

The best practice is to send friend request once per minute. Remeber not to do this too frequently, or your account may be blocked.

Kind: static method of Friendship

Param	Type	Description
contact	Contact	Send friend request to contact
options	FriendshipAddOptions	The friend request content

Example

const contact = await bot.Friendship.search({phone: '13112341234'})
await bot.Friendship.add(contact, 'Nice to meet you! I am wechaty bot!')

const memberList = await room.memberList()
for (let i = 0; i < memberList.length; i++) {
  await bot.Friendship.add(member, {
    room: room,
    hello: `Nice to meet you! I am wechaty bot from room: ${await room.topic()}!`,
  })
}

Friendship.fromJSON()

create friendShip by friendshipJson

Kind: static method of Friendship
Example

const bot = new Wechaty()
bot.start()

const payload = '{...}'  // your saved JSON payload
const friendship = bot.FriendShip.fromJSON(friendshipFromDisk)
await friendship.accept()

Message

All wechat messages will be encapsulated as a Message.

Examples/Ding-Dong-Bot

Kind: global class

• Message
  • instance
    • .talker() ⇒ Contact
    • .from()
    • .to() ⇒ Contact | null
    • .room() ⇒ Room | null
    • .text() ⇒ string
    • .toRecalled()
    • .say(textOrContactOrFile, [mention]) ⇒ Promise.<(void\|Message)>
    • .recall() ⇒ Promise.<boolean>
    • .type() ⇒ MessageType
    • .self() ⇒ boolean
    • .mentionList() ⇒ Promise.<Array.<Contact>>
    • .mention()
    • .mentionSelf() ⇒ Promise.<boolean>
    • .forward(to) ⇒ Promise.<void>
    • .date()
    • .age() ⇒ number
    • .toFileBox() ⇒ Promise.<FileBox>
    • .toImage() ⇒ Image
    • .toContact() ⇒ Promise.<Contact>
  • static
    • .find()
    • .findAll()

message.talker() ⇒ Contact

Get the talker of a message.

Kind: instance method of Message
Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const talker = msg.talker()
  const text = msg.text()
  const room = msg.room()
  if (room) {
    const topic = await room.topic()
    console.log(`Room: ${topic} Contact: ${talker.name()} Text: ${text}`)
  } else {
    console.log(`Contact: ${talker.name()} Text: ${text}`)
  }
})
.start()

message.from()

Kind: instance method of Message
Depreacated: Use message.talker() to replace message.from() https://github.com/wechaty/wechaty/issues/2094

message.to() ⇒ Contact | null

Get the destination of the message Message.to() will return null if a message is in a room, use Message.room() to get the room.

Kind: instance method of Message

message.room() ⇒ Room | null

Get the room from the message. If the message is not in a room, then will return null

Kind: instance method of Message
Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const contact = msg.from()
  const text = msg.text()
  const room = msg.room()
  if (room) {
    const topic = await room.topic()
    console.log(`Room: ${topic} Contact: ${contact.name()} Text: ${text}`)
  } else {
    console.log(`Contact: ${contact.name()} Text: ${text}`)
  }
})
.start()

message.text() ⇒ string

Get the text content of the message

Kind: instance method of Message
Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const contact = msg.from()
  const text = msg.text()
  const room = msg.room()
  if (room) {
    const topic = await room.topic()
    console.log(`Room: ${topic} Contact: ${contact.name()} Text: ${text}`)
  } else {
    console.log(`Contact: ${contact.name()} Text: ${text}`)
  }
})
.start()

message.toRecalled()

Get the recalled message

Kind: instance method of Message
Example

const bot = new Wechaty()
bot
.on('message', async m => {
  if (m.type() === MessageType.Recalled) {
    const recalledMessage = await m.toRecalled()
    console.log(`Message: ${recalledMessage} has been recalled.`)
  }
})
.start()

message.say(textOrContactOrFile, [mention]) ⇒ Promise.<(void\|Message)>

Reply a Text or Media File message to the sender.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Message
See: Examples/ding-dong-bot

Param	Type	Description
textOrContactOrFile	string | Contact | FileBox | UrlLink | MiniProgram	send text, Contact, or file to bot. </br> You can use FileBox to send file
[mention]	Contact | Array.<Contact>	If this is a room message, when you set mention param, you can @ Contact in the room.

Example

import { FileBox }  from 'wechaty'
const bot = new Wechaty()
bot
.on('message', async m => {

// 1. send Image

  if (/^ding$/i.test(m.text())) {
    const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
    await msg.say(fileBox)
    const message = await msg.say(fileBox) // only supported by puppet-padplus
  }

// 2. send Text

  if (/^dong$/i.test(m.text())) {
    await msg.say('ding')
    const message = await msg.say('ding') // only supported by puppet-padplus
  }

// 3. send Contact

  if (/^lijiarui$/i.test(m.text())) {
    const contactCard = await bot.Contact.find({name: 'lijiarui'})
    if (!contactCard) {
      console.log('not found')
      return
    }
    await msg.say(contactCard)
    const message = await msg.say(contactCard) // only supported by puppet-padplus
  }

// 4. send Link

  if (/^link$/i.test(m.text())) {
    const linkPayload = new UrlLink ({
      description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
      thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
      title       : 'Welcome to Wechaty',
      url         : 'https://github.com/wechaty/wechaty',
    })
    await msg.say(linkPayload)
    const message = await msg.say(linkPayload) // only supported by puppet-padplus
  }

// 5. send MiniProgram

  if (/^link$/i.test(m.text())) {
    const miniProgramPayload = new MiniProgram ({
      username           : 'gh_xxxxxxx',     //get from mp.weixin.qq.com
      appid              : '',               //optional, get from mp.weixin.qq.com
      title              : '',               //optional
      pagepath           : '',               //optional
      description        : '',               //optional
      thumbnailurl       : '',               //optional
    })
    await msg.say(miniProgramPayload)
    const message = await msg.say(miniProgramPayload) // only supported by puppet-padplus
  }

})
.start()

message.recall() ⇒ Promise.<boolean>

Recall a message.

Tips:

Kind: instance method of Message
Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const recallMessage = await msg.say('123')
  if (recallMessage) {
    const isSuccess = await recallMessage.recall()
  }
})

message.type() ⇒ MessageType

Get the type from the message.

Tips: MessageType is Enum here. </br>

• MessageType.Unknown </br>
• MessageType.Attachment </br>
• MessageType.Audio </br>
• MessageType.Contact </br>
• MessageType.Emoticon </br>
• MessageType.Image </br>
• MessageType.Text </br>
• MessageType.Video </br>
• MessageType.Url </br>

Kind: instance method of Message
Example

const bot = new Wechaty()
if (message.type() === bot.Message.Type.Text) {
  console.log('This is a text message')
}

message.self() ⇒ boolean

Check if a message is sent by self.

Kind: instance method of Message
Returns: boolean - - Return true for send from self, false for send from others.
Example

if (message.self()) {
 console.log('this message is sent by myself!')
}

message.mentionList() ⇒ Promise.<Array.<Contact>>

Get message mentioned contactList.

Message event table as follows

	Web	Mac PC Client	iOS Mobile	android Mobile
[You were mentioned] tip ([有人@我]的提示)	✘	√	√	√
Identify magic code (8197) by copy & paste in mobile	✘	√	√	✘
Identify magic code (8197) by programming	✘	✘	✘	✘
Identify two contacts with the same roomAlias by [You were mentioned] tip	✘	✘	√	√

Kind: instance method of Message
Returns: Promise.<Array.<Contact>> - - Return message mentioned contactList
Example

const contactList = await message.mentionList()
console.log(contactList)

message.mention()

Deprecated

Kind: instance method of Message

message.mentionSelf() ⇒ Promise.<boolean>

Check if a message is mention self.

Kind: instance method of Message
Returns: Promise.<boolean> - - Return true for mention me.
Example

if (await message.mentionSelf()) {
 console.log('this message were mentioned me! [You were mentioned] tip ([有人@我]的提示)')
}

message.forward(to) ⇒ Promise.<void>

Forward the received message.

Kind: instance method of Message

Param	Type	Description
to	Sayable | Array.<Sayable>	Room or Contact The recipient of the message, the room, or the contact

Example

const bot = new Wechaty()
bot
.on('message', async m => {
  const room = await bot.Room.find({topic: 'wechaty'})
  if (room) {
    await m.forward(room)
    console.log('forward this message to wechaty room!')
  }
})
.start()

message.date()

Message sent date

Kind: instance method of Message

message.age() ⇒ number

Returns the message age in seconds.

For example, the message is sent at time 8:43:01, and when we received it in Wechaty, the time is 8:43:15, then the age() will return 8:43:15 - 8:43:01 = 14 (seconds)

Kind: instance method of Message
Returns: number - message age in seconds.

message.toFileBox() ⇒ Promise.<FileBox>

Extract the Media File from the Message, and put it into the FileBox.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Message
Example (Save media file from a message)

const fileBox = await message.toFileBox()
const fileName = fileBox.name
fileBox.toFile(fileName)

message.toImage() ⇒ Image

Extract the Image File from the Message, so that we can use different image sizes.

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Message
Example (Save image file from a message)

const image = message.toImage()
const fileBox = await image.artwork()
const fileName = fileBox.name
fileBox.toFile(fileName)

message.toContact() ⇒ Promise.<Contact>

Get Share Card of the Message Extract the Contact Card from the Message, and encapsulate it into Contact class

Tips: This function is depending on the Puppet Implementation, see puppet-compatible-table

Kind: instance method of Message

Message.find()

Find message in cache

Kind: static method of Message

Message.findAll()

Find messages in cache

Kind: static method of Message

RoomInvitation

accept room invitation

Kind: global class

• RoomInvitation
  • instance
    • .accept() ⇒ Promise.<void>
    • .inviter() ⇒ Contact
    • .topic() ⇒ string
    • .date() ⇒ Promise.<Date>
    • .age() ⇒ number
    • .toJSON() ⇒ string
  • static
    • .fromJSON() ⇒ RoomInvitation

roomInvitation.accept() ⇒ Promise.<void>

Accept Room Invitation

Kind: instance method of RoomInvitation
Example

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

roomInvitation.inviter() ⇒ Contact

Get the inviter from room invitation

Kind: instance method of RoomInvitation
Example

const bot = new Wechaty()
bot.on('room-invite', async roomInvitation => {
  const inviter = await roomInvitation.inviter()
  const name = inviter.name()
  console.log(`received room invitation event from ${name}`)
}
.start()

roomInvitation.topic() ⇒ string

Get the room topic from room invitation

Kind: instance method of RoomInvitation
Example

const bot = new Wechaty()
bot.on('room-invite', async roomInvitation => {
  const topic = await roomInvitation.topic()
  console.log(`received room invitation event from room ${topic}`)
}
.start()

roomInvitation.date() ⇒ Promise.<Date>

Get the invitation time

Kind: instance method of RoomInvitation

roomInvitation.age() ⇒ number

Returns the roopm invitation age in seconds.

For example, the invitation is sent at time 8:43:01, and when we received it in Wechaty, the time is 8:43:15, then the age() will return 8:43:15 - 8:43:01 = 14 (seconds)

Kind: instance method of RoomInvitation

roomInvitation.toJSON() ⇒ string

Get the room invitation info when listened on room-invite event

Kind: instance method of RoomInvitation
Example

const bot = new Wechaty()
bot.on('room-invite', async roomInvitation => {
 const roomInvitation = bot.RoomInvitation.load(roomInvitation.id)
 const jsonData = await roomInvitation.toJSON(roomInvitation.id)
 // save the json data to disk, and we can use it by RoomInvitation.fromJSON()
}
.start()

RoomInvitation.fromJSON() ⇒ RoomInvitation

Load the room invitation info from disk

Kind: static method of RoomInvitation
Example

const bot = new Wechaty()
const dataFromDisk // get the room invitation info data from disk
const roomInvitation = await bot.RoomInvitation.fromJSON(dataFromDisk)
await roomInvitation.accept()

cuid_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

wechaty_puppet_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

events_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

events_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

clone_class_1

Wechaty Chatbot SDK - https://github.com/wechaty/wechaty

Kind: global constant
Copyright: 2016 Huan LI (李卓桓) https://github.com/huan, and Wechaty Contributors https://github.com/wechaty.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

guardWechatify()

Huan(202008): we will bind the wechaty puppet with user modules (Contact, Room, etc) together inside the start() method

Kind: global function

PuppetModuleName

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 XXXPuppet, for example:

• PuppetPuppeteer:
• PuppetPadchat

Kind: global typedef
Properties

Name	Type	Description
PUPPET_DEFAULT	string	The default puppet.
wechaty-puppet-wechat4u	string	The default puppet, using the wechat4u to control the WeChat Web API via a chrome browser.
wechaty-puppet-padchat	string	- Using the WebSocket protocol to connect with a Protocol Server for controlling the iPad WeChat program.
wechaty-puppet-puppeteer	string	- Using the google puppeteer to control the WeChat Web API via a chrome browser.
wechaty-puppet-mock	string	- Using the mock data to mock wechat operation, just for test.

WechatyOptions

The option parameter to create a wechaty instance

Kind: global typedef
Properties

Name	Type	Description
name	string	Wechaty Name. </br> When you set this: </br> new Wechaty({name: 'wechaty-name'}) </br> it will generate a file called wechaty-name.memory-card.json. </br> This file stores the login information for bot. </br> If the file is valid, the bot can auto login so you don’t need to scan the qrCode to login again. </br> Also, you can set the environment variable for WECHATY_NAME to set this value when you start. </br> eg: WECHATY_NAME="your-cute-bot-name" node bot.js
puppet	PuppetModuleName | Puppet	Puppet name or instance
puppetOptions	Partial.<PuppetOptions>	Puppet TOKEN
ioToken	string	Io TOKEN

RoomQueryFilter

The filter to find the room: {topic: string | RegExp}

Kind: global typedef
Properties

Name	Type
topic	string

RoomEventName

Room Class Event Type

Kind: global typedef
Properties

Name	Type	Description
join	string	Emit when anyone join any room.
topic	string	Get topic event, emitted when someone change room topic.
leave	string	Emit when anyone leave the room. If someone leaves the room by themselves, WeChat will not notice other people in the room, so the bot will never get the “leave” event.

RoomEventFunction

Room Class Event Function

Kind: global typedef
Properties

Name	Type	Description
room-join	function	(this: Room, inviteeList: Contact[] , inviter: Contact) => void
room-topic	function	(this: Room, topic: string, oldTopic: string, changer: Contact) => void
room-leave	function	(this: Room, leaver: Contact) => void

RoomMemberQueryFilter

The way to search member by Room.member()

Kind: global typedef
Properties

Name	Type	Description
name	string	Find the contact by WeChat name in a room, equal to Contact.name().
roomAlias	string	Find the contact by alias set by the bot for others in a room.
contactAlias	string	Find the contact by alias set by the contact out of a room, equal to Contact.alias(). More Detail

ContactQueryFilter

The way to search Contact

Kind: global typedef
Properties

Name	Type	Description
name	string	The name-string set by user-self, should be called name
alias	string	The name-string set by bot for others, should be called alias More Detail