Skip to main content

Navigator

C→S 249 - NavigatorSearch

Nitro: NAVIGATOR_SEARCH

Source: RequestNewNavigatorRoomsEvent, NavigatorSearchComposer

Used by the new navigator. Arcturus RequestNewNavigatorRoomsEvent reads view:string and query:string. The code/data map 1-to-1 to view/query.

Bodu:
code: string Search category / view code (e.g. "hotel_view", "query", "my", "favorites")
data: string Search query text (empty string for category views)

C→S 2110 - RequestNewNavigatorData

Nitro: NAVIGATOR_INIT

Source: RequestNewNavigatorDataEvent, NavigatorInitComposer

Requests the full navigator initialisation payload from the server; triggers a burst of messages covering metadata, event categories, saved searches, collapsed categories, lifted rooms, and settings.

FieldTypeNotes
(empty)-No body fields read

C→S 3943 - SearchRooms (legacy text search)

Nitro: ROOM_TEXT_SEARCH

Source: SearchRoomsEvent, RoomTextSearchMessageComposer

Searches for rooms by name or category prefix using the legacy text search. Sends a single query string; the server returns matching rooms.

Body: (empty)

C→S 3027 - RequestRoomCategories

Nitro: GET_USER_FLAT_CATS

Source: RequestRoomCategoriesEvent, GetUserFlatCatsMessageComposer

Requests the list of navigator room categories (legacy "flat cats") from the server. No parameters; the server responds with S→C 1562 RoomCategories.

Body:

C→S 2758 - RequestPopularRooms

Nitro: POPULAR_ROOMS_SEARCH

Source: RequestPopularRoomsEvent, PopularRoomsSearchMessageComposer

Requests the current list of popular rooms for the navigator's popular rooms view. No parameters.

Body: (empty)

C→S 1229 - RequestPublicRooms

Nitro: GET_OFFICIAL_ROOMS

Source: RequestPublicRoomsEvent, GetOfficialRoomsMessageComposer

Requests the list of official/public rooms for the navigator. No parameters.

Body: (empty)

C→S 2939 - RequestHighestScoreRooms

Nitro: ROOMS_WITH_HIGHEST_SCORE_SEARCH

Source: RequestHighestScoreRoomsEvent, RoomsWithHighestScoreSearchMessageComposer

Requests the list of rooms sorted by highest score for the navigator's top-rated view. No parameters.

Body: (empty)

C→S 3782 - GetCategoriesWithUserCount

Nitro: GET_CATEGORIES_WITH_USER_COUNT Note: No Arcturus handler - Nitro only. Source: GetCategoriesWithUserCountMessageComposer

Requests the list of navigator categories with their current user counts. No parameters.

Body: (empty)

C→S 2277 - RequestMyRooms

Nitro: MY_ROOMS_SEARCH

Source: RequestMyRoomsEvent, MyRoomsSearchMessageComposer

Requests the list of rooms owned by the current user for the navigator's My Rooms view. No parameters.

Body: (empty)

C→S 272 - SearchRoomsWithRights

Nitro: MY_ROOM_RIGHTS_SEARCH

Source: SearchRoomsWithRightsEvent, MyRoomRightsSearchMessageComposer

Requests the list of rooms where the current user has been granted room rights. No parameters.

Body: (empty)

C→S 1002 - MyFrequentRoomHistorySearch

Nitro: MY_FREQUENT_ROOM_HISTORY_SEARCH Note: No Arcturus handler - Nitro only. Source: MyFrequentRoomHistorySearchMessageComposer

Requests the user's most frequently visited rooms. Nitro-only; no Arcturus handler.

Body: (empty)

C→S 2578 - SearchRoomsFriendsNow (friends currently in rooms)

Nitro: MY_FAVOURITE_ROOMS_SEARCH

Source: SearchRoomsMyFavouriteEvent, MyFavouriteRoomsSearchMessageComposer

Requests the user's favorite rooms list for the navigator. Despite the Nitro constant MY_FAVOURITE_ROOMS_SEARCH, this maps to SearchRoomsMyFavouriteEvent in Arcturus - the favourites view, not the friends-in-rooms view.

Body: (empty)

C→S 1786 - SearchRoomsFriendsNow

Nitro: ROOMS_WHERE_MY_FRIENDS_ARE

Source: SearchRoomsFriendsNowEvent, RoomsWhereMyFriendsAreSearchMessageComposer

Requests the list of rooms where the user's friends are currently present. No parameters.

FieldTypeNotes
(empty)-No body fields read

C→S 2266 - SearchRoomsFriendsOwn

Nitro: MY_FRIENDS_ROOM_SEARCH - Friends own→MY_FRIENDS. Source: SearchRoomsFriendsOwnEvent, MyFriendsRoomsSearchMessageComposer

Requests the list of rooms owned by friends of the current user.

Body: (empty)

C→S 2264 - SearchRoomsVisited

Nitro: MY_ROOM_HISTORY_SEARCH - Visited→HISTORY. Source: SearchRoomsVisitedEvent, MyRoomHistorySearchMessageComposer

Requests the user's room visit history.

Body: (empty)

C→S 637 - NavigatorUncollapseCategory

Nitro: NAVIGATOR_SEARCH_OPEN

Source: NavigatorUncollapseCategoryEvent, NavigatorSearchOpenComposer

Expands (uncollapses) a navigator category panel so its results are visible. Sends the category code string.

FieldTypeNotes
categorystringNavigator category code to uncollapse (e.g. "recommended")

C→S 1834 - NavigatorCollapseCategory

Nitro: NAVIGATOR_SEARCH_CLOSE

Source: NavigatorCollapseCategoryEvent, NavigatorSearchCloseComposer

Collapses a navigator category panel to hide its results. Sends the category code string.

FieldTypeNotes
categorystringNavigator category code to collapse

C→S 1202 - NavigatorCategoryListMode

Nitro: NAVIGATOR_CATEGORY_LIST_MODE

Source: NavigatorCategoryListModeEvent, NavigatorCategoryListModeComposer

Sets the display mode (list vs. thumbnail) for a specific navigator category.

FieldTypeNotes
categorystringNavigator category code
viewModeintView mode (0 = list, 1 = thumbnail)

C→S 1703 - NewNavigatorAction

Nitro: FORWARD_TO_SOME_ROOM

Source: NewNavigatorActionEvent, ForwardToSomeRoomMessageComposer

Executes a navigator action - typically a room forward or navigation to a specific destination. Sends a data string.

FieldTypeNotes
datastringNavigation action data (e.g. room ID or special destination code)

C→S 1782 - RequestNavigatorSettings

Nitro: GET_USER_EVENT_CATS

Source: RequestNavigatorSettingsEvent, GetUserEventCatsMessageComposer

Requests the user's saved navigator window settings and event categories. Responses: NAVIGATOR_SETTINGS (S→C 518) and NAVIGATOR_EVENT_CATEGORIES (S→C 3244).

FieldTypeNotes
(empty)-No body fields read

C→S 826 - RequestTags

Nitro: GET_POPULAR_ROOM_TAGS

Source: RequestTagsEvent, GetPopularRoomTagsMessageComposer

Requests the list of popular room tags and their usage counts. Response is ROOM_POPULAR_TAGS_RESULT (S→C 2012).

FieldTypeNotes
(empty)-No body fields read

C→S 2128 - RequestCanCreateRoom

Nitro: CAN_CREATE_ROOM - Request prefix dropped. Source: RequestCanCreateRoomEvent, CanCreateRoomMessageComposer

Asks the server whether the current user is permitted to create a new room.

Body: (empty)

C→S 2752 - RequestCreateRoom

Nitro: ROOM_CREATE - Request prefix dropped. Source: RequestCreateRoomEvent, CreateFlatMessageComposer

Sends a new room creation request with layout, name, description, category, capacity, and trade-mode settings.

Body:
name: string
description: string
model: string Layout model name (e.g. "model_a")
categoryId: int
maxUsers: int

C→S 2537 - MyRecommendedRooms

Nitro: MY_RECOMMENDED_ROOMS Note: No Arcturus handler - Nitro only. Source: MyRecommendedRoomsMessageComposer

Requests the server's list of recommended rooms for the current user. No parameters.

Body: (empty)

C→S 10 - ForwardToRandomPromotedRoom

Nitro: FORWARD_TO_RANDOM_PROMOTED_ROOM Note: No Arcturus handler - Nitro only. Source: ForwardToARandomPromotedRoomMessageComposer

Requests forwarding to a random promoted room. Nitro-only; no Arcturus handler.

FieldTypeNotes
kstringUnknown string parameter

C→S 172 - ForwardToACompetitionRoom

Nitro: FORWARD_TO_A_COMPETITION_ROOM Note: No Arcturus handler - Nitro only. Source: ForwardToACompetitionRoomMessageComposer

Requests forwarding to a specific competition room by identifier. Nitro-only.

FieldTypeNotes
kstringCompetition identifier string
_arg_2intUnknown int parameter

C→S 685 - GoToFlat

Nitro: GO_TO_FLAT Note: No Arcturus handler - Nitro only. Source: GoToFlatMessageComposer

Requests navigation to a specific room by ID. Nitro-only; no Arcturus handler.

FieldTypeNotes
roomIdintID of the room to navigate to

C→S 865 - ForwardToRandomCompetitionRoom

Nitro: FORWARD_TO_RANDOM_COMPETITION_ROOM Note: No Arcturus handler - Nitro only. Source: ForwardToRandomCompetitionRoomMessageComposer

Requests forwarding to a random room in a competition category. Nitro-only.

FieldTypeNotes
kstringCompetition identifier / category string

C→S 1450 - ForwardToASubmittableRoom

Nitro: FORWARD_TO_A_SUBMITTABLE_ROOM Note: No Arcturus handler - Nitro only. Source: ForwardToASubmittableRoomMessageComposer

Requests to be forwarded to a room eligible for competition submission. No parameters.

Body: (empty)

S→C 2690 - NewNavigatorSearchResults

Source: NewNavigatorSearchResultsComposer, NavigatorSearchEvent

Body:
searchCode: string Category code (e.g. "official-root", "my")
searchQuery: string The original query
count: int Number of result lists
[count SearchResultList entries]:
code: string
query: string
actionAllowed: int
displayMode: int
roomCount: int
[roomCount RoomData entries]: (see RoomDataComposer structure)

S→C 3104 - NewNavigatorLiftedRooms

Nitro: NAVIGATOR_LIFTED

Source: NewNavigatorLiftedRoomsComposer, NavigatorLiftedEvent

Delivers the list of 'lifted' (featured/pinned) rooms in the new navigator. Arcturus always sends count=0.

FieldTypeNotes
countintAlways 0 in Arcturus (feature not implemented)

S→C 3244 - NewNavigatorEventCategories

Nitro: NAVIGATOR_EVENT_CATEGORIES

Source: NewNavigatorEventCategoriesComposer, UserEventCatsEvent

Delivers the list of navigator event categories with their display data.

FieldTypeNotes
categoryCountintNumber of event categories
categories[]repeatedPer category: data from static CATEGORIES list

S→C 1562 - RoomCategories

Source: RoomCategoriesComposer, UserFlatCatsEvent

Delivers the full list of navigator room categories with their display names, visibility, and staff-picked flags.

Body:
count: int
[count entries]:
id: int
caption: string
visible: boolean
enabled: boolean
captionFull: string
captionFull2: string

S→C 1455 - NewNavigatorCategoryUserCount

Nitro: CATEGORIES_WITH_VISITOR_COUNT

Source: NewNavigatorCategoryUserCountComposer, CategoriesWithVisitorCountEvent

Delivers the per-category user count breakdown used to populate the navigator sidebar. Contains 46 hardcoded category entries.

FieldTypeNotes
categoryCountintNumber of navigator categories
categories[]repeatedPer category: hardcoded strings and counts (see source)

S→C 518 - NewNavigatorSettings

Nitro: NAVIGATOR_SETTINGS

Source: NewNavigatorSettingsComposer, NavigatorSettingsEvent

Delivers the user's saved navigator window position, size, and state preferences.

FieldTypeNotes
xintNavigator window X position
yintNavigator window Y position
widthintNavigator window width
heightintNavigator window height
openSearchesbooleanWhether saved searches panel is open
unknownintAlways 0

S→C 3984 - NewNavigatorSavedSearches

Nitro: NAVIGATOR_SEARCHES

Source: NewNavigatorSavedSearchesComposer, NavigatorSearchesEvent

Delivers the user's saved navigator searches (search code + filter string pairs).

FieldTypeNotes
searchCountintNumber of saved searches
searches[]repeatedPer search: id:int, searchCode:string, filter:string, unknown:string("")

S→C 1543 - NewNavigatorCollapsedCategories

Nitro: NAVIGATOR_COLLAPSED

Source: NewNavigatorCollapsedCategoriesComposer, NavigatorCollapsedEvent

Delivers the list of navigator category codes that are currently collapsed. Always 46 hardcoded entries in Arcturus.

FieldTypeNotes
countintNumber of collapsed category entries
categories[]string[]Category code strings (e.g. "recommended", "favorites")

S→C 1255 - RoomUserTags

Nitro: GET_USER_TAGS

Source: RoomUserTagsComposer, UserTagsMessageEvent

Pushes a room user's profile tags to other clients in the room. Despite the Nitro name GET_USER_TAGS, this is server-initiated.

FieldTypeNotes
roomUnitIdintRoom unit ID of the user
tagCountintNumber of tags
tags[]string[]User's profile tags

S→C 2012 - Tags

Nitro: ROOM_POPULAR_TAGS_RESULT

Source: TagsComposer, PopularRoomTagsResultEvent

Delivers the list of popular room tags with usage counts. Response to C→S 826 (RequestTags).

FieldTypeNotes
tagCountintNumber of popular tags
tags[]repeatedPer tag: tagText:string, usageCount:int

S→C 378 - CanCreateRoom

Source: CanCreateRoomComposer, CanCreateRoomEvent

Responds to a CanCreateRoom request; reports whether the user may create a room and an error code if not.

Body:
canCreate: boolean

S→C 2064 - OpenRoomCreationWindow

Nitro: NAVIGATOR_OPEN_ROOM_CREATOR

Source: OpenRoomCreationWindowComposer, NoOwnedRoomsAlertMessageEvent

Signals the client to open the room creation dialog. Empty body.

FieldTypeNotes
(empty)-No body fields

S→C 1304 - RoomCreated

Source: RoomCreatedComposer, FlatCreatedEvent

Confirms room creation and returns the new room's ID and name.

Body:
roomId: int

S→C 2599 - CanCreateEvent

Nitro: CAN_CREATE_ROOM_EVENT

Source: CanCreateEventComposer, CanCreateRoomEventEvent

Signals whether the user is allowed to create a room event. Arcturus always sends canCreate=true.

FieldTypeNotes
canCreatebooleanAlways true in Arcturus
unknownintAlways 0

S→C 1331 - ConvertedRoomId

Nitro: CONVERTED_ROOM_ID Note: No Arcturus composer - Nitro only. Source: ConvertedForwardToRoomComposer, ConvertedRoomIdEvent

(no Arcturus composer)

Converts a global cross-server room ID string to a local integer room ID. Nitro-only.

FieldTypeNotes
globalIdstringGlobal (cross-server) room ID string
convertedIdintLocal room ID