> For the complete documentation index, see [llms.txt](https://wechaty.gitbook.io/wechaty/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wechaty.gitbook.io/wechaty/api/room-invitation.md).

# RoomInvitation

## RoomInvitation

accept room invitation

**Kind**: global class

* [RoomInvitation](/wechaty/api/room-invitation.md#RoomInvitation)
  * [.accept()](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+accept) ⇒ `Promise <void>`
  * [.inviter()](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+inviter) ⇒ `Promise <Contact>`
  * [.topic()](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+topic) ⇒ `Promise <string>`
  * [~~.roomTopic()~~](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+roomTopic) ⇒ `Promise <string>`
  * [.date()](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+date) ⇒ `Promise <Date>`
  * [.age()](https://wechaty.gitbook.io/wechaty/api/pages/-Lv6cE5M-bYIAAcxUxIM#RoomInvitation+age) ⇒ `Promise <number>`

### roomInvitation.accept() ⇒ `Promise <void>`

Accept Room Invitation

**Kind**: instance method of [`RoomInvitation`](/wechaty/api/room-invitation.md#RoomInvitation)\
**Example**

```javascript
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() ⇒ `Promise <Contact>`

Get the inviter from room invitation

**Kind**: instance method of [`RoomInvitation`](/wechaty/api/room-invitation.md#RoomInvitation)\
**Example**

```javascript
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() ⇒ `Promise <string>`

Get the room topic from room invitation

**Kind**: instance method of [`RoomInvitation`](/wechaty/api/room-invitation.md#RoomInvitation)\
**Example**

```javascript
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.roomTopic()~~

**Kind**: instance method of [`RoomInvitation`](/wechaty/api/room-invitation.md#RoomInvitation)\
**Deprecated:**: use topic() instead

### roomInvitation.date() ⇒ `Promise <Date>`

Get the invitation time

**Kind**: instance method of [`RoomInvitation`](/wechaty/api/room-invitation.md#RoomInvitation)

### roomInvitation.age() ⇒ `Promise <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`](/wechaty/api/room-invitation.md#RoomInvitation)