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

This is a JSON template for an event definition resource.

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) ⇒ 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_eventsArray<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

#descriptionString

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

Returns:

  • (String)

827
828
829
# File 'generated/google/apis/games_v1/classes.rb', line 827

def description
  @description
end

#display_nameString

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

Returns:

  • (String)

832
833
834
# File 'generated/google/apis/games_v1/classes.rb', line 832

def display_name
  @display_name
end

#idString

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

Returns:

  • (String)

837
838
839
# File 'generated/google/apis/games_v1/classes.rb', line 837

def id
  @id
end

#image_urlString

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

Returns:

  • (String)

842
843
844
# File 'generated/google/apis/games_v1/classes.rb', line 842

def image_url
  @image_url
end

#is_default_image_urlBoolean 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)

848
849
850
# File 'generated/google/apis/games_v1/classes.rb', line 848

def is_default_image_url
  @is_default_image_url
end

#kindString

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

Returns:

  • (String)

855
856
857
# File 'generated/google/apis/games_v1/classes.rb', line 855

def kind
  @kind
end

#visibilityString

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

Returns:

  • (String)

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