package nakama.realtime

Get desktop application:
View/edit binary Protocol Buffers messages

A realtime chat channel.

Used in: Envelope

• string id = 1

  The ID of the channel.

• repeated UserPresence presences = 2

  The users currently in the channel.

• optional UserPresence self = 3

  A reference to the current user's presence in the channel.

• string room_name = 4

  The name of the chat room, or an empty string if this message was not sent through a chat room.

• string group_id = 5

  The ID of the group, or an empty string if this message was not sent through a group channel.

• string user_id_one = 6

  The ID of the first DM user, or an empty string if this message was not sent through a DM chat.

• string user_id_two = 7

  The ID of the second DM user, or an empty string if this message was not sent through a DM chat.

Join operation for a realtime chat channel.

Used in: Envelope

• string target = 1

  The user ID to DM with, group ID to chat with, or room channel name to join.

• int32 type = 2

  The type of the chat channel.

  one of "ChannelId.Type".

• optional google.protobuf.BoolValue persistence = 3

  Whether messages sent on this channel should be persistent.

• optional google.protobuf.BoolValue hidden = 4

  Whether the user should appear in the channel's presence list and events.

The type of chat channel.

• TYPE_UNSPECIFIED = 0

  Default case. Assumed as ROOM type.

• ROOM = 1

  A room which anyone can join to chat.

• DIRECT_MESSAGE = 2

  A private channel for 1-on-1 chat.

• GROUP = 3

  A channel for group chat.

Leave a realtime channel.

Used in: Envelope

• string channel_id = 1

  The ID of the channel to leave.

A receipt reply from a channel message send operation.

Used in: Envelope

• string channel_id = 1

  The channel the message was sent to.

• string message_id = 2

  The unique ID assigned to the message.

• optional google.protobuf.Int32Value code = 3

  The code representing a message type or category.

• string username = 4

  Username of the message sender.

• optional google.protobuf.Timestamp create_time = 5

  The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.

• optional google.protobuf.Timestamp update_time = 6

  The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.

• optional google.protobuf.BoolValue persistent = 7

  True if the message was persisted to the channel's history, false otherwise.

• string room_name = 8

  The name of the chat room, or an empty string if this message was not sent through a chat room.

• string group_id = 9

  The ID of the group, or an empty string if this message was not sent through a group channel.

• string user_id_one = 10

  The ID of the first DM user, or an empty string if this message was not sent through a DM chat.

• string user_id_two = 11

  The ID of the second DM user, or an empty string if this message was not sent through a DM chat.

Remove a message previously sent to a realtime channel.

Used in: Envelope

• string channel_id = 1

  The channel the message was sent to.

• string message_id = 2

  The ID assigned to the message to update.

Send a message to a realtime channel.

Used in: Envelope

• string channel_id = 1

  The channel to sent to.

• string content = 2

  Message content.

Update a message previously sent to a realtime channel.

Used in: Envelope

• string channel_id = 1

  The channel the message was sent to.

• string message_id = 2

  The ID assigned to the message to update.

• string content = 3

  New message content.

A set of joins and leaves on a particular channel.

Used in: Envelope

• string channel_id = 1

  The channel identifier this event is for.

• repeated UserPresence joins = 2

  Presences joining the channel as part of this event, if any.

• repeated UserPresence leaves = 3

  Presences leaving the channel as part of this event, if any.

• string room_name = 4

  The name of the chat room, or an empty string if this message was not sent through a chat room.

• string group_id = 5

  The ID of the group, or an empty string if this message was not sent through a group channel.

• string user_id_one = 6

  The ID of the first DM user, or an empty string if this message was not sent through a DM chat.

• string user_id_two = 7

  The ID of the second DM user, or an empty string if this message was not sent through a DM chat.

An envelope for a realtime message.

• string cid = 1

• oneof message

  • Channel channel = 2

    A response from a channel join operation.

  • ChannelJoin channel_join = 3

    Join a realtime chat channel.

  • ChannelLeave channel_leave = 4

    Leave a realtime chat channel.

  • api.ChannelMessage channel_message = 5

    An incoming message on a realtime chat channel.

  • ChannelMessageAck channel_message_ack = 6

    An acknowledgement received in response to sending a message on a chat channel.

  • ChannelMessageSend channel_message_send = 7

    Send a message to a realtime chat channel.

  • ChannelMessageUpdate channel_message_update = 8

    Update a message previously sent to a realtime chat channel.

  • ChannelMessageRemove channel_message_remove = 9

    Remove a message previously sent to a realtime chat channel.

  • ChannelPresenceEvent channel_presence_event = 10

    Presence update for a particular realtime chat channel.

  • Error error = 11

    Describes an error which occurred on the server.

  • Match match = 12

    Incoming information about a realtime match.

  • MatchCreate match_create = 13

    A client to server request to create a realtime match.

  • MatchData match_data = 14

    Incoming realtime match data delivered from the server.

  • MatchDataSend match_data_send = 15

    A client to server request to send data to a realtime match.

  • MatchJoin match_join = 16

    A client to server request to join a realtime match.

  • MatchLeave match_leave = 17

    A client to server request to leave a realtime match.

  • MatchPresenceEvent match_presence_event = 18

    Presence update for a particular realtime match.

  • MatchmakerAdd matchmaker_add = 19

    Submit a new matchmaking process request.

  • MatchmakerMatched matchmaker_matched = 20

    A successful matchmaking result.

  • MatchmakerRemove matchmaker_remove = 21

    Cancel a matchmaking process using a ticket.

  • MatchmakerTicket matchmaker_ticket = 22

    A response from starting a new matchmaking process.

  • Notifications notifications = 23

    Notifications send by the server.

  • api.Rpc rpc = 24

    RPC call or response.

  • Status status = 25

    An incoming status snapshot for some set of users.

  • StatusFollow status_follow = 26

    Start following some set of users to receive their status updates.

  • StatusPresenceEvent status_presence_event = 27

    An incoming status update.

  • StatusUnfollow status_unfollow = 28

    Stop following some set of users to no longer receive their status updates.

  • StatusUpdate status_update = 29

    Set the user's own status.

  • StreamData stream_data = 30

    A data message delivered over a stream.

  • StreamPresenceEvent stream_presence_event = 31

    Presence update for a particular stream.

  • Ping ping = 32

    Application-level heartbeat and connection check.

  • Pong pong = 33

    Application-level heartbeat and connection check response.

  • Party party = 34

    Incoming information about a party.

  • PartyCreate party_create = 35

    Create a party.

  • PartyJoin party_join = 36

    Join a party, or request to join if the party is not open.

  • PartyLeave party_leave = 37

    Leave a party.

  • PartyPromote party_promote = 38

    Promote a new party leader.

  • PartyLeader party_leader = 39

    Announcement of a new party leader.

  • PartyAccept party_accept = 40

    Accept a request to join.

  • PartyRemove party_remove = 41

    Kick a party member, or decline a request to join.

  • PartyClose party_close = 42

    End a party, kicking all party members and closing it.

  • PartyJoinRequestList party_join_request_list = 43

    Request a list of pending join requests for a party.

  • PartyJoinRequest party_join_request = 44

    Incoming notification for one or more new presences attempting to join the party.

  • PartyMatchmakerAdd party_matchmaker_add = 45

    Begin matchmaking as a party.

  • PartyMatchmakerRemove party_matchmaker_remove = 46

    Cancel a party matchmaking process using a ticket.

  • PartyMatchmakerTicket party_matchmaker_ticket = 47

    A response from starting a new party matchmaking process.

  • PartyData party_data = 48

    Incoming party data delivered from the server.

  • PartyDataSend party_data_send = 49

    A client to server request to send data to a party.

  • PartyPresenceEvent party_presence_event = 50

    Presence update for a particular party.

  • PartyUpdate party_update = 51

    Update Party label and whether it's open or closed.

A logical error which may occur on the server.

Used in: Envelope

• int32 code = 1

  The error code which should be one of "Error.Code" enums.

• string message = 2

  A message in English to help developers debug the response.

• map<string, string> context = 3

  Additional error details which may be different for each response.

The selection of possible error codes.

• RUNTIME_EXCEPTION = 0

  An unexpected result from the server.

• UNRECOGNIZED_PAYLOAD = 1

  The server received a message which is not recognised.

• MISSING_PAYLOAD = 2

  A message was expected but contains no content.

• BAD_INPUT = 3

  Fields in the message have an invalid format.

• MATCH_NOT_FOUND = 4

  The match id was not found.

• MATCH_JOIN_REJECTED = 5

  The match join was rejected.

• RUNTIME_FUNCTION_NOT_FOUND = 6

  The runtime function does not exist on the server.

• RUNTIME_FUNCTION_EXCEPTION = 7

  The runtime function executed with an error.

A realtime match.

Used in: Envelope

• string match_id = 1

  The match unique ID.

• bool authoritative = 2

  True if it's an server-managed authoritative match, false otherwise.

• optional google.protobuf.StringValue label = 3

  Match label, if any.

• int32 size = 4

  The number of users currently in the match.

• repeated UserPresence presences = 5

  The users currently in the match.

• optional UserPresence self = 6

  A reference to the current user's presence in the match.

Create a new realtime match.

Used in: Envelope

• string name = 1

  Optional name to use when creating the match.

Realtime match data received from the server.

Used in: Envelope

• string match_id = 1

  The match unique ID.

• optional UserPresence presence = 2

  A reference to the user presence that sent this data, if any.

• int64 op_code = 3

  Op code value.

• bytes data = 4

  Data payload, if any.

• bool reliable = 5

  True if this data was delivered reliably, false otherwise.

Send realtime match data to the server.

Used in: Envelope

• string match_id = 1

  The match unique ID.

• int64 op_code = 2

  Op code value.

• bytes data = 3

  Data payload, if any.

• repeated UserPresence presences = 4

  List of presences in the match to deliver to, if filtering is required. Otherwise deliver to everyone in the match.

• bool reliable = 5

  True if the data should be sent reliably, false otherwise.

Join an existing realtime match.

Used in: Envelope

• oneof id

  • string match_id = 1

    The match unique ID.

  • string token = 2

    A matchmaking result token.

• map<string, string> metadata = 3

  An optional set of key-value metadata pairs to be passed to the match handler, if any.

Leave a realtime match.

Used in: Envelope

• string match_id = 1

  The match unique ID.

A set of joins and leaves on a particular realtime match.

Used in: Envelope

• string match_id = 1

  The match unique ID.

• repeated UserPresence joins = 2

  User presences that have just joined the match.

• repeated UserPresence leaves = 3

  User presences that have just left the match.

Start a new matchmaking process.

Used in: Envelope

• int32 min_count = 1

  Minimum total user count to match together.

• int32 max_count = 2

  Maximum total user count to match together.

• string query = 3

  Filter query used to identify suitable users.

• map<string, string> string_properties = 4

  String properties.

• map<string, double> numeric_properties = 5

  Numeric properties.

• optional google.protobuf.Int32Value count_multiple = 6

  Optional multiple of the count that must be satisfied.

A successful matchmaking result.

Used in: Envelope

• string ticket = 1

  The matchmaking ticket that has completed.

• oneof id

  The match token or match ID to join.

  • string match_id = 2

    Match ID.

  • string token = 3

    Match join token.

• repeated MatchmakerMatched.MatchmakerUser users = 4

  The users that have been matched together, and information about their matchmaking data.

• optional MatchmakerMatched.MatchmakerUser self = 5

  A reference to the current user and their properties.

Used in: MatchmakerMatched

• optional UserPresence presence = 1

  User info.

• string party_id = 2

  Party identifier, if this user was matched as a party member.

• map<string, string> string_properties = 5

  String properties.

• map<string, double> numeric_properties = 6

  Numeric properties.

Cancel an existing ongoing matchmaking process.

Used in: Envelope

• string ticket = 1

  The ticket to cancel.

A ticket representing a new matchmaking process.

Used in: Envelope

• string ticket = 1

  The ticket that can be used to cancel matchmaking.

A collection of zero or more notifications.

Used in: Envelope

• repeated api.Notification notifications = 1

  Collection of notifications.

Incoming information about a party.

Used in: Envelope

• string party_id = 1

  Unique party identifier.

• bool open = 2

  Open flag.

• bool hidden = 3

  Hidden flag.

• int32 max_size = 4

  Maximum number of party members.

• optional UserPresence self = 5

  Self.

• optional UserPresence leader = 6

  Leader.

• repeated UserPresence presences = 7

  All current party members.

• string label = 8

  Label for party listing.

Accept a request to join.

Used in: Envelope

• string party_id = 1

  Party ID to accept a join request for.

• optional UserPresence presence = 2

  The presence to accept as a party member.

End a party, kicking all party members and closing it.

Used in: Envelope

• string party_id = 1

  Party ID to close.

Create a party.

Used in: Envelope

• bool open = 1

  Whether or not the party will require join requests to be approved by the party leader.

• int32 max_size = 2

  Maximum number of party members.

• string label = 3

  Label

• bool hidden = 4

  Whether the party is visible in party listings.

Incoming party data delivered from the server.

Used in: Envelope

• string party_id = 1

  The party ID.

• optional UserPresence presence = 2

  A reference to the user presence that sent this data, if any.

• int64 op_code = 3

  Op code value.

• bytes data = 4

  Data payload, if any.

Send data to a party.

Used in: Envelope

• string party_id = 1

  Party ID to send to.

• int64 op_code = 2

  Op code value.

• bytes data = 3

  Data payload, if any.

Join a party, or request to join if the party is not open.

Used in: Envelope

• string party_id = 1

  Party ID to join.

Incoming notification for one or more new presences attempting to join the party.

Used in: Envelope

• string party_id = 1

  Party ID these presences are attempting to join.

• repeated UserPresence presences = 2

  Presences attempting to join.

Request a list of pending join requests for a party.

Used in: Envelope

• string party_id = 1

  Party ID to get a list of join requests for.

Announcement of a new party leader.

Used in: Envelope

• string party_id = 1

  Party ID to announce the new leader for.

• optional UserPresence presence = 2

  The presence of the new party leader.

Leave a party.

Used in: Envelope

• string party_id = 1

  Party ID to leave.

Begin matchmaking as a party.

Used in: Envelope

• string party_id = 1

  Party ID.

• int32 min_count = 2

  Minimum total user count to match together.

• int32 max_count = 3

  Maximum total user count to match together.

• string query = 4

  Filter query used to identify suitable users.

• map<string, string> string_properties = 5

  String properties.

• map<string, double> numeric_properties = 6

  Numeric properties.

• optional google.protobuf.Int32Value count_multiple = 7

  Optional multiple of the count that must be satisfied.

Cancel a party matchmaking process using a ticket.

Used in: Envelope

• string party_id = 1

  Party ID.

• string ticket = 2

  The ticket to cancel.

A response from starting a new party matchmaking process.

Used in: Envelope

• string party_id = 1

  Party ID.

• string ticket = 2

  The ticket that can be used to cancel matchmaking.

Presence update for a particular party.

Used in: Envelope

• string party_id = 1

  The party ID.

• repeated UserPresence joins = 2

  User presences that have just joined the party.

• repeated UserPresence leaves = 3

  User presences that have just left the party.

Promote a new party leader.

Used in: Envelope

• string party_id = 1

  Party ID to promote a new leader for.

• optional UserPresence presence = 2

  The presence of an existing party member to promote as the new leader.

Kick a party member, or decline a request to join.

Used in: Envelope

• string party_id = 1

  Party ID to remove/reject from.

• optional UserPresence presence = 2

  The presence to remove or reject.

Update a party label.

Used in: Envelope

• string party_id = 1

  Party ID.

• string label = 2

  Label to set.

• bool open = 3

  Change the party to open or closed.

• bool hidden = 4

  Whether the party is visible in party listings.

Application-level heartbeat and connection check.

Used in: Envelope

(message has no fields)

Application-level heartbeat and connection check response.

Used in: Envelope

(message has no fields)

A snapshot of statuses for some set of users.

Used in: Envelope

• repeated UserPresence presences = 1

  User statuses.

Start receiving status updates for some set of users.

Used in: Envelope

• repeated string user_ids = 1

  User IDs to follow.

• repeated string usernames = 2

  Usernames to follow.

A batch of status updates for a given user.

Used in: Envelope

• repeated UserPresence joins = 2

  New statuses for the user.

• repeated UserPresence leaves = 3

  Previous statuses for the user.

Stop receiving status updates for some set of users.

Used in: Envelope

• repeated string user_ids = 1

  Users to unfollow.

Set the user's own status.

Used in: Envelope

• optional google.protobuf.StringValue status = 1

  Status string to set, if not present the user will appear offline.

Represents identifying information for a stream.

Used in: StreamData, StreamPresenceEvent

• int32 mode = 1

  Mode identifies the type of stream.

• string subject = 2

  Subject is the primary identifier, if any.

• string subcontext = 3

  Subcontext is a secondary identifier, if any.

• string label = 4

  The label is an arbitrary identifying string, if the stream has one.

A data message delivered over a stream.

Used in: Envelope

• optional Stream stream = 1

  The stream this data message relates to.

• optional UserPresence sender = 2

  The sender, if any.

• string data = 3

  Arbitrary contents of the data message.

• bool reliable = 4

  True if this data was delivered reliably, false otherwise.

A set of joins and leaves on a particular stream.

Used in: Envelope

• optional Stream stream = 1

  The stream this event relates to.

• repeated UserPresence joins = 2

  Presences joining the stream as part of this event, if any.

• repeated UserPresence leaves = 3

  Presences leaving the stream as part of this event, if any.

A user session associated to a stream, usually through a list operation or a join/leave event.

Used in: Channel, ChannelPresenceEvent, Match, MatchData, MatchDataSend, MatchPresenceEvent, MatchmakerMatched.MatchmakerUser, Party, PartyAccept, PartyData, PartyJoinRequest, PartyLeader, PartyPresenceEvent, PartyPromote, PartyRemove, Status, StatusPresenceEvent, StreamData, StreamPresenceEvent

• string user_id = 1

  The user this presence belongs to.

• string session_id = 2

  A unique session ID identifying the particular connection, because the user may have many.

• string username = 3

  The username for display purposes.

• bool persistence = 4

  Whether this presence generates persistent data/messages, if applicable for the stream type.

• optional google.protobuf.StringValue status = 5

  A user-set status message for this stream, if applicable.