org.mcopenplatform.muoapi

Interface IMCOPsdk

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IMCOPsdk.Stub

public interface IMCOPsdk
extends android.os.IInterface

AIDL definition https://developer.android.com/guide/components/aidl.html Used as a callback for MCOP SDK server-client communication, and for MCPTT (Mission Critical Push to Talk) Services.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMCOPsdk.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
boolean	acceptCall(java.lang.String sessionID) Accept an incoming MCPTT sesion.
boolean	authorizeUser(java.lang.String url) Once the authentication procedure has been carried out against a third party, this method must be called to continue with the Login process started with loginMCOP() method, defined in this AIDL.
boolean	changeSelectedContact(java.lang.String groupID) Select default contact (user or group).
boolean	floorControlOperation(java.lang.String sessionID, int requestType, java.lang.String UserID) Perform floor control operations over MCPTT sessions.
java.lang.String	getMCOPCapabilities()
boolean	groupAffiliationOperation(java.lang.String groupMcpttId, int affiliationOperation) Perform a group affiliation operation.
boolean	hangUpCall(java.lang.String sessionID) Hang up an incoming, established or initiated MCPTT session.
boolean	loginMCOP() This method starts the MCPTT System Login procedure.
boolean	makeCall(java.lang.String userID, int callType) Method to make MCPTT type calls.
boolean	registerCallback(IMCOPCallback mcopCallBack) Register the callback defined by AIDL so that the SDK can send asynchronous events to the user.
boolean	unLoginMCOP() This method starts the MCPTT System unLogin procedure.
boolean	updateEmergencyState(java.lang.String sessionID, int emergencyType) Update the emergency state of a particular session.
boolean	updateGroupsAffiliation() Requests group affiliation information to the SDK, generating a type ConstantsMCOP.ActionsCallBack.groupAffiliationEvent event callback.
boolean	updateGroupsInfo() Requests group information to the SDK, generating a type ConstantsMCOP.ActionsCallBack.groupInfoEvent event callback.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

getMCOPCapabilities

java.lang.String getMCOPCapabilities()
                              throws android.os.RemoteException

Throws:

android.os.RemoteException

loginMCOP

boolean loginMCOP()
           throws android.os.RemoteException

This method starts the MCPTT System Login procedure. No input parameters. In case of re-execution it restarts the login procedure.

Returns:

Indicates if the Login procedure can be started.

Throws:

android.os.RemoteException

See Also:

org.mcopenplatform.muoapi.ConstantsMCOP.AuthorizationRequestExtras (Definition of all the asynchronous response values of this method), org.mcopenplatform.muoapi.ConstantsMCOP.LoginEventExtras (Definition of all the asynchronous response values of this method and the errors)

unLoginMCOP

boolean unLoginMCOP()
             throws android.os.RemoteException

This method starts the MCPTT System unLogin procedure. No input parameters. In case of re-execution it restarts the unlogin procedure.

Returns:

Indicates if the unLogin procedure can be started.

Throws:

android.os.RemoteException

See Also:

org.mcopenplatform.muoapi.ConstantsMCOP.AuthorizationRequestExtras (Definition of all the asynchronous response values of this method), org.mcopenplatform.muoapi.ConstantsMCOP.LoginEventExtras (Definition of all the asynchronous response values of this method and the errors)

authorizeUser

boolean authorizeUser(java.lang.String url)
               throws android.os.RemoteException

Once the authentication procedure has been carried out against a third party, this method must be called to continue with the Login process started with loginMCOP() method, defined in this AIDL. Before making the call to this method, the client must use the "request uri", obtained in the callback "org.mcopenplatform.muoapi.ConstantsMCOP.ActionsCallBack.authorizationRequestEvent", to authenticate against a third party, so that the SDK can verify the authentication with the "url" input parameter.

Parameters:

url. - String with URL format where the parameters are indicated so that the SDK can authenticate the user.

Returns:

Indicates if the Login procedure can be started.

Throws:

android.os.RemoteException

See Also:

org.mcopenplatform.muoapi.ConstantsMCOP.AuthorizationRequestExtras (Definition of all the asynchronous response values of this method and the errors), org.mcopenplatform.muoapi.ConstantsMCOP.LoginEventExtras (Definition of all the asynchronous response values of this method and the errors)

makeCall

boolean makeCall(java.lang.String userID,
                 int callType)
          throws android.os.RemoteException

Method to make MCPTT type calls. Allowed call types are limited. MCPTT services that a call can contain are listed in org.mcopenplatform.muoapi.ConstantsMCOP.CallTypeEnum

Parameters:

userID. - String to identify the MCOP system user or group to call. If no identity is indicated, the selected contact will be called.

callType. - Integer that contains a series of FLAGs indicating the services for the new MCPTT session.

Returns:

Indicates whether the make call procedure could be started. In case of invalid MCPTT session, FALSE is returned.

Throws:

android.os.RemoteException

See Also:

org.mcopenplatform.muoapi.ConstantsMCOP.CallTypeEnum (Definition of the MCPTT Services a call may contain), org.mcopenplatform.muoapi.ConstantsMCOP.CallEventExtras (Definition of the different asynchronous responses this method can have through the callback)

hangUpCall

boolean hangUpCall(java.lang.String sessionID)
            throws android.os.RemoteException

Hang up an incoming, established or initiated MCPTT session.

Parameters:

sessionID. - Identifier of the specific MCPTT session where the specific action is carried out.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

acceptCall

boolean acceptCall(java.lang.String sessionID)
            throws android.os.RemoteException

Accept an incoming MCPTT sesion.

Parameters:

sessionID. - Identifier of the specific MCPTT session where the specific action is carried out.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

updateEmergencyState

boolean updateEmergencyState(java.lang.String sessionID,
                             int emergencyType)
                      throws android.os.RemoteException

Update the emergency state of a particular session.

Parameters:

sessionID. - Identifier of the specific MCPTT session to be updated.

emergencyType. - New emergency state of the session. It must be type ConstantsMCOP.EmergencyTypeEnum

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

See Also:

ConstantsMCOP.EmergencyTypeEnum

floorControlOperation

boolean floorControlOperation(java.lang.String sessionID,
                              int requestType,
                              java.lang.String UserID)
                       throws android.os.RemoteException

Perform floor control operations over MCPTT sessions.

Parameters:

sessionID - Identifier of the specific MCPTT session where the specific action is carried out.

requestType - Type of action to be performed. It must be type ConstantsMCOP.FloorControlEventExtras.FloorControlOperationTypeEnum

UserID - To be used in Video sessions, indicating the specific user to receive video from.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

updateGroupsInfo

boolean updateGroupsInfo()
                  throws android.os.RemoteException

Requests group information to the SDK, generating a type ConstantsMCOP.ActionsCallBack.groupInfoEvent event callback.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

updateGroupsAffiliation

boolean updateGroupsAffiliation()
                         throws android.os.RemoteException

Requests group affiliation information to the SDK, generating a type ConstantsMCOP.ActionsCallBack.groupAffiliationEvent event callback.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

groupAffiliationOperation

boolean groupAffiliationOperation(java.lang.String groupMcpttId,
                                  int affiliationOperation)
                           throws android.os.RemoteException

Perform a group affiliation operation.

Parameters:

groupMcpttId. - Unequivocally identifies the group on which the operation is carried out. The group list will be received in the event ConstantsMCOP.ActionsCallBack.groupAffiliationEvent

affiliationOperation. - Operation to perform on the indicated group. Allowed actions: ConstantsMCOP.GroupAffiliationEventExtras.AffiliationOperationTypeEnum.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

changeSelectedContact

boolean changeSelectedContact(java.lang.String groupID)
                       throws android.os.RemoteException

Select default contact (user or group).

Parameters:

groupID. - Unequivocal identifier of the MCPTT group defined for default MCPTT sessions.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

registerCallback

boolean registerCallback(IMCOPCallback mcopCallBack)
                  throws android.os.RemoteException

Register the callback defined by AIDL so that the SDK can send asynchronous events to the user.

Parameters:

mcopCallBack. - Callback where the different events are sent.

Returns:

Indicates whether the desired operation can be started.

Throws:

android.os.RemoteException

See Also:

ConstantsMCOP.ActionsCallBack