package game_service

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetActiveCorrespondenceGames (ActiveCorrespondenceGamesRequest, ipc.GameInfoResponses)

  game_service.proto:92

  GetActiveCorrespondenceGames gets all active correspondence games for a user.

  message ActiveCorrespondenceGamesRequest

  game_service.proto:49

  • string username = 1

    Empty for the authenticated user's own games. Another user's games need the can_see_private_user_data permission.

• rpc GetGCG (GCGRequest, GCGResponse)

  game_service.proto:81

  GetGCG gets a GCG string for the given game ID.

  message GCGRequest

  game_service.proto:10

  • string game_id = 1

  message GCGResponse

  game_service.proto:14

  • string gcg = 1

• rpc GetGameDocument (GameDocumentRequest, GameDocumentResponse)

  game_service.proto:90

  GetGameDocument gets a Game Document. This will eventually obsolete GetGameHistory. Does not work with annotated games for now.

  message GameDocumentRequest

  game_service.proto:12

  • string game_id = 1

  message GameDocumentResponse

  game_service.proto:16

  • optional ipc.GameDocument document = 1

• rpc GetGameHistory (GameHistoryRequest, GameHistoryResponse)

  game_service.proto:84

  GetGameHistory gets a GameHistory for the given game ID. GameHistory is our internal representation of a game's state.

  message GameHistoryRequest

  game_service.proto:11

  • string game_id = 1

  message GameHistoryResponse

  game_service.proto:15

  • optional macondo.GameHistory history = 1

• rpc GetMetadata (GameInfoRequest, ipc.GameInfoResponse)

  game_service.proto:79

  message GameInfoRequest

  game_service.proto:8

  Meta information about a game, including its players.

  • string game_id = 1

• rpc GetRecentCorrespondenceGames (RecentCorrespondenceGamesRequest, ipc.GameInfoResponses)

  game_service.proto:94

  GetRecentCorrespondenceGames gets recently ended correspondence games for a user.

  message RecentCorrespondenceGamesRequest

  game_service.proto:55

  • string username = 1

  • int32 num_games = 2

• rpc GetRecentGames (RecentGamesRequest, ipc.GameInfoResponses)

  game_service.proto:86

  GetRecentGames gets recent games for a user.

  message RecentGamesRequest

  game_service.proto:18

  • string username = 1

  • int32 num_games = 2

  • int32 offset = 3

  • string before_game_id = 4

    Paging by position instead of offset, cheap however deep (offset is ignored when one is set): the games just older than before_game_id, or just older than the time before (unix ms) for a jump to a date, or just newer than after_game_id, or than the time after (unix ms; 1 gives the oldest games). Games come newest first either way.

  • int64 before = 5

  • string after_game_id = 6

  • int64 after = 7

• rpc GetRematchStreak (RematchStreakRequest, StreakInfoResponse)

  game_service.proto:87

  message RematchStreakRequest

  game_service.proto:47

  • string original_request_id = 1

  message StreakInfoResponse

  game_service.proto:33

  • repeated StreakInfoResponse.SingleGameInfo streak = 1

  • repeated StreakInfoResponse.PlayerInfo playersInfo = 3

    XXX make this snake_case

• rpc UnfreezeBot (UnfreezeBotRequest, UnfreezeBotResponse)

  game_service.proto:96

  UnfreezeBot re-sends bot move requests for stuck games (admin only)

  message UnfreezeBotRequest

  game_service.proto:67

  • UnfreezeBotMode mode = 1

  • string game_id = 2

    Required if mode is SPECIFIC_GAME

  message UnfreezeBotResponse

  game_service.proto:72

  • int32 games_processed = 1

  • int32 requests_sent = 2

  • int32 errors = 3

Used in: StreakInfoResponse

• string nickname = 1

• string uuid = 2

  player uuid needed for censoring

Used in: StreakInfoResponse

• string game_id = 1

• int32 winner = 3

  the index in `players` or -1 if no winner (tie)

Used in: UnfreezeBotRequest

• UNFREEZE_BOT_MODE_UNSPECIFIED = 0

• UNFREEZE_BOT_MODE_ALL_CORRESPONDENCE = 1

• UNFREEZE_BOT_MODE_ALL_REALTIME = 2

• UNFREEZE_BOT_MODE_SPECIFIC_GAME = 3