Package ai.nexconn.call.api

Enum Class NCCallUserState

java.lang.Object
java.lang.Enum<NCCallUserState>
ai.nexconn.call.api.NCCallUserState
All Implemented Interfaces:
Serializable, Comparable<NCCallUserState>, Constable
public enum NCCallUserState extends Enum<NCCallUserState>
User state during a call.

  • Enum Constant Details

    • NONE

      public static final NCCallUserState NONE
      Invalid state. This normally does not occur for users and is usually used as the default enum value.

    • IDLE

      public static final NCCallUserState IDLE
      Idle state. The user is not currently in an audio or video call.

    • CALLING

      public static final NCCallUserState CALLING
      Calling state. The user is calling another user.

    • INVITED

      public static final NCCallUserState INVITED
      Invited state. Example: user A and user B are in an audio/video call, and user A calls NCCallEngine.inviteToCall(List) to invite user C. Before user C answers successfully, user C is in this state from the perspective of user A and user B.

    • RINGING

      public static final NCCallUserState RINGING
      Ringing state. After a user receives a call invitation, the SDK sends this state to remote users. It is only a marker and is unrelated to whether the device ringtone is playing.

    • BUSY_LINE_RINGING

      public static final NCCallUserState BUSY_LINE_RINGING
      Busy-line (ringing) state. Example: user A is calling user B, and user C calls user A or B. User A and user B appear in this state to user C.

    • BUSY_LINE_WAIT

      public static final NCCallUserState BUSY_LINE_WAIT
      Busy-line (in call) state. Example: user A and user B are in a call, and user C calls user A or B. User A and user B appear in this state to user C.

    • CONNECTING

      public static final NCCallUserState CONNECTING
      Connecting state. The user enters this state after successfully calling NCCallEngine.acceptCall(String) or NCCallEngine.joinCall(String).

    • ON_CALL

      public static final NCCallUserState ON_CALL
      In-call state. The user has successfully established an audio/video call.

    • ENDED

      public static final NCCallUserState ENDED
      Call ended state.

    • NO_ANSWER

      public static final NCCallUserState NO_ANSWER
      No-answer state. Example: user A places a one-to-one call to user B, and user B never answers. After the call times out and ends, user A is in `NO_ANSWER` and user B is in `MISSED`.

    • MISSED

      public static final NCCallUserState MISSED
      Missed state. Example: user A places a one-to-one call to user B, and user B never answers. After the call times out and ends, user A is in `NO_ANSWER` and user B is in `MISSED`.

    • CANCELED

      public static final NCCallUserState CANCELED
      Canceled state. Example: user A calls user B and hangs up successfully before user B answers. User A is then in the canceled state.

    • DECLINED

      public static final NCCallUserState DECLINED
      Declined state. Example: user A calls user B and user B directly hangs up the call. User B is then in the declined state.

    • ERROR

      public static final NCCallUserState ERROR
      Error state. The user's state is abnormal on the server.

  • Method Details

    • values

      public static NCCallUserState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static NCCallUserState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Returns the numeric value of the user state.

    • getCallUserSessionStatus

      public static NCCallUserState getCallUserSessionStatus(int code)
      Resolves the user state from its numeric value.
      Parameters:
      code - state value
      Returns:
      the matching state, or NONE for unknown values