Show / Hide Table of Contents

Class UserSettings

Represents the settings that may be manipulated using VISABs Settings view. This class is serialized as json and written to the settings.json file.

Inheritance
java.lang.Object
UserSettings
Inherited Members
java.lang.Object.clone()
java.lang.Object.equals(java.lang.Object)
java.lang.Object.finalize()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long,int)
Namespace:
Assembly: .dll
Syntax
public class UserSettings

Constructors

UserSettings()

Declaration
public UserSettings()

Methods

getAllowedGames()

Gets the allowed games.

Declaration
public ArrayList<String> getAllowedGames()
Returns
Type Description
java.util.ArrayList<java.lang.String>

The list of allowed games

getSessionTimeout()

Gets the time in seconds until a session is automatically timed out if no statistics were received for each game.

Declaration
public HashMap<String,Integer> getSessionTimeout()
Returns
Type Description
java.util.HashMap<java.lang.String,java.lang.Integer>

The timeout of the sessions

getWebApiPort()

Gets the webApiPort.

Declaration
public int getWebApiPort()
Returns
Type Description
int

The port on which the web API is running on

isDarkMode()

Gets the dark mode value.

Declaration
public boolean isDarkMode()
Returns
Type Description
boolean

the dark mode boolean value.

setAllowedGames(ArrayList<String> games)

Sets the allowedGames.

Declaration
public void setAllowedGames(ArrayList<String> games)
Parameters
Type Name Description
java.util.ArrayList<java.lang.String> games

The games that are allowed

setDarkMode(boolean darkMode)

Sets the dark mode value

Declaration
public void setDarkMode(boolean darkMode)
Parameters
Type Name Description
boolean darkMode

the value denoting if dark mode shall be on.

setSessionTimeout(HashMap<String,Integer> timeout)

Sets the sessionTimeouts for each game.

Declaration
public void setSessionTimeout(HashMap<String,Integer> timeout)
Parameters
Type Name Description
java.util.HashMap<java.lang.String,java.lang.Integer> timeout

The timeout of the sessions

setWebApiPort(int port)

Sets the webApiPort.

Declaration
public void setWebApiPort(int port)
Parameters
Type Name Description
int port

The port of the webApi

In This Article
Back to top Generated by DocFX