Class MongoContentUserDataStorage

MongoDB storage for user data and finished data.

It is highly recommended to call createIndexes on initialization.

Implements

IContentUserDataStorage

Index

Constructors

Methods

createIndexes createOrUpdateContentUserData createOrUpdateFinishedData deleteAllContentUserDataByContentId deleteAllContentUserDataByUser deleteFinishedDataByContentId deleteFinishedDataByUser deleteInvalidatedContentUserData getContentUserData getContentUserDataByContentIdAndUser getContentUserDataByUser getFinishedDataByContentId getFinishedDataByUser

Constructors

constructor

new MongoContentUserDataStorage(
userDataCollection: Collection<IContentUserData>,
finishedCollection: Collection<IFinishedUserData>,
): MongoContentUserDataStorage
Parameters
- userDataCollection: Collection<IContentUserData>
  a MongoDB collection (read- and writable)
- finishedCollection: Collection<IFinishedUserData>
  a MongoDB collection (read- and writable)
Returns MongoContentUserDataStorage
- Defined in MongoContentUserDataStorage.ts:26

Methods

createIndexes

createIndexes(): Promise<void>
Creates indexes to speed up read access. Can be safely used even if indexes already exist.

Returns Promise<void>
- Defined in MongoContentUserDataStorage.ts:37

createOrUpdateContentUserData

createOrUpdateContentUserData(userData: IContentUserData): Promise<void>
Creates or updates the content user data.
Parameters
- userData: IContentUserData
Returns Promise<void>
Implementation of IContentUserDataStorage.createOrUpdateContentUserData
- Defined in MongoContentUserDataStorage.ts:126

createOrUpdateFinishedData

createOrUpdateFinishedData(finishedData: IFinishedUserData): Promise<void>
Saves data when a user completes content or replaces the previous finished data.
Parameters
- finishedData: IFinishedUserData
Returns Promise<void>
Implementation of IContentUserDataStorage.createOrUpdateFinishedData
- Defined in MongoContentUserDataStorage.ts:151

deleteAllContentUserDataByContentId

deleteAllContentUserDataByContentId(contentId: string): Promise<void>
Deletes all userContentData objects for a given contentId. (Used when deleting content) Throws errors if something goes wrong.
Parameters
- contentId: string
  The content id to delete.
Returns Promise<void>
Implementation of IContentUserDataStorage.deleteAllContentUserDataByContentId
- Defined in MongoContentUserDataStorage.ts:187

deleteAllContentUserDataByUser

deleteAllContentUserDataByUser(user: IUser): Promise<void>
Deletes a contentUserData object. (Useful for implementing GDPR rights functionality.) Throws errors if something goes wrong.
Parameters
- user: IUser
  the user of the content user data that should be deleted
Returns Promise<void>
Implementation of IContentUserDataStorage.deleteAllContentUserDataByUser
- Defined in MongoContentUserDataStorage.ts:181

deleteFinishedDataByContentId

deleteFinishedDataByContentId(contentId: string): Promise<void>
Deletes all finished user data of a content object. (Called when the content object is deleted)
Parameters
- contentId: string
Returns Promise<void>
Implementation of IContentUserDataStorage.deleteFinishedDataByContentId
- Defined in MongoContentUserDataStorage.ts:231

deleteFinishedDataByUser

deleteFinishedDataByUser(user: IUser): Promise<void>
Deletes all finished user data for a specific user (across all content objects). (Useful for implementing GDPR rights functionality.)
Parameters
- user: IUser
Returns Promise<void>
Implementation of IContentUserDataStorage.deleteFinishedDataByUser
- Defined in MongoContentUserDataStorage.ts:237

deleteInvalidatedContentUserData

deleteInvalidatedContentUserData(contentId: string): Promise<void>
Deletes all content userData which has the invalidate field set to true. This method is called from the editor when content is changed and the saved contentUserData becomes invalidated.
Parameters
- contentId: string
  The id of the content which to delete
Returns Promise<void>
Implementation of IContentUserDataStorage.deleteInvalidatedContentUserData
- Defined in MongoContentUserDataStorage.ts:172

getContentUserData

getContentUserData(
    contentId: string,
    dataType: string,
    subContentId: string,
    userId: string,
    contextId?: string,
): Promise<IContentUserData>
Loads the contentUserData for given contentId, dataType and subContentId
Parameters
- contentId: string
  The id of the content to load user data from
- dataType: string
  Used by the h5p.js client
- subContentId: string
  The id provided by the h5p.js client call
- userId: string
- OptionalcontextId: string
  an arbitrary value that can be used to save multiple states for one content - user tuple
Returns Promise<IContentUserData>
the data
Implementation of IContentUserDataStorage.getContentUserData
- Defined in MongoContentUserDataStorage.ts:92

getContentUserDataByContentIdAndUser

getContentUserDataByContentIdAndUser(
    contentId: string,
    userId: string,
    contextId?: string,
): Promise<IContentUserData[]>
Lists all associated contentUserData for a given contentId and user.
Parameters
- contentId: string
  The id of the content to load user data from
- userId: string
- OptionalcontextId: string
  an arbitrary value that can be used to save multiple states for one content - user tuple
Returns Promise<IContentUserData[]>
An array of objects containing the dataType, subContentId and the contentUserState as string in the data field.
Implementation of IContentUserDataStorage.getContentUserDataByContentIdAndUser
- Defined in MongoContentUserDataStorage.ts:195

getContentUserDataByUser

getContentUserDataByUser(user: IUser): Promise<IContentUserData[]>
Retrieves all contentUserData for a given user (Useful for implementing GDPR rights functionality.)
Parameters
- user: IUser
  the user for which the contentUserData should be retrieved.
Returns Promise<IContentUserData[]>
Implementation of IContentUserDataStorage.getContentUserDataByUser
- Defined in MongoContentUserDataStorage.ts:114

getFinishedDataByContentId

getFinishedDataByContentId(contentId: string): Promise<IFinishedUserData[]>
Gets the finished data of all users for a specific piece of content.
Parameters
- contentId: string
Returns Promise<IFinishedUserData[]>
Implementation of IContentUserDataStorage.getFinishedDataByContentId
- Defined in MongoContentUserDataStorage.ts:211

getFinishedDataByUser

getFinishedDataByUser(user: IUser): Promise<IFinishedUserData[]>
Gets all finished user data for a specific user (across all content objects). (Useful for implementing GDPR rights functionality.)
Parameters
- user: IUser
Returns Promise<IFinishedUserData[]>
Implementation of IContentUserDataStorage.getFinishedDataByUser
- Defined in MongoContentUserDataStorage.ts:221

Class MongoContentUserDataStorage

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MongoContentUserDataStorage

Methods

createIndexes

Returns Promise<void>

createOrUpdateContentUserData

Parameters

Returns Promise<void>

createOrUpdateFinishedData

Parameters

Returns Promise<void>

deleteAllContentUserDataByContentId

Parameters

Returns Promise<void>

deleteAllContentUserDataByUser

Parameters

Returns Promise<void>

deleteFinishedDataByContentId

Parameters

Returns Promise<void>

deleteFinishedDataByUser

Parameters

Returns Promise<void>

deleteInvalidatedContentUserData

Parameters

Returns Promise<void>

getContentUserData

Parameters

Returns Promise<IContentUserData>

getContentUserDataByContentIdAndUser

Parameters

Returns Promise<IContentUserData[]>

getContentUserDataByUser

Parameters

Returns Promise<IContentUserData[]>

getFinishedDataByContentId

Parameters

Returns Promise<IFinishedUserData[]>

getFinishedDataByUser

Parameters

Returns Promise<IFinishedUserData[]>

Settings

On This Page