class Google::Apis::GamesV1::RoomParticipant

This is a JSON template for a participant in a room.

Attributes

auto_matched[RW]

True if this participant was auto-matched with the requesting player. Corresponds to the JSON property `autoMatched` @return [Boolean]

auto_matched?[RW]

True if this participant was auto-matched with the requesting player. Corresponds to the JSON property `autoMatched` @return [Boolean]

auto_matched_player[RW]

This is a JSON template for an anonymous player Corresponds to the JSON property `autoMatchedPlayer` @return [Google::Apis::GamesV1::AnonymousPlayer]

capabilities[RW]

The capabilities which can be used when communicating with this participant. Corresponds to the JSON property `capabilities` @return [Array<String>]

client_address[RW]

This is a JSON template for the client address when setting up a room. Corresponds to the JSON property `clientAddress` @return [Google::Apis::GamesV1::RoomClientAddress]

connected[RW]

True if this participant is in the fully connected set of peers in the room. Corresponds to the JSON property `connected` @return [Boolean]

connected?[RW]

True if this participant is in the fully connected set of peers in the room. Corresponds to the JSON property `connected` @return [Boolean]

id[RW]

An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts. Corresponds to the JSON property `id` @return [String]

kind[RW]

Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant. Corresponds to the JSON property `kind` @return [String]

leave_reason[RW]

The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are:

  • “PLAYER_LEFT” - The player explicitly chose to leave the room.

  • “GAME_LEFT” - The game chose to remove the player from the room.

  • “ABANDONED” - The player switched to another application and abandoned the

room.

  • “PEER_CONNECTION_FAILURE” - The client was unable to establish or maintain a

connection to other peer(s) in the room.

  • “SERVER_ERROR” - The client received an error response when it tried to

communicate with the server.

  • “TIMEOUT” - The client timed out while waiting for players to join and

connect.

  • “PRESENCE_FAILURE” - The client's XMPP connection ended abruptly.

Corresponds to the JSON property `leaveReason` @return [String]

player[RW]

This is a JSON template for a Player resource. Corresponds to the JSON property `player` @return [Google::Apis::GamesV1::Player]

status[RW]

The status of the participant with respect to the room. Possible values are:

  • “PARTICIPANT_INVITED” - The participant has been invited to join the room,

but has not yet responded.

  • “PARTICIPANT_JOINED” - The participant has joined the room (either after

creating it or accepting an invitation.)

  • “PARTICIPANT_DECLINED” - The participant declined an invitation to join the

room.

  • “PARTICIPANT_LEFT” - The participant joined the room and then left it.

Corresponds to the JSON property `status` @return [String]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/games_v1/classes.rb, line 3743
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/games_v1/classes.rb, line 3748
def update!(**args)
  @auto_matched = args[:auto_matched] if args.key?(:auto_matched)
  @auto_matched_player = args[:auto_matched_player] if args.key?(:auto_matched_player)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @client_address = args[:client_address] if args.key?(:client_address)
  @connected = args[:connected] if args.key?(:connected)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @leave_reason = args[:leave_reason] if args.key?(:leave_reason)
  @player = args[:player] if args.key?(:player)
  @status = args[:status] if args.key?(:status)
end