package broadcast_service

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AddBroadcastAnnotators (AddBroadcastAnnotatorsRequest, AddBroadcastAnnotatorsResponse)

  broadcast_service.proto:318

  message AddBroadcastAnnotatorsRequest

  broadcast_service.proto:151

  • string slug = 1

  • repeated string usernames = 2

  message AddBroadcastAnnotatorsResponse

  broadcast_service.proto:156

  (message has no fields)

• rpc AddBroadcastDirectors (AddBroadcastDirectorsRequest, AddBroadcastDirectorsResponse)

  broadcast_service.proto:316

  message AddBroadcastDirectorsRequest

  broadcast_service.proto:137

  • string slug = 1

  • repeated string usernames = 2

  message AddBroadcastDirectorsResponse

  broadcast_service.proto:142

  (message has no fields)

• rpc AssignSlot (AssignSlotRequest, AssignSlotResponse)

  broadcast_service.proto:328

  message AssignSlotRequest

  broadcast_service.proto:233

  • string slug = 1

  • string slot_name = 2

  • string division = 3

    empty = use first division from feed

  • int32 round = 4

  • int32 table_number = 5

  message AssignSlotResponse

  broadcast_service.proto:241

  (message has no fields)

• rpc ClaimGame (ClaimGameRequest, ClaimGameResponse)

  broadcast_service.proto:314

  message ClaimGameRequest

  broadcast_service.proto:117

  • string slug = 1

  • int32 round = 2

  • int32 table_number = 3

  • string division = 4

  message ClaimGameResponse

  broadcast_service.proto:124

  • string game_id = 1

• rpc CreateBroadcast (CreateBroadcastRequest, CreateBroadcastResponse)

  broadcast_service.proto:310

  message CreateBroadcastRequest

  broadcast_service.proto:53

  • string slug = 1

  • string name = 2

  • string description = 3

  • string broadcast_url = 4

  • string broadcast_url_format = 5

  • int32 poll_interval_seconds = 6

  • optional google.protobuf.Timestamp poll_start_time = 7

  • optional google.protobuf.Timestamp poll_end_time = 8

  • string lexicon = 9

  • string board_layout = 10

  • string letter_distribution = 11

  • int32 challenge_rule = 12

  message CreateBroadcastResponse

  broadcast_service.proto:68

  • string uuid = 1

  • string slug = 2

• rpc CreateSlot (CreateSlotRequest, CreateSlotResponse)

  broadcast_service.proto:327

  message CreateSlotRequest

  broadcast_service.proto:223

  • string slug = 1

  • string slot_name = 2

  • string division = 3

    required; must be non-empty

  • int32 round = 4

  • int32 table_number = 5

  message CreateSlotResponse

  broadcast_service.proto:231

  (message has no fields)

• rpc DeleteSlot (DeleteSlotRequest, DeleteSlotResponse)

  broadcast_service.proto:329

  message DeleteSlotRequest

  broadcast_service.proto:258

  • string slug = 1

  • string slot_name = 2

  message DeleteSlotResponse

  broadcast_service.proto:263

  (message has no fields)

• rpc GetActiveBroadcasts (GetActiveBroadcastsRequest, GetActiveBroadcastsResponse)

  broadcast_service.proto:320

  message GetActiveBroadcastsRequest

  broadcast_service.proto:165

  (message has no fields)

  message GetActiveBroadcastsResponse

  broadcast_service.proto:167

  • repeated Broadcast broadcasts = 1

• rpc GetAllBroadcasts (GetAllBroadcastsRequest, GetAllBroadcastsResponse)

  broadcast_service.proto:321

  message GetAllBroadcastsRequest

  broadcast_service.proto:171

  (message has no fields)

  message GetAllBroadcastsResponse

  broadcast_service.proto:173

  • repeated Broadcast broadcasts = 1

• rpc GetBroadcast (GetBroadcastRequest, GetBroadcastResponse)

  broadcast_service.proto:311

  message GetBroadcastRequest

  broadcast_service.proto:73

  • string slug = 1

  • string division = 2

    empty = first available division

  message GetBroadcastResponse

  broadcast_service.proto:78

  • optional Broadcast broadcast = 1

  • repeated BroadcastPlayer players = 2

    standings for requested division

  • repeated string director_usernames = 3

  • repeated string annotator_usernames = 4

  • int32 total_rounds = 5

  • repeated string divisions = 6

    all available divisions from the feed

• rpc GetBroadcastAllGames (GetBroadcastAllGamesRequest, GetBroadcastAllGamesResponse)

  broadcast_service.proto:331

  message GetBroadcastAllGamesRequest

  broadcast_service.proto:301

  • string slug = 1

  message GetBroadcastAllGamesResponse

  broadcast_service.proto:305

  • repeated BroadcastGameStat stats = 1

• rpc GetBroadcastGameContext (GetBroadcastGameContextRequest, GetBroadcastGameContextResponse)

  broadcast_service.proto:324

  message GetBroadcastGameContextRequest

  broadcast_service.proto:194

  • string game_uuid = 1

  message GetBroadcastGameContextResponse

  broadcast_service.proto:198

  • string broadcast_slug = 1

  • string broadcast_name = 2

  • int32 round = 3

  • int32 table_number = 4

  • string division = 5

  • string slot_name = 6

    empty if no slot is currently assigned to this game

  • bool annotation_done = 7

• rpc GetBroadcastGameStats (GetBroadcastGameStatsRequest, GetBroadcastGameStatsResponse)

  broadcast_service.proto:330

  message GetBroadcastGameStatsRequest

  broadcast_service.proto:293

  • string slug = 1

  message GetBroadcastGameStatsResponse

  broadcast_service.proto:297

  • repeated BroadcastGameStat stats = 1

• rpc GetBroadcastGames (GetBroadcastGamesRequest, GetBroadcastGamesResponse)

  broadcast_service.proto:312

  message GetBroadcastGamesRequest

  broadcast_service.proto:87

  • string slug = 1

  • int32 round = 2

  • string division = 3

    empty = first available division

  message GetBroadcastGamesResponse

  broadcast_service.proto:93

  • repeated BroadcastRoundGame games = 1

  • int32 round = 2

  • int32 total_rounds = 3

• rpc GetMyClaimedGames (GetMyClaimedGamesRequest, GetMyClaimedGamesResponse)

  broadcast_service.proto:323

  message GetMyClaimedGamesRequest

  broadcast_service.proto:185

  • string slug = 1

  • int32 limit = 2

  message GetMyClaimedGamesResponse

  broadcast_service.proto:190

  • repeated BroadcastRoundGame games = 1

• rpc GetSlotCurrentGame (GetSlotCurrentGameRequest, GetSlotCurrentGameResponse)

  broadcast_service.proto:326

  message GetSlotCurrentGameRequest

  broadcast_service.proto:243

  • string slug = 1

  • string slot_name = 2

  message GetSlotCurrentGameResponse

  broadcast_service.proto:248

  • string game_uuid = 1

    empty if no game claimed at this slot's target

  • string player1_name = 2

  • string player2_name = 3

  • string division = 4

  • int32 round = 5

  • int32 table_number = 6

  • bool annotation_done = 7

• rpc ListSlots (ListSlotsRequest, ListSlotsResponse)

  broadcast_service.proto:325

  message ListSlotsRequest

  broadcast_service.proto:215

  • string slug = 1

  message ListSlotsResponse

  broadcast_service.proto:219

  • repeated BroadcastSlot slots = 1

• rpc RemoveBroadcastAnnotators (RemoveBroadcastAnnotatorsRequest, RemoveBroadcastAnnotatorsResponse)

  broadcast_service.proto:319

  message RemoveBroadcastAnnotatorsRequest

  broadcast_service.proto:158

  • string slug = 1

  • repeated string usernames = 2

  message RemoveBroadcastAnnotatorsResponse

  broadcast_service.proto:163

  (message has no fields)

• rpc RemoveBroadcastDirectors (RemoveBroadcastDirectorsRequest, RemoveBroadcastDirectorsResponse)

  broadcast_service.proto:317

  message RemoveBroadcastDirectorsRequest

  broadcast_service.proto:144

  • string slug = 1

  • repeated string usernames = 2

  message RemoveBroadcastDirectorsResponse

  broadcast_service.proto:149

  (message has no fields)

• rpc TriggerPoll (TriggerPollRequest, TriggerPollResponse)

  broadcast_service.proto:322

  message TriggerPollRequest

  broadcast_service.proto:177

  • string slug = 1

  message TriggerPollResponse

  broadcast_service.proto:181

  • bool data_changed = 1

• rpc UnclaimGame (UnclaimGameRequest, UnclaimGameResponse)

  broadcast_service.proto:315

  message UnclaimGameRequest

  broadcast_service.proto:128

  • string slug = 1

  • int32 round = 2

  • int32 table_number = 3

  • string division = 4

  message UnclaimGameResponse

  broadcast_service.proto:135

  (message has no fields)

• rpc UpdateBroadcast (UpdateBroadcastRequest, UpdateBroadcastResponse)

  broadcast_service.proto:313

  message UpdateBroadcastRequest

  broadcast_service.proto:99

  • string slug = 1

  • string name = 2

  • string description = 3

  • string broadcast_url = 4

  • string broadcast_url_format = 5

  • int32 poll_interval_seconds = 6

  • optional google.protobuf.Timestamp poll_start_time = 7

  • optional google.protobuf.Timestamp poll_end_time = 8

  • string lexicon = 9

  • string board_layout = 10

  • string letter_distribution = 11

  • int32 challenge_rule = 12

  • bool active = 13

  message UpdateBroadcastResponse

  broadcast_service.proto:115

  (message has no fields)

Used in: GetActiveBroadcastsResponse, GetAllBroadcastsResponse, GetBroadcastResponse

• string uuid = 1

• string slug = 2

• string name = 3

• string description = 4

• string broadcast_url = 5

• string broadcast_url_format = 6

• int32 poll_interval_seconds = 7

• optional google.protobuf.Timestamp poll_start_time = 8

• optional google.protobuf.Timestamp poll_end_time = 9

• string lexicon = 10

• string board_layout = 11

• string letter_distribution = 12

• int32 challenge_rule = 13

• int32 current_round = 14

• bool active = 15

• string creator_username = 16

• optional google.protobuf.Timestamp created_at = 17

BroadcastGameStat is the pre-computed stats for a single annotated game. Populated when the annotation is marked done; nil for in-progress games.

Used in: GetBroadcastAllGamesResponse, GetBroadcastGameStatsResponse

• string game_uuid = 1

• string division = 2

• int32 round = 3

• int32 table_number = 4

• string player1_name = 5

• string player2_name = 6

• int32 player1_rating = 7

• int32 player2_rating = 8

• int32 player1_score = 9

• int32 player2_score = 10

• int32 winner = 11

  0 = player1, 1 = player2, -1 = tie

• int32 player1_bingos = 12

• int32 player2_bingos = 13

• int32 max_play_score = 14

  highest single-turn score in the game

• string max_play_word = 15

  the word played on that turn (friendly)

• int32 move_count = 16

  total tile-placement + exchange moves

• bool walk_off_bingo = 17

  last move was a bingo ending the game

• optional google.protobuf.Timestamp completed_at = 18

  null for in-progress games

• int32 current_score1 = 19

  Current scores (only set for in-progress games, i.e. completed_at is null)

• int32 current_score2 = 20

• bool player1_goes_first = 21

  true if player1 went first; false if player2 went first; false if unknown

A player entry from the feed, for standings display.

Used in: GetBroadcastResponse

• int32 player_id = 1

• string name = 2

• int32 rating = 3

• double wins = 4

• double losses = 5

• int32 spread = 6

• int32 games_played = 7

A game pairing within a round, derived from the feed data.

Used in: GetBroadcastGamesResponse, GetMyClaimedGamesResponse

• int32 round = 1

• int32 table_number = 2

• string player1_name = 3

• string player2_name = 4

• int32 player1_score = 5

• int32 player2_score = 6

• bool scores_finalized = 7

  true if game is complete in feed

• string game_uuid = 8

  Set if this game has been claimed for annotation:

• string annotator_username = 9

• bool annotation_done = 10

• string division = 11

Used in: ListSlotsResponse

• string slot_name = 1

• string division = 2

  empty string = use first division from feed

• int32 round = 3

• int32 table_number = 4