Class XapiClientOptions

Namespace

Xapi.Client

Assembly

Xapi.Client.dll

Settings for XapiClient. The client copies them when it is created.

public sealed class XapiClientOptions

Inheritance

object

XapiClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Credentials

The credentials sent in the Authorization header of every request, or null to send none (for example when a DelegatingHandler adds them).

public XapiCredentials? Credentials { get; set; }

Property Value

XapiCredentials

Endpoint

The LRS endpoint, the base IRL that the resource names (statements, activities/state, …) are appended to, for example https://lrs.example.com/xapi/. A missing trailing slash is added.

public Uri? Endpoint { get; set; }

Property Value

Uri

ValidateBeforeSend

Whether Statements are validated with StatementValidator before they are sent. Defaults to true. Invalid Statements then fail with XapiValidationException without a request, instead of a 400 from the LRS.

public bool ValidateBeforeSend { get; set; }

Property Value

bool

Remarks

The check also matches attachment data with the Statements: every Attachment without a fileUrl needs an AttachmentPayload with the same SHA-2 (AttachmentPayloadMissing), and every payload must belong to an Attachment (AttachmentPayloadUnreferenced).

Version

The xAPI version to speak. When null (the default), the client asks the About resource once, before its first request, and uses the highest version both sides support: 2.0.0, then 1.0.3.

public XapiVersion? Version { get; set; }

Property Value

XapiVersion?