class Spaceship::ConnectAPI::AppScreenshotSet

Attributes

app_screenshots[RW]
screenshot_display_type[RW]

Public Class Methods

all(client: nil, app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) click to toggle source

API

# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 115
def self.all(client: nil, app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  resp = client.get_app_screenshot_sets(app_store_version_localization_id: app_store_version_localization_id, filter: filter, includes: includes, limit: limit, sort: sort)
  return resp.to_models
end
get(client: nil, app_screenshot_set_id: nil, includes: "appScreenshots") click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 121
def self.get(client: nil, app_screenshot_set_id: nil, includes: "appScreenshots")
  client ||= Spaceship::ConnectAPI
  return client.get_app_screenshot_set(app_screenshot_set_id: app_screenshot_set_id, filter: nil, includes: includes, limit: nil, sort: nil).first
end
type() click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 99
def self.type
  return "appScreenshotSets"
end

Public Instance Methods

apple_tv?() click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 103
def apple_tv?
  DisplayType::APP_APPLE_TV == screenshot_display_type
end
delete!(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 126
def delete!(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  return client.delete_app_screenshot_set(app_screenshot_set_id: id)
end
imessage?() click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 107
def imessage?
  DisplayType::ALL_IMESSAGE.include?(screenshot_display_type)
end
reorder_screenshots(client: nil, app_screenshot_ids: nil) click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 154
def reorder_screenshots(client: nil, app_screenshot_ids: nil)
  client ||= Spaceship::ConnectAPI
  client.patch_app_screenshot_set_screenshots(app_screenshot_set_id: id, app_screenshot_ids: app_screenshot_ids)

  return client.get_app_screenshot_set(app_screenshot_set_id: id, includes: "appScreenshots").first
end
upload_screenshot(client: nil, path: nil, wait_for_processing: true, position: nil) click to toggle source
# File spaceship/lib/spaceship/connect_api/models/app_screenshot_set.rb, line 131
def upload_screenshot(client: nil, path: nil, wait_for_processing: true, position: nil)
  client ||= Spaceship::ConnectAPI
  screenshot = Spaceship::ConnectAPI::AppScreenshot.create(client: client, app_screenshot_set_id: id, path: path, wait_for_processing: wait_for_processing)

  # Reposition (if specified)
  unless position.nil?
    # Get all app preview ids
    set = AppScreenshotSet.get(client: client, app_screenshot_set_id: id)
    app_screenshot_ids = set.app_screenshots.map(&:id)

    # Remove new uploaded screenshot
    app_screenshot_ids.delete(screenshot.id)

    # Insert screenshot at specified position
    app_screenshot_ids = app_screenshot_ids.insert(position, screenshot.id).compact

    # Reorder screenshots
    reorder_screenshots(client: client, app_screenshot_ids: app_screenshot_ids)
  end

  return screenshot
end