Class ScormApi

Namespace

Engine.Scorm

Assembly

Engine.Scorm.dll

public class ScormApi

Inheritance

object

ScormApi

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ScormApi(string, string)

public ScormApi(string user, string password)

Parameters

user string

password string

Properties

Password

public string Password { get; }

Property Value

string

UserName

public string UserName { get; }

Property Value

string

Methods

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

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

Parameters

courseSlug string

mayCreateNewVersion bool

postbackUrl string

uploadedContentType string

contentMetadata string

stream Stream

Returns

string

CreateRegistration(Guid, string, Guid, string, string, string)

public void CreateRegistration(Guid registrationId, string courseSlug, Guid learnerId, string learnerEmail, string learnerFirstName, string learnerLastName)

Parameters

registrationId Guid

courseSlug string

learnerId Guid

learnerEmail string

learnerFirstName string

learnerLastName string

GetCourse(string)

public Course? GetCourse(string courseSlug)

Parameters

courseSlug string

Returns

Course

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 registration)

Parameters

registration Guid

Returns

int?

GetRegistrationInstanceProgress(Guid, int?)

public RegistrationProgress GetRegistrationInstanceProgress(Guid registration, int? instance)

Parameters

registration 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 = null, string? more = null)

Parameters

course string

more string

Returns

(Registration[] Registrations, string More)