Room Updated

This notification is sent when a room is updated.

Sent JSON includes the following:

JSON Key

Type

Description

roomId

Number

Room ID

node

Object

Sender node information

  • uid

String

Node UID

  • host

String

Host

  • port

Number

Port

  • protocol

String

Protocol

  • type

Number

Node type

  • properties

Object

Custom property map containing any key-value pairs

  • internalProperties

Object

Custom property map containing any key-value pairs for inter-server processing

updatedProperties

Object

Updated property in the room information

  • primaryKey

Number

Room ID

  • ownerUid

String

Room owner UID

  • name

String

Room name

  • capacity

Number

Max number of players who can join the room

  • memberCount

Number

Number of current room members

  • password

String

Room password

  • state

Number

Room state

  • isJoinable

Boolean

Flag whether the room is joinable

  • key1

Number

Custom search key 1

  • key2

Number

Custom search key 2

  • key3

Number

Custom search key 3

  • key4

Number

Custom search key 4

  • key5

Number

Custom search key 5

  • key6

Number

Custom search key 6

  • key7

Number

Custom search key 7

  • key8

Number

Custom search key 8

  • stringKey

String

Custom string search key

  • properties

Object

Custom property map containing any key-value pairs

Example JSON

{
    "roomId": 2,
    "node": {
        "uid": "[ServerUID:1]",
        "host": "192.0.2.100",
        "port": 9123,
        "protocol": "TCP",
        "type": 1,
        "properties": {},
        "internalProperties": {}
    },
    "updatedProperties": {
        "primaryKey": 2,
        "ownerUid": "[ChildUID:1-3]",
        "name": "New Room",
        "capacity": 4,
        "memberCount": 2,
        "password": null,
        "state": 0,
        "isJoinable": true,
        "key1": 1.100000023841858,
        "key2": 2.200000047683716,
        "key3": 3.299999952316284,
        "key4": 4.400000095367432,
        "key5": 5.5,
        "key6": 6.599999904632568,
        "key7": 7.699999809265137,
        "key8": 8.800000190734863,
        "stringKey": "asdf",
        "properties": {
            "foo": "bar",
            "x": 1.3,
            "rank": 10
        }
    }
}