Determines the content of an event.
Sometimes, your user will be invited to a new room! This module offers you a few simple handles to deal with such invites - you can accept them, reject them or inspect them for further information.
Accept the invite. As a result, the user joins the room.
Reject the invite. As a result, the room is informed that the user has decided not to join. If the room is private, the user can no longer join until they receive a new invite.
Sometimes, you may want to display information about the room.
Be careful though, anyone can invite you to any room! This means that room invites may contain offensive, shocking or other unwanted content that the user may not want to see.
Get the room id of the room that the user is invited to.
An InviteEvent is a state event that indicates the room's state.
This InviteEvent is more limited than the standard Event. It exclusively provides the information that is considered relevant for the invitation.
Get a specific state event. This allows you to generate a previes of the room. Do keep in mind that most servers do not give ALL state events, so you might not have access to some state events.
Get a list of all shared state events in the invite.
Once you have the event you want, you can explore it with the following functions.
Determines the user that has originally sent this event.
Determines the state key of a state event.
Determines the content of a state event.
Determines the content of an event.
Invitation to a given room. This type represents contains all available information about the room.