Kofax Mobile SDK API Reference
Public Member Functions | Public Attributes | List of all members
SessionState Enum Reference

An enum which contains various FrontOfficeServer and TotalAgility session state information. More...

Public Member Functions

 SessionState (StateID stateID)
 
ErrorInfo isReachable (TaskType task, StateID parentState)
 
SessionState getNextState (TaskType task, StateID parentState)
 
SessionState getErrorState (TaskType task, StateID parentState)
 

Public Attributes

 SESSION_UNREGISTERED =(StateID.STATE_UNREGISTERED)
 
 SESSION_REGISTERING =(StateID.STATE_REGISTERING)
 
 SESSION_REGISTERED =(StateID.STATE_REGISTERED)
 
 SESSION_LOGGING_IN =(StateID.STATE_LOGGING_IN)
 
 SESSION_LOGGED_IN =(StateID.STATE_LOGGED_IN)
 
 SESSION_GETTING_DOCUMENT_FIELDS =(StateID.STATE_GETTING_DOCUMENT_FIELDS)
 
 SESSION_GETTING_IP_SETTINGS =(StateID.STATE_GETTING_IP_SETTINGS)
 
 SESSION_PREPARING_DOCUMENT_TYPE =(StateID.STATE_PREPARING_DOCUMENT_TYPE)
 
 SESSION_DOCUMENT_TYPE_READY =(StateID.STATE_DOCUMENT_TYPE_READY)
 
 SESSION_SUBMITTING =(StateID.STATE_SUBMITTING)
 
 SESSION_SUBMIT_COMPLETED =(StateID.STATE_SUBMIT_COMPLETED)
 
 SESSION_LOGGING_OUT =(StateID.STATE_LOGGING_OUT)
 
StateID stateID
 

Detailed Description

An enum which contains various FrontOfficeServer and TotalAgility session state information.

Constructor & Destructor Documentation

SessionState ( StateID  stateID)

Member Function Documentation

SessionState getErrorState ( TaskType  task,
StateID  parentState 
)
SessionState getNextState ( TaskType  task,
StateID  parentState 
)
ErrorInfo isReachable ( TaskType  task,
StateID  parentState 
)

Member Data Documentation

SESSION_DOCUMENT_TYPE_READY =(StateID.STATE_DOCUMENT_TYPE_READY)
SESSION_GETTING_DOCUMENT_FIELDS =(StateID.STATE_GETTING_DOCUMENT_FIELDS)
SESSION_GETTING_IP_SETTINGS =(StateID.STATE_GETTING_IP_SETTINGS)
SESSION_LOGGED_IN =(StateID.STATE_LOGGED_IN)
SESSION_LOGGING_IN =(StateID.STATE_LOGGING_IN)
SESSION_LOGGING_OUT =(StateID.STATE_LOGGING_OUT)
SESSION_PREPARING_DOCUMENT_TYPE =(StateID.STATE_PREPARING_DOCUMENT_TYPE)
SESSION_REGISTERED =(StateID.STATE_REGISTERED)
SESSION_REGISTERING =(StateID.STATE_REGISTERING)
SESSION_SUBMIT_COMPLETED =(StateID.STATE_SUBMIT_COMPLETED)
SESSION_SUBMITTING =(StateID.STATE_SUBMITTING)
SESSION_UNREGISTERED =(StateID.STATE_UNREGISTERED)
StateID stateID

The documentation for this enum was generated from the following file:
Untitled Document © 2017 Kofax, Inc. All rights reserved. Use is subject to license terms.