public interface IAppHistory
IAppSessionGyro
instance.Modifier and Type | Method and Description |
---|---|
boolean |
clearBackwardEntries(boolean alsoRemoveCurrent)
Clears all backward history entries prior to the current one, with optional removal of the
current backward entry.
|
boolean |
clearForwardEntries()
Clears the index entries from the current location to the end, removing potential
forward history actions.
|
IAppSessionGyro |
getAppSessionGyro()
Returns the application session gyro.
|
IAppHistoryEntry[] |
getEntries()
Clears the index entries from the current location to the end, removing potential
forward history actions.
|
int |
getEntryCount()
Clears the index entries from the current location to the end, removing potential
forward history actions.
|
int |
getIndex()
Gets the current history entry index.
|
String |
isBackwardEnabled(IClientSessionGyro clientGyro)
Returns if the backward operation is enabled or not.
|
String |
isForwardEnabled(IClientSessionGyro clientGyro)
Returns if the forward operation is enabled or not.
|
String |
performBackward(IClientSessionGyro clientGyro,
IAppHistoryOperationCompleted completedCallback)
Performs the backward operation for the client session in question.
|
String |
performForward(IClientSessionGyro clientGyro,
IAppHistoryOperationCompleted completedCallback)
Performs the forward operation for the client session in question.
|
IAppSessionGyro getAppSessionGyro()
boolean clearBackwardEntries(boolean alsoRemoveCurrent)
alsoRemoveCurrent
- Flag to also remove the current backward entry.boolean clearForwardEntries()
int getEntryCount()
IAppHistoryEntry[] getEntries()
int getIndex()
String isBackwardEnabled(IClientSessionGyro clientGyro)
If a null String
is returned, the operation is enabled, otherwise the string
is the reason why to operation is disabled. This reason is used typically for developers,
logging and debugging.
clientGyro
- The client session requesting the backward operation enabled state.null
meaning enabled, otherwise the reason string for being disabled.String isForwardEnabled(IClientSessionGyro clientGyro)
If a null String
is returned, the operation is enabled, otherwise the string
is the reason why to operation is disabled. This reason is used typically for developers,
logging and debugging.
clientGyro
- The client session requesting the forward operation enabled state.null
meaning enabled, otherwise the reason string for being disabled.String performBackward(IClientSessionGyro clientGyro, IAppHistoryOperationCompleted completedCallback)
If a null String
is returned, the operation is enabled, otherwise the string
is the reason why to operation is disabled. This reason is used typically for developers,
logging and debugging.
Note: this operation may be lengthy and may not complete in the same thread. This means that the
completedCallback
could be called from another thread.
clientGyro
- The client session requesting the backward operation execution.completedCallback
- The callback is called when operation has completed, null for none.null
meaning enabled and the operation has begun (perhaps not completed yet),
otherwise the reason string for being disabled.String performForward(IClientSessionGyro clientGyro, IAppHistoryOperationCompleted completedCallback)
If a null String
is returned, the operation is enabled, otherwise the string
is the reason why to operation is disabled. This reason is used typically for developers,
logging and debugging.
Note: this operation may be lengthy and may not complete in the same thread. This means that the
completedCallback
could be called from another thread.
clientGyro
- The client session requesting the forward operation execution.completedCallback
- The callback is called when operation has completed, null for none.null
meaning enabled and the operation has begun (perhaps not completed yet),
otherwise the reason string for being disabled.iizi® is a registered trademark of Mindus SARL. © Copyright 2019 Mindus SARL. All rights reserved.