Class Statement

Namespace

Xapi

Assembly

Xapi.Core.dll

An xAPI Statement: an Actor, a Verb and an object, with optional result, context and attachments.

public sealed record Statement : IEquatable<Statement>

Inheritance

object

Statement

Implements

IEquatable<Statement>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

IEEE 9274.1.1, 4.2.2. Stored and Authority are normally set by the LRS, and a Learning Record Provider should leave Version unset. Record equality is exact structural equality; use StatementEquivalence for the standard's immutability comparison.

Constructors

Statement(Actor, Verb, StatementObject)

Creates a Statement.

public Statement(Actor actor, Verb verb, StatementObject @object)

Parameters

actor Actor

Whom the Statement is about.

verb Verb

The action.

object StatementObject

What the action was done to.

Properties

Actor

Whom the Statement is about.

public Actor Actor { get; init; }

Property Value

Actor

Attachments

Attachment headers.

public XapiList<Attachment> Attachments { get; init; }

Property Value

XapiList<Attachment>

Authority

Who asserts the Statement is true. Normally set by the LRS from the credentials used.

public Actor? Authority { get; init; }

Property Value

Actor

Context

Contextual information.

public Context? Context { get; init; }

Property Value

Context

Id

The Statement's id. Assigned by the LRS when absent; Learning Record Providers should set it.

public Guid? Id { get; init; }

Property Value

Guid?

Object

What the action was done to.

public StatementObject Object { get; init; }

Property Value

StatementObject

Result

The measured outcome.

public Result? Result { get; init; }

Property Value

Result

Stored

When the LRS recorded the Statement. Set by the LRS.

public DateTimeOffset? Stored { get; init; }

Property Value

DateTimeOffset?

Timestamp

When the described experience happened. The LRS sets it to Stored when absent.

public DateTimeOffset? Timestamp { get; init; }

Property Value

DateTimeOffset?

Verb

The action.

public Verb Verb { get; init; }

Property Value

Verb

Version

The xAPI version the Statement was accepted with, for example 1.0.3 or 2.0.0. Set by the LRS.

public string? Version { get; init; }

Property Value

string