Function getStatement

  • getStatement function.

    Parameters

    • lmsUserID: string

      The LMS user ID of the current user.

    • verb: string

      The verb of the xAPI statement.

    • path: string

      The path of the parent page.

    • componentID: string

      The ID of the component.

    • componentName: string

      The name of the component.

    • getEnglishName: ((key) => string)

      The function to translate a page name to english.

        • (key): string

        • Parameters

          • key: string

          Returns string

    • filePath: string

      The file path of the component that sends an xAPI statement.

    Returns {
        actor: {
            account: {
                homePage: string;
                name: string;
            };
        };
        context: {
            contextActivities: undefined | {
                grouping?: undefined;
                parent: {
                    definition: {
                        name: {
                            en: string;
                        };
                        type: string;
                    };
                    id: string;
                }[];
            } | {
                grouping: {
                    definition: {
                        name: {
                            en: string;
                        };
                        type: string;
                    };
                    id: string;
                }[];
                parent: {
                    definition: {
                        name: {
                            en: string;
                        };
                        type: string;
                    };
                    id: string;
                }[];
            };
            extensions: {
                https://lrs.learninglocker.net/define/extensions/info: {
                    domain: string;
                    domain_version: string;
                    event_function: string;
                    github: string;
                };
            };
            language: string;
            platform: string;
        } | {
            contextActivities?: undefined;
            extensions: {
                https://lrs.learninglocker.net/define/extensions/info: {
                    domain: string;
                    domain_version: string;
                    event_function: string;
                    github: string;
                };
            };
            language: string;
            platform: string;
        };
        object: {
            definition: {
                name: {
                    en: string;
                };
                type: string;
            };
            id: string;
        };
        timestamp: string;
        verb: {
            display: {
                en: string;
            };
            id: string;
        };
    }

    • An xAPI statement.
    • actor: {
          account: {
              homePage: string;
              name: string;
          };
      }
      • account: {
            homePage: string;
            name: string;
        }
        • homePage: string
        • name: string
    • context: {
          contextActivities: undefined | {
              grouping?: undefined;
              parent: {
                  definition: {
                      name: {
                          en: string;
                      };
                      type: string;
                  };
                  id: string;
              }[];
          } | {
              grouping: {
                  definition: {
                      name: {
                          en: string;
                      };
                      type: string;
                  };
                  id: string;
              }[];
              parent: {
                  definition: {
                      name: {
                          en: string;
                      };
                      type: string;
                  };
                  id: string;
              }[];
          };
          extensions: {
              https://lrs.learninglocker.net/define/extensions/info: {
                  domain: string;
                  domain_version: string;
                  event_function: string;
                  github: string;
              };
          };
          language: string;
          platform: string;
      } | {
          contextActivities?: undefined;
          extensions: {
              https://lrs.learninglocker.net/define/extensions/info: {
                  domain: string;
                  domain_version: string;
                  event_function: string;
                  github: string;
              };
          };
          language: string;
          platform: string;
      }
    • object: {
          definition: {
              name: {
                  en: string;
              };
              type: string;
          };
          id: string;
      }
      • definition: {
            name: {
                en: string;
            };
            type: string;
        }
        • name: {
              en: string;
          }
          • en: string
        • type: string
      • id: string
    • timestamp: string
    • verb: {
          display: {
              en: string;
          };
          id: string;
      }
      • display: {
            en: string;
        }
        • en: string
      • id: string

    Remarks

    getStatement presents a function that can be used to get an xAPI statement. The resulting statement can be used to send data to an LRS.

Settings

Member Visibility

Theme

Generated using TypeDoc