Class: PlatformAPI::ConfigVar

Inherits:

Object

• Object
• PlatformAPI::ConfigVar

Defined in:

lib/platform-api/client.rb

Overview

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

Instance Method Summary

• #info(app_id_or_app_name) ⇒ Object

  Get config-vars for app.

• #initialize(client) ⇒ ConfigVar constructor

  A new instance of ConfigVar.

• #update(app_id_or_app_name, body = {}) ⇒ Object

  Update config-vars for app.

Constructor Details

#initialize(client) ⇒ ConfigVar

Returns a new instance of ConfigVar.

# File 'lib/platform-api/client.rb', line 1067

def initialize(client)
  @client = client
end

Instance Method Details

#info(app_id_or_app_name) ⇒ Object

Get config-vars for app.

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

# File 'lib/platform-api/client.rb', line 1074

def info(app_id_or_app_name)
  @client.config_var.info(app_id_or_app_name)
end

#update(app_id_or_app_name, body = {}) ⇒ Object

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

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 1082

def update(app_id_or_app_name, body = {})
  @client.config_var.update(app_id_or_app_name, body)
end