Since: API Level 1.5
public
class
CommonServiceConfiguration
extends Object| java.lang.Object | |
| ↳ | com.gsma.services.rcs.CommonServiceConfiguration |
Class Overview
This class represents the common configuration of RCS Services
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | CommonServiceConfiguration.MessagingMethod | The messaging method | |||||||||
| enum | CommonServiceConfiguration.MessagingMode | The messaging client mode | |||||||||
| enum | CommonServiceConfiguration.MinimumBatteryLevel | The minimum battery level | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CommonServiceConfiguration.MessagingMethod |
getDefaultMessagingMethod()
Returns the default messaging method which can be AUTOMATIC, RCS or NON_RCS.
| ||||||||||
| CommonServiceConfiguration.MessagingMode |
getMessagingUX()
Returns the messaging client mode which can be INTEGRATED, CONVERGED, SEAMLESS or NONE.
| ||||||||||
| CommonServiceConfiguration.MinimumBatteryLevel |
getMinimumBatteryLevel()
Returns the minimum battery level which can be NEVER_STOP, PERCENT_5, PERCENT_10 or
PERCENT_20.
| ||||||||||
| ContactId |
getMyContactId()
Returns the user contact Identifier (i.e.
| ||||||||||
| String |
getMyDisplayName()
Returns the display name associated to the RCS user account.
| ||||||||||
| boolean |
isConfigValid()
Returns True if RCS configuration is valid.
| ||||||||||
| void |
setDefaultMessagingMethod(CommonServiceConfiguration.MessagingMethod method)
Sets the default messaging method.
| ||||||||||
| void |
setMinimumBatteryLevel(CommonServiceConfiguration.MinimumBatteryLevel level)
Sets the minimum battery level.
| ||||||||||
| void |
setMyDisplayName(String name)
Sets the display name associated to the RCS user account.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public CommonServiceConfiguration.MessagingMethod getDefaultMessagingMethod ()
Since: API Level 1.5
Returns the default messaging method which can be AUTOMATIC, RCS or NON_RCS.
Returns
- MessagingMethod the default messaging method
Throws
| RcsGenericException |
|---|
public CommonServiceConfiguration.MessagingMode getMessagingUX ()
Since: API Level 1.5
Returns the messaging client mode which can be INTEGRATED, CONVERGED, SEAMLESS or NONE.
Returns
- MessagingMode the messaging client mode
Throws
| RcsGenericException |
|---|
public CommonServiceConfiguration.MinimumBatteryLevel getMinimumBatteryLevel ()
Since: API Level 1.5
Returns the minimum battery level which can be NEVER_STOP, PERCENT_5, PERCENT_10 or PERCENT_20.
Returns
- MinimumBatteryLevel the minimum battery level
Throws
| RcsGenericException |
|---|
public ContactId getMyContactId ()
Since: API Level 1.5
Returns the user contact Identifier (i.e. username part of the IMPU).
Returns
- ContactId the contact ID
Throws
| RcsGenericException |
|---|
public String getMyDisplayName ()
Since: API Level 1.5
Returns the display name associated to the RCS user account.
The display name may be updated by the end user via the RCS settings application.
Returns
- String Display name
Throws
| RcsGenericException |
|---|
public boolean isConfigValid ()
Since: API Level 1.5
Returns True if RCS configuration is valid.
Returns
- boolean True if RCS configuration is valid.
Throws
| RcsGenericException |
|---|
public void setDefaultMessagingMethod (CommonServiceConfiguration.MessagingMethod method)
Since: API Level 1.5
Sets the default messaging method.
Parameters
| method | the default messaging method which can be AUTOMATIC, RCS or NON_RCS. |
|---|
Throws
| RcsGenericException |
|---|
public void setMinimumBatteryLevel (CommonServiceConfiguration.MinimumBatteryLevel level)
Since: API Level 1.5
Sets the minimum battery level.
Parameters
| level | the minimum battery level which can be NEVER_STOP, PERCENT_5, PERCENT_10 or PERCENT_20. |
|---|
Throws
| RcsGenericException |
|---|
public void setMyDisplayName (String name)
Since: API Level 1.5
Sets the display name associated to the RCS user account.
Parameters
| name | the new display name |
|---|
Throws
| RcsPersistentStorageException | |
| RcsGenericException | |
| RcsPersistentStorageException |