When

eventStarts()

Be notified when the event starts.
The callback is not called if the user joins the event after the start.

usage:

When.eventStarts(() => {
 // do something
})

eventEnds()

Be notified when the event ends.
The callback is not called if the user joins the event after the end.

usage:

When.eventEnds(() => {
 // do something
})

userJoins()

Be notified when someone joins the event.
The callback is not called if the user joins the event after the end.

usage:

When.userJoins((user) => {
 // do something with the 'user' object
})

userLeaves()

Be notified when someone leaves the event.
The callback is not called if the user leaves the event after the end.

usage:

When.userLeaves((user) => {
 // do something with the 'user' object
})

currentUserMutesNotifications()

Be notified when the current user mutes/unmutes the notifications.

usage:

When.currentUserMutesNotifications( ({ muted }) => {
  // do something such as disable notifications of the plugin if muted
 })