mendix/session/index.d.ts

Mendix pluggable widgets API

/* Excluded from this release type: clearCachedSessionData */

/**
 * Gets the CSRF token.
 *
 * @returns {string} the CSRF token
 *
 * @example
 * getCSRFToken();
 *
 */
export declare function getCSRFToken(): string;

/**
 * Gets the current user’s {@link GUID}.
 *
 * @returns {GUID} `GUID` of the current user
 *
 * @example
 * getUserId(); // "2533274790395905"
 *
 * */
export declare function getUserId(): GUID_2;

/**
 * Gets the `Name` attribute of the current user.
 *
 * @returns {string} `Name` attribute of the current user
 *
 * @example
 * getUserName(); // "MxAdmin"
 *
 */
export declare function getUserName(): string;

/**
 * Gets names of the current user’s roles.
 *
 * @returns {string[]} names of the current user's roles.
 *
 */
export declare function getUserRoleNames(): string[];

declare type GUID_2 = string & {
    __guidTag: any;
};

/**
 * Determines if this is an anonymous session.
 *
 * @returns {boolean} `true` if the current user is anonymous, `false` otherwise
 *
 * @example
 * isGuest();
 *
 */
export declare function isGuest(): boolean;

export { }