class PlatformAPI::ConfigVar

Config Vars allow you to manage the configuration information provided to an app on Heroku.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 1624
def initialize(client)
  @client = client
end

Public Instance Methods

info_for_app(app_id_or_app_name) click to toggle source

Get config-vars for app.

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 1631
def info_for_app(app_id_or_app_name)
  @client.config_var.info_for_app(app_id_or_app_name)
end
info_for_app_release(app_id_or_app_name, release_id_or_release_version) click to toggle source

Get config-vars for a release.

@param app_id_or_app_name: unique identifier of app or unique name of app @param release_id_or_release_version: unique identifier of release or unique version assigned to the release

# File lib/platform-api/client.rb, line 1639
def info_for_app_release(app_id_or_app_name, release_id_or_release_version)
  @client.config_var.info_for_app_release(app_id_or_app_name, release_id_or_release_version)
end
update(app_id_or_app_name, body = {}) click to toggle source

Update config-vars for app. You can update existing config-vars by setting them again, and remove by setting it to `null`.

@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1647
def update(app_id_or_app_name, body = {})
  @client.config_var.update(app_id_or_app_name, body)
end