Class: Google::Apis::GamesV1::EventDefinition
- Inherits:
-
Object
- Object
- Google::Apis::GamesV1::EventDefinition
- 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 an event definition resource.
Instance Attribute Summary collapse
-
#child_events ⇒ Array<Google::Apis::GamesV1::EventChild>
A list of events that are a child of this event.
-
#description ⇒ String
Description of what this event represents.
-
#display_name ⇒ String
The name to display for the event.
-
#id ⇒ String
The ID of the event.
-
#image_url ⇒ String
The base URL for the image that represents the event.
-
#is_default_image_url ⇒ Boolean
(also: #is_default_image_url?)
Indicates whether the icon image being returned is a default image, or is game- provided.
-
#kind ⇒ String
Uniquely identifies the type of this resource.
-
#visibility ⇒ String
The visibility of event being tracked in this definition.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EventDefinition
constructor
A new instance of EventDefinition.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ EventDefinition
Returns a new instance of EventDefinition.
866 867 868 |
# File 'generated/google/apis/games_v1/classes.rb', line 866 def initialize(**args) update!(**args) end |
Instance Attribute Details
#child_events ⇒ Array<Google::Apis::GamesV1::EventChild>
A list of events that are a child of this event.
Corresponds to the JSON property childEvents
822 823 824 |
# File 'generated/google/apis/games_v1/classes.rb', line 822 def child_events @child_events end |
#description ⇒ String
Description of what this event represents.
Corresponds to the JSON property description
827 828 829 |
# File 'generated/google/apis/games_v1/classes.rb', line 827 def description @description end |
#display_name ⇒ String
The name to display for the event.
Corresponds to the JSON property displayName
832 833 834 |
# File 'generated/google/apis/games_v1/classes.rb', line 832 def display_name @display_name end |
#id ⇒ String
The ID of the event.
Corresponds to the JSON property id
837 838 839 |
# File 'generated/google/apis/games_v1/classes.rb', line 837 def id @id end |
#image_url ⇒ String
The base URL for the image that represents the event.
Corresponds to the JSON property imageUrl
842 843 844 |
# File 'generated/google/apis/games_v1/classes.rb', line 842 def image_url @image_url end |
#is_default_image_url ⇒ Boolean Also known as: is_default_image_url?
Indicates whether the icon image being returned is a default image, or is game-
provided.
Corresponds to the JSON property isDefaultImageUrl
848 849 850 |
# File 'generated/google/apis/games_v1/classes.rb', line 848 def is_default_image_url @is_default_image_url end |
#kind ⇒ String
Uniquely identifies the type of this resource. Value is always the fixed
string games#eventDefinition.
Corresponds to the JSON property kind
855 856 857 |
# File 'generated/google/apis/games_v1/classes.rb', line 855 def kind @kind end |
#visibility ⇒ String
The visibility of event being tracked in this definition. Possible values are:
- "REVEALED": This event should be visible to all users.
- "HIDDEN": This event should only be shown to users that have recorded this
event at least once.
Corresponds to the JSON property
visibility
864 865 866 |
# File 'generated/google/apis/games_v1/classes.rb', line 864 def visibility @visibility end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
871 872 873 874 875 876 877 878 879 880 |
# File 'generated/google/apis/games_v1/classes.rb', line 871 def update!(**args) @child_events = args[:child_events] if args.key?(:child_events) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image_url = args[:image_url] if args.key?(:image_url) @is_default_image_url = args[:is_default_image_url] if args.key?(:is_default_image_url) @kind = args[:kind] if args.key?(:kind) @visibility = args[:visibility] if args.key?(:visibility) end |