SdlManager (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.managers.SdlManager

```
public class SdlManager
extends Object
```
SDLManager

This is the main point of contact between an application and SDL

It is broken down to these areas:

1. SDLManagerBuilder
2. ISdl Interface along with its overridden methods - This can be passed into attached managers
3. Sending Requests
4. Helper methods

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SdlManager.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SdlManager.Builder`

Constructor Summary

Constructors
Constructor and Description

SdlManager()

Constructors
Constructor and Description
`SdlManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOnRPCNotificationListener(FunctionID notificationId, OnRPCNotificationListener listener)` Add an OnRPCNotificationListener
`void`	`addOnRPCRequestListener(FunctionID requestId, OnRPCRequestListener listener)` Add an OnRPCRequestListener
`protected void`	`checkLifecycleConfiguration()`
`void`	`dispose()` Dispose SdlManager and clean its resources Note: new instance of SdlManager should be created on every connection.
`protected String`	`getAppId()`
`protected String`	`getAppName()`
`protected Vector<AppHMIType>`	`getAppTypes()`
`AudioStreamManager`	`getAudioStreamManager()` Gets the AudioStreamManager.
`String`	`getAuthToken()` Retrieves the auth token, if any, that was attached to the StartServiceACK for the RPC service from the module.
`OnHMIStatus`	`getCurrentHMIStatus()` Get the current OnHMIStatus
`protected TemplateColorScheme`	`getDayColorScheme()`
`FileManager`	`getFileManager()` Gets the FileManager.
`protected FileManagerConfig`	`getFileManagerConfig()`
`protected Language`	`getHmiLanguage()`
`protected Language`	`getLanguage()`
`protected LockScreenConfig`	`getLockScreenConfig()`
`LockScreenManager`	`getLockScreenManager()` Gets the LockScreenManager.
`protected Version`	`getMinimumProtocolVersion()`
`protected Version`	`getMinimumRPCVersion()`
`protected TemplateColorScheme`	`getNightColorScheme()`
`PermissionManager`	`getPermissionManager()` Gets the PermissionManager.
`RegisterAppInterfaceResponse`	`getRegisterAppInterfaceResponse()` Method to retrieve the RegisterAppInterface Response message that was sent back from the module.
`ScreenManager`	`getScreenManager()` Gets the ScreenManager.
`protected String`	`getShortAppName()`
`int`	`getState()` Get the current state for the SdlManager
`SystemCapabilityManager`	`getSystemCapabilityManager()` Gets the SystemCapabilityManager.
`protected BaseTransportConfig`	`getTransport()`
`protected Vector<TTSChunk>`	`getTtsChunks()`
`VideoStreamManager`	`getVideoStreamManager()` Gets the VideoStreamManager.
`protected Vector<String>`	`getVrSynonyms()`
`protected void`	`initialize()`
`void`	`removeOnRPCNotificationListener(FunctionID notificationId, OnRPCNotificationListener listener)` Remove an OnRPCNotificationListener
`void`	`removeOnRPCRequestListener(FunctionID requestId, OnRPCRequestListener listener)` Remove an OnRPCRequestListener
`void`	`sendRPC(RPCMessage message)` Send RPC Message
`void`	`sendRPCs(List<? extends RPCMessage> rpcs, OnMultipleRequestListener listener)` Takes a list of RPCMessages and sends it to SDL.
`void`	`sendSequentialRPCs(List<? extends RPCMessage> rpcs, OnMultipleRequestListener listener)` Takes a list of RPCMessages and sends it to SDL in a synchronous fashion.
`void`	`start()` Starts up a SdlManager, and calls provided callback called once all BaseSubManagers are done setting up
`void`	`startRPCEncryption()` Start a secured RPC service
`protected void`	`transitionToState(int state)`

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

- Constructor Detail
  - SdlManager
```
public SdlManager()
```
- Method Detail
  - start
```
public void start()
```
    Starts up a SdlManager, and calls provided callback called once all BaseSubManagers are done setting up
  - initialize
```
protected void initialize()
```
  - dispose
```
public void dispose()
```
    Dispose SdlManager and clean its resources Note: new instance of SdlManager should be created on every connection. SdlManager cannot be reused after getting disposed.
  - getVideoStreamManager
```
@Nullable
public VideoStreamManager getVideoStreamManager()
```
    Gets the VideoStreamManager.
    The VideoStreamManager returned will only be not null if the registered app type is either NAVIGATION or PROJECTION. Once the VideoStreamManager is retrieved, its start() method will need to be called before use.
    
    Note: VideoStreamManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a VideoStreamManager object attached to this SdlManager instance
  - getAudioStreamManager
```
@Nullable
public AudioStreamManager getAudioStreamManager()
```
    Gets the AudioStreamManager.
    The AudioStreamManager returned will only be not null if the registered app type is either NAVIGATION or PROJECTION. Once the AudioStreamManager is retrieved, its start() method will need to be called before use.
    Note: AudioStreamManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a AudioStreamManager object
  - getLockScreenManager
```
public LockScreenManager getLockScreenManager()
```
    Gets the LockScreenManager.
    Note: LockScreenManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a LockScreenManager object
  - getLockScreenConfig
```
protected LockScreenConfig getLockScreenConfig()
```
  - checkLifecycleConfiguration
```
protected void checkLifecycleConfiguration()
```
  - getState
```
public int getState()
```
    Get the current state for the SdlManager
    
    Returns:
    
    int value that represents the current state
    
    See Also:
    
    BaseSubManager
  - transitionToState
```
protected void transitionToState(int state)
```
  - getAppName
```
protected String getAppName()
```
  - getAppId
```
protected String getAppId()
```
  - getShortAppName
```
protected String getShortAppName()
```
  - getMinimumProtocolVersion
```
protected Version getMinimumProtocolVersion()
```
  - getMinimumRPCVersion
```
protected Version getMinimumRPCVersion()
```
  - getHmiLanguage
```
protected Language getHmiLanguage()
```
  - getLanguage
```
protected Language getLanguage()
```
  - getDayColorScheme
```
protected TemplateColorScheme getDayColorScheme()
```
  - getNightColorScheme
```
protected TemplateColorScheme getNightColorScheme()
```
  - getAppTypes
```
protected Vector<AppHMIType> getAppTypes()
```
  - getVrSynonyms
```
protected Vector<String> getVrSynonyms()
```
  - getTtsChunks
```
protected Vector<TTSChunk> getTtsChunks()
```
  - getTransport
```
protected BaseTransportConfig getTransport()
```
  - getFileManagerConfig
```
protected FileManagerConfig getFileManagerConfig()
```
  - getPermissionManager
```
public PermissionManager getPermissionManager()
```
    Gets the PermissionManager.
    Note: PermissionManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a PermissionManager object
  - getFileManager
```
public FileManager getFileManager()
```
    Gets the FileManager.
    Note: FileManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a FileManager object
  - getScreenManager
```
public ScreenManager getScreenManager()
```
    Gets the ScreenManager.
    Note: ScreenManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a ScreenManager object
  - getSystemCapabilityManager
```
public SystemCapabilityManager getSystemCapabilityManager()
```
    Gets the SystemCapabilityManager.
    Note: SystemCapabilityManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.
    
    Returns:
    
    a SystemCapabilityManager object
  - getRegisterAppInterfaceResponse
```
public RegisterAppInterfaceResponse getRegisterAppInterfaceResponse()
```
    Method to retrieve the RegisterAppInterface Response message that was sent back from the module. It contains various attributes about the connected module and can be used to adapt to different module types and their supported features.
    
    Returns:
    
    RegisterAppInterfaceResponse received from the module or null if the app has not yet registered with the module.
  - getCurrentHMIStatus
```
public OnHMIStatus getCurrentHMIStatus()
```
    Get the current OnHMIStatus
    
    Returns:
    
    OnHMIStatus object represents the current OnHMIStatus
  - getAuthToken
```
public String getAuthToken()
```
    Retrieves the auth token, if any, that was attached to the StartServiceACK for the RPC service from the module. For example, this should be used to login to a user account.
    
    Returns:
    
    the string representation of the auth token
  - sendRPC
```
public void sendRPC(RPCMessage message)
```
    Send RPC Message
    
    Parameters:
    
    message - RPCMessage
  - sendSequentialRPCs
```
public void sendSequentialRPCs(List<? extends RPCMessage> rpcs,
                               OnMultipleRequestListener listener)
```
    Takes a list of RPCMessages and sends it to SDL in a synchronous fashion. Responses are captured through callback on OnMultipleRequestListener. For sending requests asynchronously, use sendRPCs
    NOTE: This will override any listeners on individual RPCs
    ADDITIONAL NOTE: This only takes the type of RPCRequest for now, notifications and responses will be thrown out
    
    Parameters:
    
    rpcs - is the list of RPCMessages being sent
    
    listener - listener for updates and completions
  - sendRPCs
```
public void sendRPCs(List<? extends RPCMessage> rpcs,
                     OnMultipleRequestListener listener)
```
    Takes a list of RPCMessages and sends it to SDL. Responses are captured through callback on OnMultipleRequestListener. For sending requests synchronously, use sendSequentialRPCs
    NOTE: This will override any listeners on individual RPCs
    ADDITIONAL NOTE: This only takes the type of RPCRequest for now, notifications and responses will be thrown out
    
    Parameters:
    
    rpcs - is the list of RPCMessages being sent
    
    listener - listener for updates and completions
  - addOnRPCNotificationListener
```
public void addOnRPCNotificationListener(FunctionID notificationId,
                                         OnRPCNotificationListener listener)
```
    Add an OnRPCNotificationListener
    
    Parameters:
    
    listener - listener that will be called when a notification is received
  - removeOnRPCNotificationListener
```
public void removeOnRPCNotificationListener(FunctionID notificationId,
                                            OnRPCNotificationListener listener)
```
    Remove an OnRPCNotificationListener
    
    Parameters:
    
    listener - listener that was previously added
  - addOnRPCRequestListener
```
public void addOnRPCRequestListener(FunctionID requestId,
                                    OnRPCRequestListener listener)
```
    Add an OnRPCRequestListener
    
    Parameters:
    
    listener - listener that will be called when a request is received
  - removeOnRPCRequestListener
```
public void removeOnRPCRequestListener(FunctionID requestId,
                                       OnRPCRequestListener listener)
```
    Remove an OnRPCRequestListener
    
    Parameters:
    
    listener - listener that was previously added
  - startRPCEncryption
```
public void startRPCEncryption()
```
    Start a secured RPC service

Class SdlManager

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SdlManager

Method Detail

start

initialize

dispose

getVideoStreamManager

getAudioStreamManager

getLockScreenManager

getLockScreenConfig

checkLifecycleConfiguration

getState

transitionToState

getAppName

getAppId

getShortAppName

getMinimumProtocolVersion

getMinimumRPCVersion

getHmiLanguage

getLanguage

getDayColorScheme

getNightColorScheme

getAppTypes

getVrSynonyms

getTtsChunks

getTransport

getFileManagerConfig

getPermissionManager

getFileManager

getScreenManager

getSystemCapabilityManager

getRegisterAppInterfaceResponse

getCurrentHMIStatus

getAuthToken

sendRPC

sendSequentialRPCs

sendRPCs

addOnRPCNotificationListener

removeOnRPCNotificationListener

addOnRPCRequestListener

removeOnRPCRequestListener

startRPCEncryption