Class: Strava::Models::PhotosSummary

Inherits:

Response

• Object
• Hashie::Trash
• Strava::Model
• Response
• Strava::Models::PhotosSummary

Defined in:

lib/strava/models/photos_summary.rb

Overview

Represents summary photo information for an activity.

Contains basic information about photos attached to an activity, including the count and primary photo reference.

Examples:

Accessing activity photo summary

activity = client.activity(1234567890)
if activity.photos && activity.photos.count > 0
  puts "This activity has #{activity.photos.count} photo(s)"
  if activity.photos.primary
    puts "Primary photo: #{activity.photos.primary.urls}"
  end
end

See Also:

• Strava API PhotosSummary reference
• PhotosSummaryPrimary
• SummaryActivity

Instance Method Summary

• #count ⇒ Integer

  Total number of photos attached to the activity.

• #primary ⇒ PhotosSummaryPrimary^?

  The primary/featured photo reference.

• #use_primary_photo ⇒ Boolean^?

  Whether to use the primary photo for display.

Instance Method Details

#count ⇒ Integer

Returns Total number of photos attached to the activity.

Returns:

• (Integer) —

  Total number of photos attached to the activity

# File 'lib/strava/models/photos_summary.rb', line 26

property 'count'

#primary ⇒ PhotosSummaryPrimary^?

Returns The primary/featured photo reference.

Returns:

• (PhotosSummaryPrimary, nil) —

  The primary/featured photo reference

# File 'lib/strava/models/photos_summary.rb', line 33

property 'primary', transform_with: ->(v) { Strava::Models::PhotosSummaryPrimary.new(v) }

#use_primary_photo ⇒ Boolean^?

Note:

Not documented by Strava API

Returns Whether to use the primary photo for display.

Returns:

• (Boolean, nil) —

  Whether to use the primary photo for display

# File 'lib/strava/models/photos_summary.rb', line 30

property 'use_primary_photo'