Table of Contents

Class ScormClient

Namespace
Shift.Common.Scorm
Assembly
Shift.Common.dll
public class ScormClient
Inheritance
ScormClient
Inherited Members
Extension Methods

Constructors

ScormClient(IHttpClientFactory, IJsonSerializerBase)

public ScormClient(IHttpClientFactory factory, IJsonSerializerBase serializer)

Parameters

factory IHttpClientFactory
serializer IJsonSerializerBase

Methods

CreateImport(string, bool, string, string, string, Stream)

public string CreateImport(string courseSlug, bool mayCreateNewVersion, string callbackUrl, string uploadedContentType, string contentMetadata, Stream stream)

Parameters

courseSlug string
mayCreateNewVersion bool
callbackUrl string
uploadedContentType string
contentMetadata string
stream Stream

Returns

string

CreateRegistration(RegistrationRequest)

public void CreateRegistration(RegistrationRequest request)

Parameters

request RegistrationRequest

GetCourses()

public Course[] GetCourses()

Returns

Course[]

GetImportStatus(string)

public CourseImport GetImportStatus(string importSlug)

Parameters

importSlug string

Returns

CourseImport

GetRegistrationId(string, Guid)

public string GetRegistrationId(string courseSlug, Guid learnerId)

Parameters

courseSlug string
learnerId Guid

Returns

string

GetRegistrationInstance(Guid)

public int? GetRegistrationInstance(Guid registrationId)

Parameters

registrationId Guid

Returns

int?

GetRegistrationInstanceProgress(Guid, int?)

public RegistrationProgress GetRegistrationInstanceProgress(Guid registrationId, int? instance)

Parameters

registrationId Guid
instance int?

Returns

RegistrationProgress

GetRegistrationLaunchUrl(Guid, string, bool, string, string)

public string GetRegistrationLaunchUrl(Guid registrationId, string courseSlug, bool preview, string callbackUrl, string exitUrl)

Parameters

registrationId Guid
courseSlug string
preview bool
callbackUrl string
exitUrl string

Returns

string

GetRegistrations(string, string)

public (Registration[] Registrations, string More) GetRegistrations(string course, string more = null)

Parameters

course string
more string

Returns

(Registration[] Registrations, string More)

RetrieveCourse(string)

public Course RetrieveCourse(string courseSlug)

Parameters

courseSlug string

Returns

Course