Class: Google::Apis::PeopleV1::CoverPhoto

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

Overview

A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

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

Returns a new instance of CoverPhoto.


552
553
554
# File 'generated/google/apis/people_v1/classes.rb', line 552

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

Instance Attribute Details

#defaultBoolean Also known as: default?

True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo. Corresponds to the JSON property default

Returns:

  • (Boolean)

539
540
541
# File 'generated/google/apis/people_v1/classes.rb', line 539

def default
  @default
end

#metadataGoogle::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata


545
546
547
# File 'generated/google/apis/people_v1/classes.rb', line 545

def 
  @metadata
end

#urlString

The URL of the cover photo. Corresponds to the JSON property url

Returns:

  • (String)

550
551
552
# File 'generated/google/apis/people_v1/classes.rb', line 550

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


557
558
559
560
561
# File 'generated/google/apis/people_v1/classes.rb', line 557

def update!(**args)
  @default = args[:default] if args.key?(:default)
  @metadata = args[:metadata] if args.key?(:metadata)
  @url = args[:url] if args.key?(:url)
end