Class: Google::Apis::GamesV1::Room

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/games_v1/classes.rb,
generated/google/apis/games_v1/representations.rb,
generated/google/apis/games_v1/representations.rb

Overview

This is a JSON template for a room resource object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Room

Returns a new instance of Room.



2914
2915
2916
# File 'generated/google/apis/games_v1/classes.rb', line 2914

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#application_idString

The ID of the application being played. Corresponds to the JSON property applicationId

Returns:

  • (String)


2836
2837
2838
# File 'generated/google/apis/games_v1/classes.rb', line 2836

def application_id
  @application_id
end

#auto_matching_criteriaGoogle::Apis::GamesV1::RoomAutoMatchingCriteria

This is a JSON template for a room auto-match criteria object. Corresponds to the JSON property autoMatchingCriteria



2841
2842
2843
# File 'generated/google/apis/games_v1/classes.rb', line 2841

def auto_matching_criteria
  @auto_matching_criteria
end

#auto_matching_statusGoogle::Apis::GamesV1::RoomAutoMatchStatus

This is a JSON template for status of room automatching that is in progress. Corresponds to the JSON property autoMatchingStatus



2846
2847
2848
# File 'generated/google/apis/games_v1/classes.rb', line 2846

def auto_matching_status
  @auto_matching_status
end

#creation_detailsGoogle::Apis::GamesV1::RoomModification

This is a JSON template for room modification metadata. Corresponds to the JSON property creationDetails



2851
2852
2853
# File 'generated/google/apis/games_v1/classes.rb', line 2851

def creation_details
  @creation_details
end

#descriptionString

This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.) Corresponds to the JSON property description

Returns:

  • (String)


2858
2859
2860
# File 'generated/google/apis/games_v1/classes.rb', line 2858

def description
  @description
end

#inviter_idString

The ID of the participant that invited the user to the room. Not set if the user was not invited to the room. Corresponds to the JSON property inviterId

Returns:

  • (String)


2864
2865
2866
# File 'generated/google/apis/games_v1/classes.rb', line 2864

def inviter_id
  @inviter_id
end

#kindString

Uniquely identifies the type of this resource. Value is always the fixed string games#room. Corresponds to the JSON property kind

Returns:

  • (String)


2870
2871
2872
# File 'generated/google/apis/games_v1/classes.rb', line 2870

def kind
  @kind
end

#last_update_detailsGoogle::Apis::GamesV1::RoomModification

This is a JSON template for room modification metadata. Corresponds to the JSON property lastUpdateDetails



2875
2876
2877
# File 'generated/google/apis/games_v1/classes.rb', line 2875

def last_update_details
  @last_update_details
end

#participantsArray<Google::Apis::GamesV1::RoomParticipant>

The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. Corresponds to the JSON property participants



2881
2882
2883
# File 'generated/google/apis/games_v1/classes.rb', line 2881

def participants
  @participants
end

#room_idString

Globally unique ID for a room. Corresponds to the JSON property roomId

Returns:

  • (String)


2886
2887
2888
# File 'generated/google/apis/games_v1/classes.rb', line 2886

def room_id
  @room_id
end

#room_status_versionFixnum

The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status. Corresponds to the JSON property roomStatusVersion

Returns:

  • (Fixnum)


2892
2893
2894
# File 'generated/google/apis/games_v1/classes.rb', line 2892

def room_status_version
  @room_status_version
end

#statusString

The status of the room. Possible values are:

  • "ROOM_INVITING" - One or more players have been invited and not responded.
  • "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
  • "ROOM_CONNECTING" - Players have joined and are connecting to each other ( either before or after auto-matching).
  • "ROOM_ACTIVE" - All players have joined and connected to each other.
  • "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left. Corresponds to the JSON property status

Returns:

  • (String)


2906
2907
2908
# File 'generated/google/apis/games_v1/classes.rb', line 2906

def status
  @status
end

#variantFixnum

The variant / mode of the application being played; can be any integer value, or left blank. Corresponds to the JSON property variant

Returns:

  • (Fixnum)


2912
2913
2914
# File 'generated/google/apis/games_v1/classes.rb', line 2912

def variant
  @variant
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
# File 'generated/google/apis/games_v1/classes.rb', line 2919

def update!(**args)
  @application_id = args[:application_id] if args.key?(:application_id)
  @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria)
  @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status)
  @creation_details = args[:creation_details] if args.key?(:creation_details)
  @description = args[:description] if args.key?(:description)
  @inviter_id = args[:inviter_id] if args.key?(:inviter_id)
  @kind = args[:kind] if args.key?(:kind)
  @last_update_details = args[:last_update_details] if args.key?(:last_update_details)
  @participants = args[:participants] if args.key?(:participants)
  @room_id = args[:room_id] if args.key?(:room_id)
  @room_status_version = args[:room_status_version] if args.key?(:room_status_version)
  @status = args[:status] if args.key?(:status)
  @variant = args[:variant] if args.key?(:variant)
end