Module rivet_identity::model
source · [−]Expand description
Data structures used by operation inputs/outputs.
Modules
Structs
A chat message.
rivet.chat#ChatMessageBody variant for indicating a new chat was created.
rivet.chat#ChatMessageBody variant for indicating an identity joined the group.
rivet.chat#ChatMessageBody variant for indicating an identity left the group.
rivet.chat#ChatMessageBody variant for indicating an identity followed the identity.
rivet.chat#ChatMessageBody variant for indicating a change in the party’s current activity.
rivet.chat#ChatMessageBody variant holding an a party invitation.
rivet.chat#ChatMessageBody variant for indicating an identity joined the party.
rivet.chat#ChatMessageBody variant for indicating an identity requesting to join your party.
rivet.chat#ChatMessageBody variant for indicating an identity left the party.
rivet.chat#ChatMessageBody variant for text messages. Sent by other identities using the chat interface.
A chat thread.
External links for a chat thread.
rivet.chat#ChatTopic variant for direct (identity to identity) chats.
rivet.chat#ChatTopic variant for groups.
rivet.chat#ChatTopic variant for parties.
A game handle.
A game statistic.
A game statistic config.
A game statistic summary.
An event relevant to the current identity.
rivet.api.identity.common#GlobalEventKind variant for chat messages. Received any time a message is sent to a chat the identity is in.
rivet.api.identity.common#GlobalEventKind variant for chat reads. Received any time the last read timestamp is set. Used to update the status of unread indicators on chats.
rivet.api.identity.common#GlobalEventKind variant for party updates. Received when the identity should be instructed to join a lobby. This needs to be implemented in conjunction with parties in order to force clients to join the same lobby as the party they’re in.
Notifications represent information that should be presented to the user immediately. At the moment, only chat message events have associated notifications. # Display Notifications should be displayed in an unobtrusive manner throughout the entire game. Notifications should disappear after a few seconds if not interacted with. # Interactions If your platform supports it, notifications should be able to be clicked or tapped in order to open the relevant context for the event. For a simple implementation of notification interactions, open url in a web browser to present the relevant context. For example, a chat message notification will open the thread the chat message was sent in. For advanced implementations that implement a custom chat UI, use rivet.api.identity.common#GlobalEvent$kind to determine what action to take when the notification is interacted with. For example, if the global event kind is rivet.api.identity.common#GlobalEventChatMessage, then open the chat UI for the given thread.
rivet.api.identity.common#GlobalEventKind variant for party updates. Received any time the identity joins a party, a party is updated, or when the identity leaves a party.
External links for this group.
A group handle.
An identity’s linked email.
External links for an identity.
The game an identity is currently participating in.
A group that the given identity.
An identity handle.
Information about the identity’s current status, party, and active game.
An identity profile.
A matchmaker lobby.
A matchmaker lobby player.
A matchmaker lobby port. Configured by rivet.cloud#LobbyGroupRuntimeDockerPort$label.
A matchmaker lobby region.
A party activity denoting that the party is idle.
A party activity denoting that the party is currently searching for a lobby.
A party activity denoting that the party is currently in a lobby.
External links for a party.
A party handle.
A party lobby.
A party member state denoting that the member is idle.
A party member state denoting that the member is currently searching for a lobby.
A party member state denoting that the member is in a lobby.
A party member state denoting that the member is currently waiting to start matchmaking.
A party member summary.
A party summary.
Information about the identity’s current game. This is information that all other identities can see about what the current identity is doing.
A presigned request used to upload files. Upload your file to the given URL via a PUT request.
An error given by failed content validation.
Provided by watchable endpoints used in blocking loops.
Enums
Represents types of chat message bodies.
Represents the topic of the given chat thread.
The link status between an identity and a game user.
A value denoting the aggregation method of a game statistic.
A value denoting the format method of a game statistic.
A value denoting the sorting method of a game statistic.
Kind of event that occured.
The state of the given identity’s developer status.
A union representing an identity’s linked accounts.
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
A union representing the activity of a given party.
A union representing the current state of a party member.