Friendship
Send, receive friend request, and friend confirmation events.
send request
receive request(in friend event)
confirmation friendship(friend event)
Kind: global class
instance
.accept() ⇒
Promise..hello() ⇒
string.contact() ⇒
Contact.type() ⇒
FriendshipType
static
.send().add(contact, hello) ⇒
Promise.
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 Requestcase Friendship.Type.Receive:await friendship.accept()break// 2. Friend Ship Confirmedcase Friendship.Type.Confirm:console.log(`friend ship confirmed`)break}} catch (e) {console.error(e)}}.start()
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()
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()
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()
Deprecated
use Friendship#add instead
Kind: static method of Friendship
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 |
| Send friend request to contact |
hello |
| The 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!')}