Class StatementQuery

Namespace

Xapi.Client

Assembly

Xapi.Client.dll

Filters and options for a Statement query (GET on the Statement resource without statementId), IEEE 9274.1.1, 4.1.6.1. Properties left at their defaults are not sent.

public sealed record StatementQuery : IEquatable<StatementQuery>

Inheritance

object

StatementQuery

Implements

IEquatable<StatementQuery>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Activity

Only Statements whose Object is the Activity with this id (activity).

public Iri? Activity { get; init; }

Property Value

Iri?

Agent

Only Statements whose Actor or Object is this Agent or identified Group, or a Group with this Agent as a member (agent).

public Actor? Agent { get; init; }

Property Value

Actor

Ascending

Return the oldest Statements first (ascending).

public bool Ascending { get; init; }

Property Value

bool

Attachments

Also return attachment data, in a multipart/mixed response (attachments). The data ends up in Attachments.

public bool Attachments { get; init; }

Property Value

bool

Format

How much of Agents, Activities and Verbs the LRS returns (format).

public StatementFormat Format { get; init; }

Property Value

StatementFormat

Limit

The page size (limit). null or 0 lets the LRS choose its maximum. Further pages are fetched through More.

public int? Limit { get; init; }

Property Value

int?

Registration

Only Statements with this registration (registration).

public Guid? Registration { get; init; }

Property Value

Guid?

RelatedActivities

Also match Activity in context Activities and SubStatements (related_activities).

public bool RelatedActivities { get; init; }

Property Value

bool

RelatedAgents

Also match Agent as authority, instructor, team, context Agent or Group, and in SubStatements (related_agents).

public bool RelatedAgents { get; init; }

Property Value

bool

Since

Only Statements stored after this time, exclusive (since).

public DateTimeOffset? Since { get; init; }

Property Value

DateTimeOffset?

Until

Only Statements stored at or before this time (until).

public DateTimeOffset? Until { get; init; }

Property Value

DateTimeOffset?

Verb

Only Statements with this Verb id (verb).

public Iri? Verb { get; init; }

Property Value

Iri?