module ScormEngine::Api::Endpoints::Configuration
Public Instance Methods
delete_app_configuration(options = {})
click to toggle source
Deletes the current value for a setting, reverting it to its default value.
@param [Hash] options
@option [String] setting_id
The ID for the setting to be deleted.
@option options [Boolean] :for_tenant
Indicates whether the configuration should be set for the current tenant. If false or not specified, will update configuration settings for the application in general.
@return [ScormEngine::Response]
# File lib/scorm_engine/api/endpoints/configuration.rb, line 80 def delete_app_configuration(options = {}) require_options(options, :setting_id) api_v2(without_tenant: !options.fetch(:for_tenant, false)) do setting_id = options.delete(:setting_id) response = delete("appManagement/configuration/#{setting_id}") Response.new(raw_response: response) end end
get_app_configuration(options = {})
click to toggle source
Get the application settings currently configured in Engine.
@param [Hash] options
@option options [Boolean] :for_tenant
Indicates whether the configuration effective for the current tenant should be fetched. If false or not specified, will return configuration settings for the application in general.
@return [ScormEngine::Response]
# File lib/scorm_engine/api/endpoints/configuration.rb, line 18 def get_app_configuration(options = {}) api_v2(without_tenant: !options.fetch(:for_tenant, false)) do options.delete(:for_tenant) response = get("appManagement/configuration", options) result = OpenStruct.new response.body["settingItems"].each do |setting| result[setting["id"]] = setting["effectiveValue"] end Response.new(raw_response: response, result: result) end end
post_app_configuration(options = {})
click to toggle source
Set one or more application settings in Engine.
@param [Hash] options
@option [Hash] settings
The configuration settings to be updated.
@option options [Boolean] :for_tenant
Indicates whether the configuration should be set for the current tenant. If false or not specified, will update configuration settings for the application in general.
@return [ScormEngine::Response]
# File lib/scorm_engine/api/endpoints/configuration.rb, line 50 def post_app_configuration(options = {}) require_options(options, :settings) api_v2(without_tenant: !options.fetch(:for_tenant, false)) do settings = options.delete(:settings) body = { settings: settings.map { |k, v| { "settingId" => k, "value" => v.to_s } } } response = post("appManagement/configuration", {}, body) Response.new(raw_response: response) end end