Documentation
API Reference
game-client
modules

Namespace: context

Classes

Interfaces

Type Aliases

ConfigureSubGroupsConfig

Ƭ ConfigureSubGroupsConfig: Object

Type declaration

Name Type
allowParticipantsChooseRoom boolean
allowParticipantsReturnToMainSession boolean
automaticallyMoveParticipantsIntoMainRoom boolean
automaticallyMoveParticipantsIntoRooms boolean

ContextApiType

Ƭ ContextApiType: "GROUP" | "SUBGROUP" | "SOLO"

ContextFilter

Ƭ ContextFilter: "NEW_CONTEXT_ONLY" | "INCLUDE_EXISTING_CHALLENGES" | "NEW_PLAYERS_ONLY" | "NEW_INVITATIONS_ONLY"

A filter that may be applied to a context choose operation:

  • NEW_CONTEXT_ONLY - Prefer to only surface contexts the game has not been played in before.
  • INCLUDE_EXISTING_CHALLENGES - Include the “Existing Challenges” section, which surfaces actively played-in contexts that the player is a part of.
  • NEW_PLAYERS_ONLY - In sections containing individuals, prefer people who have not played the game.
  • NEW_INVITATIONS_ONLY - (Viber) only enlists friends who haven’t been sent an in-game message before. This filter can be fine-tuned with hoursSinceInvitation parameter.

GroupConfigChange

Ƭ GroupConfigChange: Object

Type declaration

Name Type
change "breakoutRoomsConfigured" | "breakoutRoomOpened | breakoutRoomClosed" | "breakoutRoomOpened" | "breakoutRoomClosed"
timestamp number

GroupConfigChangeEvent

Ƭ GroupConfigChangeEvent: GroupConfigChange | BreakoutRoomsCreated | BreakoutRoomsUpdated | BreakoutRoomsParticipantsAssigned | BreakoutRoomsParticipantsJoined | BreakoutRoomsParticipantsLeft