`cg:status.user` - User Status Update¶

This packet is used to request and retrieve user information and status updates.

Purpose¶

Using this packet, the client can request information about a specific user from the server. The server determines what information to send.

Additionally, the server may send this packet at any to preempt information requests or notify the client of changes to a users appearance.

Note that all examples shown here contain placeholder data and will have different content in actual packets.

This is the data sent by the client to the server to request information on a user:

{
   "username": "notna",

   "uuid": "61cf5d06-8d01-4fb3-a4a8-ea7a0633b0b8",
}

username is the name of the user that the client wants information on.

uuid is the UUID that the client wants more information on.

Note

uuid and username are not exclusive, but uuid will be used preferentially before username.

The server sends user status updates in the following format, either as a response to a request or as a notification:

{
   "username": "notna",
   "uuid": "cfde3788-e653-4ef3-8b19-f741e2194e0f",

   "status": "logged_in",
   ...
}

status is the current status of the user. This may be one of online, away, busy, offline or notexist if the user could not be found.

Note

If status is notexist, all other fields will not be populated.

username is the user name to be displayed for the given user.

uuid is the UUID of the given user.

Todo

Add more user attributes here.