diffusion/src/features/session-lock-options.js

Diffusion JavaScript client

/**
 * Provide access to {@link SessionLockScope}
 *
 * @example
 * // Get a reference to the security feature
 * var locks = diffusion.locks;
 *
 * @namespace diffusion.locks
 */

/**
 * Enum containing <code>scope</code> parameter of {@link Session#lock}
 *
 * @example
 * // Get the ALL_FIXED_PROPERTIES key
 * var scope = diffusion.locks.SessionLockScope.UNLOCK_ON_SESSION_LOSS;
 *
 *
 * @readonly
 * @enum
 * @memberOf diffusion.locks
 * @alias SessionLockScope
 * @since 6.2
 */
var SessionLockScope = {
    /**
     * The lock will be released when the acquiring session is closed.
     */
    UNLOCK_ON_SESSION_LOSS: 0,
    /**
     * The lock will be released when the acquiring session loses its
     * current connection to the server.
     */
    UNLOCK_ON_CONNECTION_LOSS: 1
};

module.exports.SessionLockScope = SessionLockScope;