Skip to main content

Friendship

Send, receive friend request, and friend confirmation events.

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.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 bot.Friendship.Type.Receive:
await friendship.accept()
break
// 2. Friend Ship Confirmed
case bot.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() === bot.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', 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
  • FriendshipType.Confirm
  • FriendshipType.Receive
  • FriendshipType.Verify

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() === bot.Friendship.Type.Receive && friendship.hello() === 'ding') {
await friendship.accept()
}
} catch (e) {
console.error(e)
}
}
.start()

Friendship.send()#

Deprecated

use Friendship#add instead

Kind: static method of Friendship

Friendship.add(contact, hello) โ‡’ 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

ParamTypeDescription
contactContactSend friend request to contact
hellostringThe friend request content

Example#

const memberList = await room.memberList()
for (let i = 0; i < memberList.length; i++) {
await bot.Friendship.add(member, 'Nice to meet you! I am wechaty bot!')
}
Last updated on by Huan