Module model

Data structures used by operation inputs/outputs.

Modules

chat_identity_typing_status

See ChatIdentityTypingStatus

chat_message

See ChatMessage

chat_message_body_chat_create

See ChatMessageBodyChatCreate

chat_message_body_group_join

See ChatMessageBodyGroupJoin

chat_message_body_group_leave

See ChatMessageBodyGroupLeave

chat_message_body_identity_follow

See ChatMessageBodyIdentityFollow

chat_message_body_party_activity_change

See ChatMessageBodyPartyActivityChange

chat_message_body_party_invite

See ChatMessageBodyPartyInvite

chat_message_body_party_join

See ChatMessageBodyPartyJoin

chat_message_body_party_leave

See ChatMessageBodyPartyLeave

chat_message_body_text

See ChatMessageBodyText

chat_simple_topic_direct

See ChatSimpleTopicDirect

chat_simple_topic_group

See ChatSimpleTopicGroup

chat_simple_topic_party

See ChatSimpleTopicParty

game_handle

See GameHandle

identity_external_links

See IdentityExternalLinks

identity_game_activity

See IdentityGameActivity

identity_handle

See IdentityHandle

identity_presence

See IdentityPresence

party_activity_idle

See PartyActivityIdle

party_activity_matchmaker_finding_lobby

See PartyActivityMatchmakerFindingLobby

party_activity_matchmaker_lobby

See PartyActivityMatchmakerLobby

party_external_links

See PartyExternalLinks

party_handle

See PartyHandle

party_matchmaker_lobby

See PartyMatchmakerLobby

send_chat_topic_direct

See SendChatTopicDirect

send_chat_topic_group

See SendChatTopicGroup

send_chat_topic_party

See SendChatTopicParty

send_message_body_text

See SendMessageBodyText

unit

See Unit

watch_response

See WatchResponse

Structs

ChatIdentityTypingStatus

The chat typing status of an identity.

ChatMessage

A chat message.

ChatMessageBodyChatCreate

rivet.chat#ChatMessageBody variant for indicating a new chat was created.

ChatMessageBodyGroupJoin

rivet.chat#ChatMessageBody variant for indicating an identity joined the group.

ChatMessageBodyGroupLeave

rivet.chat#ChatMessageBody variant for indicating an identity left the group.

ChatMessageBodyIdentityFollow

rivet.chat#ChatMessageBody variant for indicating an identity followed the identity.

ChatMessageBodyPartyActivityChange

rivet.chat#ChatMessageBody variant for indicating a change in the party’s current activity.

ChatMessageBodyPartyInvite

rivet.chat#ChatMessageBody variant holding an a party invitation.

ChatMessageBodyPartyJoin

rivet.chat#ChatMessageBody variant for indicating an identity joined the party.

ChatMessageBodyPartyLeave

rivet.chat#ChatMessageBody variant for indicating an identity left the party.

ChatMessageBodyText

rivet.chat#ChatMessageBody variant for text messages. Sent by other identities using the chat interface.

ChatSimpleTopicDirect

rivet.chat#ChatSimpleTopic variant for direct (identity to identity) chats.

ChatSimpleTopicGroup

rivet.chat#ChatSimpleTopic variant for groups.

ChatSimpleTopicParty

rivet.chat#ChatSimpleTopic variant for parties.

GameHandle

A game handle.

IdentityExternalLinks

External links for an identity.

IdentityGameActivity

The game an identity is currently participating in.

IdentityHandle

An identity handle.

IdentityPresence

Information about the identity’s current status, party, and active game.

PartyActivityIdle

A party activity denoting that the party is idle.

PartyActivityMatchmakerFindingLobby

A party activity denoting that the party is currently searching for a lobby.

PartyActivityMatchmakerLobby

A party activity denoting that the party is currently in a lobby.

PartyExternalLinks

External links for a party.

PartyHandle

A party handle.

PartyMatchmakerLobby

A party lobby.

SendChatTopicDirect

rivet.api.chat.common#SendChatTopic variant for direct messages.

SendChatTopicGroup

rivet.api.chat.common#SendChatTopic variant for groups.

SendChatTopicParty

rivet.api.chat.common#SendChatTopic variant for parties.

SendMessageBodyText

rivet.api.chat.common#SendMessageBody variant for text messages.

Unit

WatchResponse

Provided by watchable endpoints used in blocking loops.

Enums

ChatMessageBody

Represents types of chat message bodies.

ChatSimpleTopic

Represents a topic of the given chat thread without the associated handles for the topic.

ChatTypingStatus

Represents a chat typing status.

IdentityStatus

The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.

PartyActivity

A union representing the activity of a given party.

QueryDirection

Represents which direction to query messages from relative to the given timestamp.

SendChatTopic

Topic to send a chat message to. If you already know the thread ID, use thread_id.

SendMessageBody

Data to send in a chat message.