ConstantsMCOP.CallEventExtras

java.lang.Object
- org.mcopenplatform.muoapi.ConstantsMCOP.CallEventExtras

Enclosing class:: ConstantsMCOP

public static class ConstantsMCOP.CallEventExtras
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConstantsMCOP.CallEventExtras.CallEventTypeEnum

static class ConstantsMCOP.CallEventExtras.CallTypeEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConstantsMCOP.CallEventExtras.CallEventTypeEnum`
`static class`	`ConstantsMCOP.CallEventExtras.CallTypeEnum`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CALL_TYPE` Key Access to the call type.
`static java.lang.String`	`CALLER_FUNCTIONAL_ALIAS` Key Access to the current functional alias of the caller user.
`static java.lang.String`	`CALLER_ID` Key Access to the MCS Identity of the caller user.
`static java.lang.String`	`ERROR_CODE` Key Access to the error codes associated to the call events.
`static java.lang.String`	`ERROR_STRING` Key Access to error string associated to the call events.
`static java.lang.String`	`EVENT_TYPE` Key Access to the call event type.
`static java.lang.String`	`GROUP_ID` Key Access to the caller group identity Response: String type value representing the identifier The call event types in which this tag can be present are: CallEventIncoming `ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventIncoming` CallEventConnected `ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventConnected`
`static java.lang.String`	`SESSION_ID` Key Access to the call session identifier.
`static java.lang.String`	`TAG_CALL_ANSWER_MODE_KEY` Key Access to the call optional answer mode tag.
`static java.lang.String`	`TAG_CALL_EMERG_ALERT_KEY` Key Access to the call optional emergency alert activation tag.
`static java.lang.String`	`TAG_CALL_IMPLICIT_GRANTED_KEY` Key Access to the call optional implicit granted tag.
`static java.lang.String`	`TAG_CALL_IMPLICIT_REQUEST_KEY` Key Access to the call optional implicit request tag.
`static java.lang.String`	`TAG_CALL_MIC_MUTE_KEY` Key Access to the call optional microphone mute tag.
`static java.lang.String`	`TAG_CALL_SPEAKER_MUTE_KEY` Key Access to the call optional speaker mute tag.

Constructor Summary

Constructors
Constructor and Description

CallEventExtras()

Constructors
Constructor and Description
`CallEventExtras()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EVENT_TYPE
```
public static final java.lang.String EVENT_TYPE
```
    Key Access to the call event type. See ConstantsMCOP.CallEventExtras.CallEventTypeEnum for all possible values.
    
    Integer type value
    
    This parameter is included in all call type events ConstantsMCOP.CallEventExtras.CallEventTypeEnum
    
    See Also:
    
    Constant Field Values
  - SESSION_ID
```
public static final java.lang.String SESSION_ID
```
    Key Access to the call session identifier. This identifier is unique for each call.
    
    Response: String type value
    
    This parameter is included in all call type events ConstantsMCOP.CallEventExtras.CallEventTypeEnum
    
    See Also:
    
    Constant Field Values
  - CALL_TYPE
```
public static final java.lang.String CALL_TYPE
```
    Key Access to the call type. See ConstantsMCOP.CallEventExtras.CallTypeEnum for all possible values.
    
    Response: Integer type value
    
    The call event types in which this tag can be present are:
    
    CallEventIncoming ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventIncoming
    
    CallEventRinging ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventRinging
    
    CallEventConnected ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventConnected
    
    CallEventUpdated ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventUpdated
    
    See Also:
    
    Constant Field Values
  - CALLER_ID
```
public static final java.lang.String CALLER_ID
```
    Key Access to the MCS Identity of the caller user. Depending on whether the call is MCPTT or MCVIDEO, this tag will contain the MCPTT ID or MCVIDEO ID, respectively.
    
    Response: String type value representing the identifier
    
    The call event types in which this tag can be present are:
    
    CallEventIncoming ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventIncoming
    
    CallEventConnected ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventConnected
    
    See Also:
    
    Constant Field Values
  - CALLER_FUNCTIONAL_ALIAS
```
public static final java.lang.String CALLER_FUNCTIONAL_ALIAS
```
    Key Access to the current functional alias of the caller user.
    
    Response: String type value representing the identifier
    
    The call event types in which this tag can be present are:
    
    CallEventIncoming ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventIncoming
    
    CallEventConnected ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventConnected
    
    See Also:
    
    Constant Field Values
  - GROUP_ID
```
public static final java.lang.String GROUP_ID
```
    Key Access to the caller group identity
    
    Response: String type value representing the identifier
    
    The call event types in which this tag can be present are:
    
    CallEventIncoming ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventIncoming
    
    CallEventConnected ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventConnected
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final java.lang.String ERROR_CODE
```
    Key Access to the error codes associated to the call events.
    
    Response: Integer indicating the error code.
    
    The call event types in which this tag can be present are:
    
    CallEventError ConstantsMCOP.CallEventExtras.CallEventTypeEnum.CallEventError
    
    Values:
    
    Code Explanatory text Description
    
    103 maximum simultaneous MCPTT group calls reached The number of maximum simultaneous MCPTT group calls supported for the MCPTT user has been exceeded.
    
    104 isfocus not assigned A controlling MCPTT function has not been assigned to the MCPTT session.
    
    105 subscription not allowed in a broadcast group call Subscription to the conference event package rejected during a group call initiated as a broadcast group call.
    
    106 user not authorised to join chat group The MCPTT user is not authorised to join this chat group.
    
    107 user not authorised to make private calls The MCPTT user is not authorised to make private calls.
    
    108 user not authorised to make chat group calls The MCPTT user is not authorised to make chat group calls.
    
    109 user not authorised to make prearranged group calls The MCPTT user is not authorised to make group calls to a prearranged group.
    
    110 user declined the call invitation The MCPTT user declined to accept the call.
    
    111 group call proceeded without all required group members The required members of the group did not respond within the acknowledged call time, but the call still went ahead.
    
    112 group call abandoned due to required group members not part of the group session The group call was abandoned, as the required members of the group did not respond within the acknowledged call time.
    
    116 user is not part of the MCPTT group The group exists on the group management server but the requesting user is not part of this group.
    
    117 the group identity indicated in the request is a prearranged group The group id that is indicated in the request is for a prearranged group, but did not match the request from the MCPTT user.
    
    118 the group identity indicated in the request is a chat group The group id that is indicated in the request is for a chat group, but did not match the request from the MCPTT user.
    
    119 user is not authorised to initiate the group call The MCPTT user identified by the MCPTT ID is not authorised to initiate the group call.
    
    120 user is not affiliated to this group The MCPTT user is not affiliated to the group.
    
    121 user is not authorised to join the group call The MCPTT user identified by the MCPTT ID is not authorised to join the group call.
    
    122 too many participants The group call has reached its maximum number of participants.
    
    123(INFO) MCPTT session already exists Inform the MCPTT user that the group call is currently ongoing.
    
    124 maximum number of private calls reached The maximum number of private calls allowed at the MCPTT server for the MCPTT user has been reached.
    
    127 user not authorised to be called in private call The called MCPTT user is not allowed to be part of a private call.
    
    144 user not authorised to call this particular user The calling user is not authorised to call this particular called user.
    
    145 unable to determine called party The participating function was unable to determine the called party from the information received in the SIP request.
    
    147(INFO) user is authorized to initiate a temporary group call The non-controlling MCPTT function has authorized a request from the controlling MCPTT function to authorize a user to initiate an temporary group session.
    
    148(INFO) MCPTT group is regrouped The MCPTT group hosted by a non-controlling MCPTT function is part of a temporary group session as the result of the group regroup function.
    
    151 user not authorised to make a private call call-back request The MCPTT user is not authorised to make a private call call-back request.
    
    152 user not authorised to make a private call call-back cancel request The MCPTT user is not authorised to make a private call call-back cancel request.
    
    153 user not authorised to call any of the users requested in the first-to-answer call All users that were invited in the first-to-answer call cannot be involved in a private call with the inviting user.
    
    154 user not authorised to make ambient listening call The MCPTT user is not authorised to make an ambient listening call.
    
    156 user not authorised to originate a first-to-answer call The MCPTT user is not authorised to make a first-to-answer call.
    
    401 Invalid call type.
    
    402 Invalid action.
    
    403 Invalid UserID in MakeCall. The UserID is empty, or does not have URI format
    
    404 The call can not be hung because is not made
    
    405 The call cannot be accepted because it has not received any call for that sessionID
    
    406 The sessionID could not be created
    
    407 The call cannot be made because this unregistered
    
    408 User destination is not available at the moment
    
    409 Undefined signal error
    
    410 The destination is busy
    
    See Also:
    
    Constant Field Values
  - ERROR_STRING
```
public static final java.lang.String ERROR_STRING
```
    Key Access to error string associated to the call events.
    
    Response: String describing the error.
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_ANSWER_MODE_KEY
```
public static final java.lang.String TAG_CALL_ANSWER_MODE_KEY
```
    Key Access to the call optional answer mode tag.
    
    Indicates the answer mode in which the application should answer.
    
    It can be used in call requests indicating the desired answer mode of the called user IMCOPsdk.makeCall(String[], int, String, Map)
    
    Contains a String indicating if the answer mode is "manual" or "auto"
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_EMERG_ALERT_KEY
```
public static final java.lang.String TAG_CALL_EMERG_ALERT_KEY
```
    Key Access to the call optional emergency alert activation tag.
    
    Indicates if the emergency alert wants to be activated or not, while starting the call.
    
    It can be used in call requests indicating emergency alert activation for the called group IMCOPsdk.makeCall(String[], int, String, Map)
    
    Contains a boolean value. True means activate
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_MIC_MUTE_KEY
```
public static final java.lang.String TAG_CALL_MIC_MUTE_KEY
```
    Key Access to the call optional microphone mute tag.
    
    Indicates if it is wanted the microphone to be muted or not when a new call is established.
    
    It can be used in call requests indicating that the microphone wants to be muted IMCOPsdk.makeCall(String[], int, String, Map) and IMCOPsdk.acceptCall(String, Map)
    
    Contains a boolean value. True means activate
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_SPEAKER_MUTE_KEY
```
public static final java.lang.String TAG_CALL_SPEAKER_MUTE_KEY
```
    Key Access to the call optional speaker mute tag.
    
    Indicates if it is wanted the speaker to be muted or not when a new call is established.
    
    It can be used in call requests indicating that the speaker wants to be muted IMCOPsdk.makeCall(String[], int, String, Map) and IMCOPsdk.acceptCall(String, Map)
    
    Contains a boolean value. True means activate
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_IMPLICIT_REQUEST_KEY
```
public static final java.lang.String TAG_CALL_IMPLICIT_REQUEST_KEY
```
    Key Access to the call optional implicit request tag.
    
    Indicates if it is wanted to request implicitly the floor control token when a new call is established.
    
    It can be used in call requests IMCOPsdk.makeCall(String[], int, String, Map)
    
    It is a boolean value. True means activate.
    
    See Also:
    
    Constant Field Values
  - TAG_CALL_IMPLICIT_GRANTED_KEY
```
public static final java.lang.String TAG_CALL_IMPLICIT_GRANTED_KEY
```
    Key Access to the call optional implicit granted tag.
    
    Indicates if it is wanted to grant implicitly the floor control token when a new call is established.
    
    It can be used in call requests IMCOPsdk.makeCall(String[], int, String, Map)
    
    It is a boolean value. True means activate.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CallEventExtras
```
public CallEventExtras()
```

Class ConstantsMCOP.CallEventExtras

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_TYPE

Key Access to the call event type. See `ConstantsMCOP.CallEventExtras.CallEventTypeEnum` for all possible values.

SESSION_ID

Key Access to the call session identifier. This identifier is unique for each call.

CALL_TYPE

Key Access to the call type. See `ConstantsMCOP.CallEventExtras.CallTypeEnum` for all possible values.

CALLER_ID

Key Access to the MCS Identity of the caller user. Depending on whether the call is MCPTT or MCVIDEO, this tag will contain the MCPTT ID or MCVIDEO ID, respectively.

CALLER_FUNCTIONAL_ALIAS

Key Access to the current functional alias of the caller user.

GROUP_ID

Key Access to the caller group identity

ERROR_CODE

Key Access to the error codes associated to the call events.

ERROR_STRING

Key Access to error string associated to the call events.

TAG_CALL_ANSWER_MODE_KEY

Key Access to the call optional answer mode tag.

TAG_CALL_EMERG_ALERT_KEY

Key Access to the call optional emergency alert activation tag.

TAG_CALL_MIC_MUTE_KEY

Key Access to the call optional microphone mute tag.

TAG_CALL_SPEAKER_MUTE_KEY

Key Access to the call optional speaker mute tag.

TAG_CALL_IMPLICIT_REQUEST_KEY

Key Access to the call optional implicit request tag.

TAG_CALL_IMPLICIT_GRANTED_KEY

Key Access to the call optional implicit granted tag.

Constructor Detail

CallEventExtras

Class ConstantsMCOP.CallEventExtras

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_TYPE

Key Access to the call event type. See ConstantsMCOP.CallEventExtras.CallEventTypeEnum for all possible values.

SESSION_ID

Key Access to the call session identifier. This identifier is unique for each call.

CALL_TYPE

Key Access to the call type. See ConstantsMCOP.CallEventExtras.CallTypeEnum for all possible values.

CALLER_ID

Key Access to the MCS Identity of the caller user. Depending on whether the call is MCPTT or MCVIDEO, this tag will contain the MCPTT ID or MCVIDEO ID, respectively.

CALLER_FUNCTIONAL_ALIAS

Key Access to the current functional alias of the caller user.

GROUP_ID

Key Access to the caller group identity

ERROR_CODE

Key Access to the error codes associated to the call events.

ERROR_STRING

Key Access to error string associated to the call events.

TAG_CALL_ANSWER_MODE_KEY

Key Access to the call optional answer mode tag.

TAG_CALL_EMERG_ALERT_KEY

Key Access to the call optional emergency alert activation tag.

TAG_CALL_MIC_MUTE_KEY

Key Access to the call optional microphone mute tag.

TAG_CALL_SPEAKER_MUTE_KEY

Key Access to the call optional speaker mute tag.

TAG_CALL_IMPLICIT_REQUEST_KEY

Key Access to the call optional implicit request tag.

TAG_CALL_IMPLICIT_GRANTED_KEY

Key Access to the call optional implicit granted tag.

Constructor Detail

CallEventExtras

Key Access to the call event type. See `ConstantsMCOP.CallEventExtras.CallEventTypeEnum` for all possible values.

Key Access to the call type. See `ConstantsMCOP.CallEventExtras.CallTypeEnum` for all possible values.