import { SncIPAddress } from "./SncIPAddress";

/**
 * GlideSession manages all of the information for a user session. You can retrieve this from gs.getSession()
 */
export declare class GlideSession {
  constructor();

  addErrorMessage(message: string): void;
  addHighMessage(message: string): void;
  addInfoMessage(message: string): void;
  addLowMessage(message: string): void;
  addModerateMessage(message: string): void;
  addSuggestionMessage(message: string): void;
  addSuccessMessage(message: string): void;
  addTrivialMessage(message: string): void;
  addWarningMessage(message: string): void;

  clearClientData(name: string): void;
  clearProperty(key: string): void;
  clearWatchField(): void;

  disableQueryCategoryPool(poolName: string): void;
  static disableSeparation(): void;

  static disconnect(): void;
  static disconnect(releaseMutexes: boolean): void;

  enableSeparation(): void;

  getActivatedElevatedRoles(): string;
  getAvailableElevatedRoles(): string;
  getBooleanProperty(name: string): boolean;
  getBooleanProperty(key: string, bDefault: boolean): boolean;
  getBusinessRuleStack(): any;
  getClientDataMap(): any;
  getCurrentDomainID(): string;
  getCryptoModulePicker(): any;
  getCryptoModulePickerForTableWithSingleModule(tableName: string): any;
  getDateFormat(): string;
  getDateFormat(style: string): string;
  getDateTimeFormat(): string;
  getDateTimeFormat(dateStyle: string): string;
  getEncryptionContext(): any;
  getFullName(): string;
  getHighMessage(): void; // Not in code, but for symmetry
  getKaaProfile(): any;
  getLoginHome(direct: boolean): string;
  getRoles(): string;
  getRoles(includeDefaultRoles: boolean): string;
  getRunEngines(): boolean;
  getSessionID(): string;
  getSessionKey(): string;
  getStack(): any;
  getStackName(): string;
  getStack(stackName: string): any;
  getTimeFormat(): string;
  getTimeZone(): any;
  getTimeZoneName(): string;
  getTimeZoneShortName(): string;
  getUID(): string;
  getURI(): string;
  getUser(): any;
  getUserName(): string;
  getWatchField(): string;
  getWorkflow(): boolean;

  hasRole(appRoles: string): boolean;

  impersonate(userSysId: string): string;
  isInteractive(): boolean;
  isLockedOut(): boolean;
  isLoggedIn(): boolean;
  isOverridingQueryRoute(poolGR: any): boolean;
  isQueryCategoryPoolDisabled(poolName: string): boolean;

  loadUserByID(userSysId: string): any;
  getHttpSession(): any;

  onlineImpersonate(userSysId: string): string;
  onlineUnimpersonate(): string;

  putClientData(name: string, value: string): void;
  putProperty(key: string, value: any): void;

  resetDisabledQueryCategoryPool(poolName: string): void;
  resetOverrideQueryCategoryPool(): void;
  resetURI(): string;

  setCacheFlush(onOrOff: boolean): boolean;
  setCacheIgnoreFlushTable(table: string): string;
  setCurrentDomainID(domainID: string): void;
  setDateFormat(dateFormat: string): void;
  setDomainID(domainID: string): void;
  setInteractive(b: boolean): void;
  setLanguage(language: string): void;
  setOverrideQueryCategoryPool(poolGR: any): void;
  setRunEngines(onOrOff: boolean): boolean;
  setSessionID(string: string): void;
  setStack(s: any): void;
  setStack(stackName: string, s: any): void;
  setTimeFormat(timeFormat: string): void;
  setTimeZoneName(timezoneName: string): void;
  setURI(uri: string): void;
  setWatchField(id: string): void;
  setWorkflow(onOrOff: boolean): boolean;
  static enableSeparation(): void;

  static get(): GlideSession;
  static getSeparationValue(): string;

  /**
   * Fetch the value in active session based on the name
   */
  getClientData(name: string): string;

  /**
   * Gets the client IP address
   */
  getClientIP(): SncIPAddress;

  /**
   * Language used by the user
   */
  getLanguage(): string;

  /**
   * Get the Time Zone name associated with the user
   */
  getTimeZoneName(): string;

  /**
   * Checks if the current session is interactive
   */
  isInteractive(): boolean;

  /**
   * Determines if the current user is currently logged in
   */
  isLoggedIn(): boolean;

  /**
   * Store a value in an active session
   */
  putClientData(name: string, value: string): void;

  getUrlOnStack(): string;
  getSessionToken(): string;
  getCurrentApplicationId(): string;
  isImpersonating(): boolean;
  getApplicationPickerList(): Array<Record<any, any>>;
}