com.leafdigital.idle.api
Interface Idle

All Superinterfaces:
Singleton

public interface Idle
extends Singleton

Singleton that is used to indicate when the user does something that means they aren't idle, from the point of view of auto-away detection.


Field Summary
static java.lang.String AWAKE_COMMAND
          Reason for awakeness: command typed.
static java.lang.String AWAKE_UNAWAY
          Reason for awakeness: '/away' command sent.
 
Method Summary
 void userAwake(java.lang.String action)
          Notifies the system that the user did something and is therefore not idle.
 

Field Detail

AWAKE_COMMAND

static final java.lang.String AWAKE_COMMAND
Reason for awakeness: command typed.

See Also:
Constant Field Values

AWAKE_UNAWAY

static final java.lang.String AWAKE_UNAWAY
Reason for awakeness: '/away' command sent.

See Also:
Constant Field Values
Method Detail

userAwake

void userAwake(java.lang.String action)
Notifies the system that the user did something and is therefore not idle.

Parameters:
action - Type of action (AWAKE_xx constant)


Copyright © 2011 Samuel Marshall. All rights reserved.