State Resource

Manages learner state for an activity.

createState

Creates or merges into a state document by the agent, activity identifier and state identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
const stateId: string = activityId + "/states/myStateId"
const state = {
myKey: "myValue"
}
xapi.createState(agent, activityId, stateId, state);

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

stateId

string

true

The URI of the state to be created or merged into.

state

any

true

The state data to be stored.

registration

string

false

The registration associated with this state.

etag

string

false

The ETag of the original document if merging.

matchHeader

string

false

The ETag header type. Accepts "If-Match" or "If-None-Match".

Returns

This method returns an AxiosPromise with empty success data if successful.

setState

Creates or overwrites a state document by the agent, activity identifier and state identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
const stateId: string = activityId + "/states/myStateId"
const state = {
myKey: "myValue"
}
xapi.setState(agent, activityId, stateId, state);

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

stateId

string

true

The URI of the state to be created or overwritten.

state

any

true

The state data to be stored.

registration

string

false

The registration associated with this state.

etag

string

false

The ETag of the original document if overwriting.

matchHeader

string

false

The ETag header type. Accepts "If-Match" or "If-None-Match".

contentType

string

false

The content type of the state data.

Returns

This method returns an AxiosPromise with empty success data if successful.

getStates

Gets an array of state identifiers by the agent and activity identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
xapi.getStates(agent, activityId).then((result: AxiosResponse) => {
const states: string[] = result.data;
console.log(states); // ["https://example.com/activities/test-activity/states/myStateId"]
});

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

registration

string

false

The registration associated with this state.

since

Timestamp

false

Only return States stored since specified Timestamp.

Returns

This method returns an AxiosPromise with the success data containing an array of state identifiers if successful.

getState

Gets a state document by the agent, activity identifier and the state identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
const stateId: string = activityId + "/states/myStateId"
xapi.getState(agent, activityId, stateId).then((result: any) => {
const state = result.data;
// do stuff with state
});

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

stateId

string

true

The URI of the state to be retrieved.

registration

string

false

The registration associated with this state.

Returns

This method returns an AxiosPromise with the success data containing the stored document if successful.

deleteState

Deletes a state document by the agent, activity identifier and the state identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
const stateId: string = activityId + "/states/myStateId"
xapi.deleteState(agent, activityId, stateId);

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

stateId

string

true

The URI of the state to be deleted.

registration

string

false

The registration associated with this stage.

etag

string

false

The ETag of the original document.

Returns

This method returns an AxiosPromise with empty success data if successful.

deleteStates

Deletes all state documents by the agent and activity identifier.

Example

const agent: Agent = {
objectType: "Agent",
name: "Test Agent",
mbox: "mailto:[email protected]"
};
const activityId: string = "https://example.com/activities/test-activity";
xapi.deleteStates(agent, activityId);

Parameters

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

activityId

string

true

The URI of the activity.

registration

string

false

The registration associated with this stage.

etag

string

false

The ETag of the original document if overwriting.

Returns

This method returns an AxiosPromise with empty success data if successful.