Interface IContentUserData

Saves the current state of users, so that users can resume where they left off.

interface IContentUserData {
    contentId?: string;
    contextId?: string;
    dataType: string;
    invalidate: boolean;
    preload: boolean;
    subContentId: string;
    userId?: string;
    userState: string;
}

Properties

contentId? contextId? dataType invalidate preload subContentId userId? userState

Properties

OptionalcontentId

contentId?: string

The id of the content object to which this state belongs.

OptionalcontextId

contextId?: string

An identifier that can be used to have multiple states for one content - user tuple. The identifier is provided by the implementation and its use is optional. contextId is an extension of the NodeJS library and not standard H5P.

dataType

dataType: string

Used by the h5p.js client

invalidate

invalidate: boolean

Indicates that data should be invalidated when content changes. The server then deletes the state when the content is updated.

preload

preload: boolean

Indicates that data should be included in the H5PIntegration object when content is first loaded. (This is usually on. It is set by the content type.)

subContentId

subContentId: string

The id provided by the h5p.js client call

OptionaluserId

userId?: string

The id of the user to which the state belongs.

userState

userState: string

The actual user state as string. This is typically a serialized JSON string that the content type generates when called by the H5P client. We don't need to know what is in it for the server

Settings

Member Visibility

On This Page

Properties