RemoteLRS class

Class used to communicate with a TinCan API endpoint

Inheritance

• Object
• LRS
• RemoteLRS

Constructors

RemoteLRS({dynamic endpoint, String? username, String? password, Version? version, Map? extended, bool prettyJson = false, Client? client})

Properties

auth → String?

final

endpoint → ValidatedUri?

final

extended → Map?

final

hashCode → int

The hash code for this object.

no setter, inherited

prettyJson → bool

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

about() → Future<LRSResponse<About>>

Method used to determine the LRS version

override

clearState(Activity? activity, Agent? agent, {String? registration}) → Future<LRSResponse>

Remove all state values

override

deleteActivityProfile(ActivityProfileDocument profile) → Future<LRSResponse>

Remove an activity profile

override

deleteAgentProfile(AgentProfileDocument profile) → Future<LRSResponse>

Remove an agent profile

override

deleteState(StateDocument state) → Future<LRSResponse>

Remove a state value

override

moreStatements(String? moreURL) → Future<LRSResponse<StatementsResult>?>

Fetch more statements from a previous query

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

queryStatements(StatementsQuery query) → Future<LRSResponse<StatementsResult>>

Fetch a set of statements

override

retrieveActivity(String id) → Future<LRSResponse<Activity>>

Retrieve a full description of an Activity from the LRS

override

retrieveActivityProfile(String id, Activity? activity) → Future<LRSResponse<ActivityProfileDocument>>

Retrieve an activity profile value

override

retrieveActivityProfileIds(Activity? activity) → Future<LRSResponse<List<String>>>

Retrieve the list of IDs for an activity profile

override

retrieveAgentProfile(String id, Agent? agent) → Future<LRSResponse<AgentProfileDocument>>

Retrieve an agent profile by id and agent in document identifier

override

retrieveAgentProfileIds(Agent? agent, {DateTime? since}) → Future<LRSResponse<List<String>>>

Retrieve the list of profileIds for an agent profile

override

retrievePerson(Agent? agent) → Future<LRSResponse<Person>>

Retrieve an agent

override

retrieveState(String? id, Activity? activity, Agent? agent, {String? registration}) → Future<LRSResponse<StateDocument>>

Retrieve a state value by id with activity in document identifier and agent in document identifier

override

retrieveStateIds(Activity? activity, Agent? agent, {String? registration, DateTime? since}) → Future<LRSResponse<List<String>>>

Retrieve the list of IDs for a state optionally limit retrieved states to those associated with a registration and/or those states stored since a specified time

override

retrieveStatement(String? id, [bool attachments = false]) → Future<LRSResponse<Statement>>

Retrieve a statement by id optionally include attachments in multipart response (default: false)

override

retrieveVoidedStatement(String id, [bool attachments = false]) → Future<LRSResponse<Statement>>

Retrieve a voided statement by id optionally include attachments in multipart response (default: false)

override

saveActivityProfile(ActivityProfileDocument profile) → Future<LRSResponse>

Save an activity profile

override

saveAgentProfile(AgentProfileDocument profile) → Future<LRSResponse>

Save an agent profile

override

saveState(StateDocument state) → Future<LRSResponse>

Save a state value

override

saveStatement(Statement statement) → Future<LRSResponse<Statement>>

Save a statement to the LRS

override

saveStatements(List<Statement> statements) → Future<LRSResponse<StatementsResult>>

Save a set of statements to the LRS

override

toString() → String

A string representation of this object.

inherited

updateActivityProfile(ActivityProfileDocument profile) → Future<LRSResponse>

Update an existing activity profile

override

updateAgentProfile(AgentProfileDocument profile) → Future<LRSResponse>

Update an existing agent profile

override

updateState(StateDocument state) → Future<LRSResponse>

Update an existing state value

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

generateAuth(String? username, String? password) → String?