org.virtualbox_5_2
Enum GuestUserState

java.lang.Object
  extended by java.lang.Enum<GuestUserState>
      extended by org.virtualbox_5_2.GuestUserState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<GuestUserState>

public enum GuestUserState
extends java.lang.Enum<GuestUserState>

State a guest user has been changed to. Interface ID: {B2A82B02-FD3D-4FC2-BA84-6BA5AC8BE198}


Enum Constant Summary
Created
          A guest user has been successfully created.
CredentialsChanged
          To guest OS has changed the authentication credentials of a user.
Deleted
          A guest user has been successfully deleted.
Disabled
          A guest user has been disabled by the guest OS.
Elevated
          To guest OS temporarily has elevated a user to perform a certain task.
GroupAdded
          To guest OS has added a user to a specific user group.
GroupRemoved
          To guest OS has removed a user from a specific user group.
Idle
          A guest user currently is not using the guest OS.The event will be triggered if a guest user is not active for at least 5 seconds.
InUse
          A guest user continued using the guest OS after being idle.
Locked
          A guest user has locked its account.
LoggedIn
          A guest user has been successfully logged into the guest OS.
LoggedOut
          A guest user has been successfully logged out of the guest OS.
RoleChanged
          To guest OS has changed the role of a user permanently, e.g.
SessionChanged
          To guest OS has changed the session of a user.
Unknown
          Unknown state.
Unlocked
          A guest user has unlocked its account.
 
Method Summary
static GuestUserState fromValue(long v)
           
static GuestUserState fromValue(java.lang.String v)
           
 int value()
           
static GuestUserState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static GuestUserState[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Unknown

public static final GuestUserState Unknown
Unknown state. Not being used.


LoggedIn

public static final GuestUserState LoggedIn
A guest user has been successfully logged into the guest OS. NOTE: This property is not implemented yet!


LoggedOut

public static final GuestUserState LoggedOut
A guest user has been successfully logged out of the guest OS. NOTE: This property is not implemented yet!


Locked

public static final GuestUserState Locked
A guest user has locked its account. This might include running a password-protected screensaver in the guest. NOTE: This property is not implemented yet!


Unlocked

public static final GuestUserState Unlocked
A guest user has unlocked its account. NOTE: This property is not implemented yet!


Disabled

public static final GuestUserState Disabled
A guest user has been disabled by the guest OS. NOTE: This property is not implemented yet!


Idle

public static final GuestUserState Idle
A guest user currently is not using the guest OS.The event will be triggered if a guest user is not active for at least 5 seconds. This threshold can be adjusted by either altering VBoxService's command line in the guest to
--vminfo-user-idle-threshold <ms>
, or by setting the per-VM guest property
/VirtualBox/GuestAdd/VBoxService/--vminfo-user-idle-threshold <ms>
with the RDONLYGUEST flag on the host. In both cases VBoxService needs to be restarted in order to get the changes applied. NOTE: Currently only available for Windows guests since Windows 2000 SP2. NOTE: On Windows guests this function currently only supports reporting contiguous idle times up to 49.7 days per user.


InUse

public static final GuestUserState InUse
A guest user continued using the guest OS after being idle.


Created

public static final GuestUserState Created
A guest user has been successfully created. NOTE: This property is not implemented yet!


Deleted

public static final GuestUserState Deleted
A guest user has been successfully deleted. NOTE: This property is not implemented yet!


SessionChanged

public static final GuestUserState SessionChanged
To guest OS has changed the session of a user. NOTE: This property is not implemented yet!


CredentialsChanged

public static final GuestUserState CredentialsChanged
To guest OS has changed the authentication credentials of a user. This might include changed passwords and authentication types. NOTE: This property is not implemented yet!


RoleChanged

public static final GuestUserState RoleChanged
To guest OS has changed the role of a user permanently, e.g. granting / denying administrative rights. NOTE: This property is not implemented yet!


GroupAdded

public static final GuestUserState GroupAdded
To guest OS has added a user to a specific user group. NOTE: This property is not implemented yet!


GroupRemoved

public static final GuestUserState GroupRemoved
To guest OS has removed a user from a specific user group. NOTE: This property is not implemented yet!


Elevated

public static final GuestUserState Elevated
To guest OS temporarily has elevated a user to perform a certain task. NOTE: This property is not implemented yet!

Method Detail

values

public static GuestUserState[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GuestUserState c : GuestUserState.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GuestUserState valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public int value()

fromValue

public static GuestUserState fromValue(long v)

fromValue

public static GuestUserState fromValue(java.lang.String v)