Class: Google::Apis::GamesV1::EventDefinition

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

An event definition resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EventDefinition

Returns a new instance of EventDefinition.



801
802
803
 
# File 'generated/google/apis/games_v1/classes.rb', line 801

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

Returns:



761
762
763
 
# File 'generated/google/apis/games_v1/classes.rb', line 761

def child_events
  @child_events
end

#description ⇒ String

Description of what this event represents. Corresponds to the JSON property description

Returns:

  • (String) 


766
767
768
 
# File 'generated/google/apis/games_v1/classes.rb', line 766

def description
  @description
end

#display_name ⇒ String

The name to display for the event. Corresponds to the JSON property displayName

Returns:

  • (String) 


771
772
773
 
# File 'generated/google/apis/games_v1/classes.rb', line 771

def display_name
  @display_name
end

#id ⇒ String

The ID of the event. Corresponds to the JSON property id

Returns:

  • (String) 


776
777
778
 
# File 'generated/google/apis/games_v1/classes.rb', line 776

def id
  @id
end

#image_url ⇒ String

The base URL for the image that represents the event. Corresponds to the JSON property imageUrl

Returns:

  • (String) 


781
782
783
 
# File 'generated/google/apis/games_v1/classes.rb', line 781

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

Returns:

  • (Boolean) 


787
788
789
 
# File 'generated/google/apis/games_v1/classes.rb', line 787

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

Returns:

  • (String) 


794
795
796
 
# File 'generated/google/apis/games_v1/classes.rb', line 794

def kind
  @kind
end

#visibility ⇒ String

The visibility of event being tracked in this definition. Corresponds to the JSON property visibility

Returns:

  • (String) 


799
800
801
 
# File 'generated/google/apis/games_v1/classes.rb', line 799

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



806
807
808
809
810
811
812
813
814
815
 
# File 'generated/google/apis/games_v1/classes.rb', line 806

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