CogniFit SDK

Connect your Angular web apps with CogniFit. Launch CogniFit session for your users.

Requirements

• Contact CogniFit to register your partner and get your credentials.

• Use the CogniFit API or the CogniFit PHP SDK to register users on CogniFit and to get access tokens.

Installation

  $ npm install @cognifit/launcher-js-sdk

Usage

• Request a CogniFit user access token

  Use the CogniFit API or the CogniFit PHP SDK to get an active access token for the user.

• Initialize CogniFit SDK

  import { CognifitSdk } from '@cognifit/launcher-js-sdk';
  import { CognifitSdkConfig } from '@cognifit/launcher-js-sdk/lib/lib/cognifit.sdk.config';
  
  
  containerId: string               // Target container for CogniFitLoading.
  clientId: string;                 // Provided by CogniFit agent.
  cognifitUserAccessToken: string;  // Requested in previous section. 
  sandbok: boolean;                 // Default false. Sandbox needs to be allowed by CogniFit agent.
   
  const cognifitSdkConfig = new CognifitSdkConfig(
    containerId,
    clientId,
    cognifitUserAccessToken,
    {
      sandbox: false,
      appType: 'web',                 // 'web' or 'app'.
      theme: 'light',                 // 'light' or 'dark'.
      showResults: false,
      customCss: '',                  // Url to custom css file.
      screensNotToShow: [],           // List of screens not to show after the session.
      preferredMobileOrientation: '', // '' (empty), 'landscape' or 'portrait'. This applies only on mobile browsers or embedded webviews
      isFullscreenEnabled: true,      // Default true. If false the App will consider that the browser doesn't support fullscreen mode.
      scale: 100,                     // Default 800. Maximum value used to display values.
      listenEvents: true              // Default false. If true, events will be triggered during session life.
    }   
  );
  
  cognifitSdk.init(cognifitSdkConfig).then(response => {
    
  }).catch(error => {
    
  });

  ---

  Note about isFullscreenEnabled: if set to false our web App will behave as if the browser does not support fullscreen mode. This means there will not be a button to enter fullscreen mode. Additionally our code will not ask the user to enter fullscreen mode if the browser window is smaller than the recommended window size. The recommended window size is currently 890x600 pixels for desktop, and 568x320 pixels for mobile. A warning will be emitted in the browser's console if the window size goes below these values.

• Launch session

  typeValue: string;
  keyValue: string;
  
  cognifitSdk.start(
    typeValue, 
    keyValue
  ).subscribe({
      next: (cognifitSdkResponse) => {
        if (cognifitSdkResponse.isSessionCompleted()) {
          cognifitSdkResponse.typeValue;
          cognifitSdkResponse.keyValue;
        }
        if (cognifitSdkResponse.isSessionAborted()) {
          
        }
        if (cognifitSdkResponse.isErrorLogin()) {
  
        }
        if (cognifitSdkResponse.isEvent()) {
          const eventPayloadValues = cognifitSdkResponse.eventPayload.getValues();
        }
      },
      complete: () => {
    		
  	},
      error: (reason) => {
    		
  	}
  });

  • typeValue: 'ASSESSMENT', 'TRAINING', 'GAME'
  • keyValue: Get accepted values on CogniFit API
    • Assessments: Assessment list
    • Training Training list
    • Games: Brain Game List

Errors

• In initialization

  When calling cognifitSdk.init or cognifitSdk.start some errors could be return. Error can be retreive using:

  • cognifitSdk.cognifitSdkError.getError()
  • cognifitSdk.cognifitSdkError.getMessage()

• Launching session