loop-modules/interfaces/loop-session-payload.interface.ts

Shared modules for the Loop product suite.

import { LoopSessionDocumentAction } from './loop-session-document-action-payload.interface';

export interface LoopSessionPayload {

    /**
     * The user identity of the reviewee
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    reviewee?: string;

    /**
     * The user identity of the reviewer
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    reviewer?: string;

    /**
     * The UTC timestamp of when the session was started
     *
     * @type {number}
     * @memberOf LoopSessionPayload
     */
    startTime?: number;

    /**
     * The UTC timestamp of when the session was ended
     *
     * @type {number}
     * @memberOf LoopSessionPayload
     */
    endTime?: number;

    /**
     * The generated unique identity of the recorded role-play session
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    identity: string;

    /**
     * The title of the role-play session (used in the session's library)
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    title?: string;

    /**
     * The location of the record role-play session in Amazon S3's services
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    videoURL?: string;

    /**
     * The reviewer's feedback notes on the role-play session (if paired mode)
     *
     * @type {string}
     * @memberOf LoopSessionPayload
     */
    feedbackNotes?: string;

    /**
     * The recorded document actions for the role-play session
     *
     * @type {LoopSessionDocumentAction[]}
     * @memberOf LoopSessionPayload
     */
    documentActions?: LoopSessionDocumentAction[];

    /**
     * The collection of user identities to share the role-play session with
     *
     * @type {string[]}
     * @memberOf LoopSessionPayload
     */
    share?: string[];

    /**
     * The collection of content identities used within the role-play session
     *
     * @type {string[]}
     * @memberOf LoopSessionPayload
     */
    content?: string[];

    /**
     * The collection of loop session scenario identities used within the role-play session
     *
     * @type {string[]}
     * @memberOf LoopSessionPayload
     */
    scenarios?: string[];

    /**
     * The collection of loop session objection identities used within the role-play session
     *
     * @type {string[]}
     * @memberOf LoopSessionPayload
     */
    objections?: string[];

}