Package rife.continuations

Class CallState

java.lang.Object
rife.continuations.CallState
public class CallState extends Object
Contains the state of a call continuation.

The only really important property is the continuation ID, which should contain the ID of the continuation context that was active when the call was triggered.

The state property is totally optional and is there to be used in case other state needs to be preserved for a call continuation. RIFE2's web engine, for instance, uses it to tie an element's execution state to a call continuation.

Since:
1.0

  • Constructor Details

    • CallState

      public CallState(String continuationId, Object state)
      Creates a new CallState instance.
      Parameters:
      continuationId - the continuation context ID that triggered the call continuation
      state - the optional state that should be tied to the call continuation
      Since:
      1.0

  • Method Details

    • getContinuationId

      public String getContinuationId()
      Retrieves the ID of the continuation that triggered the call.
      Returns:
      the call continuation's ID
      Since:
      1.0

    • getState

      public Object getState()
      Retrieves the optional state that is tied to the call continuation.
      Returns:
      the call continuation's optional state; or

      null if no additional state is tied to it

      Since:
      1.0