Class: ScormEngine::Client

Inherits:
Object
  • Object
show all
Includes:
Api::Endpoints, Faraday::Connection, Faraday::Request
Defined in:
lib/scorm_engine/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Api::Endpoints

#get_registration_launch_link

Methods included from Api::Endpoints::Tenants::Configuration

#get_tenant_configuration, #get_tenant_configuration_setting, #post_tenant_configuration, #put_tenant_configuration_setting

Methods included from Api::Endpoints::Registrations::LaunchHistory

#get_registration_launch_history

Methods included from Api::Endpoints::Registrations::Configuration

#get_registration_configuration, #get_registration_configuration_setting, #post_registration_configuration, #put_registration_configuration_setting

Methods included from Api::Endpoints::Registrations

#delete_registration, #get_registration_exists, #get_registration_instances, #get_registration_progress, #get_registrations, #post_registration

Methods included from Api::Endpoints::Ping

#get_ping

Methods included from Api::Endpoints::Dispatches

#delete_dispatch, #delete_dispatch_registration_count, #get_dispatch, #get_dispatch_enabled, #get_dispatch_registration_count, #get_dispatch_zip, #get_dispatches, #post_dispatch, #put_dispatch, #put_dispatch_enabled

Methods included from Api::Endpoints::Destinations

#delete_destination, #get_destination, #get_destination_dispatches_registration_count, #get_destinations, #post_destination, #post_destination_dispatches_enabled, #post_destination_dispatches_registration_instancing, #put_destination

Methods included from Api::Endpoints::Courses::Import

#get_course_import, #post_course_import

Methods included from Api::Endpoints::Courses::Configuration

#get_course_configuration, #get_course_configuration_setting, #post_course_configuration, #put_course_configuration_setting

Methods included from Api::Endpoints::Courses

#delete_course, #get_course_detail, #get_course_preview, #get_courses

Methods included from Api::Endpoints::Configuration

#delete_app_configuration, #get_app_configuration, #post_app_configuration

Methods included from Api::Endpoints::About

#get_about, #get_about_user_count

Methods included from Faraday::Request

#api_v1, #api_v2, #delete, #get, #post, #put

Methods included from Faraday::Connection

#base_uri

Constructor Details

#initialize(tenant:, tenant_creator: nil) ⇒ Client

Returns a new instance of Client.



13
14
15
16
17
 
# File 'lib/scorm_engine/client.rb', line 13

def initialize(tenant:, tenant_creator: nil)
  @tenant = tenant
  @tenant_creator = tenant_creator
  @api_version = 2 # Default to API v2
end

Instance Attribute Details

#tenant ⇒ Object (readonly)

Returns the value of attribute tenant.



11
12
13
 
# File 'lib/scorm_engine/client.rb', line 11

def tenant
  @tenant
end

#tenant_creator ⇒ Object (readonly)

Returns the value of attribute tenant_creator.



11
12
13
 
# File 'lib/scorm_engine/client.rb', line 11

def tenant_creator
  @tenant_creator
end

Instance Method Details

#current_api_version ⇒ Object 



19
20
21
 
# File 'lib/scorm_engine/client.rb', line 19

def current_api_version
  @api_version || 2
end