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

Shared modules for the Loop product suite.

export interface LoopAssignmentPayload {

    /**
     * The name of the assignment
     *
     * @type {string}
     * @memberOf LoopAssignmentPayload
     */
    name?: string;

    /**
     * The description of the assignment
     *
     * @type {string}
     * @memberOf LoopAssignmentPayload
     */
    description?: string;

    /**
     * The identities of the users to assign the assignment
     *
     * @type {string[]}
     * @memberOf LoopAssignmentPayload
     */
    assignees?: string[];

    /**
     * The generated unique identity of the loop assignment
     *
     * @type {string}
     * @memberOf LoopAssignmentPayload
     */
    identity: string;

    /**
     * The generated unique identity used to group all assignments created at the same time
     *
     * @type {string}
     * @memberOf LoopAssignmentPayload
     */
    groupIdentity?: string;

    /**
     * The UTC timestamp of when the assignment was revoked (optional)
     *
     * @type {number}
     * @memberOf LoopAssignmentPayload
     */
    revokedAt?: number;

    /**
     * The UTC timestamp of when the assignment is due at (optional)
     *
     * @type {number}
     * @memberOf LoopAssignmentPayload
     */
    dueAt?: number;

    // unused
    hiddenForAssignee?: number;
    // unused
    hiddenForAssigner?: number;

    isSubmitted?: boolean;
    isReviewed?: boolean;

    /**
     * The collection of content identities to assign
     *
     * @type {string[]}
     * @memberOf LoopAssignmentPayload
     */
    content?: string[];

    /**
     * The collection of scenario identities to assign
     *
     * @type {string[]}
     * @memberOf LoopAssignmentPayload
     */
    scenarios?: string[];

    /**
     * The collection of objection identities to assign
     *
     * @type {string[]}
     * @memberOf LoopAssignmentPayload
     */
    objections?: string[];
}