Since: API Level 1.5
public
abstract
class
RcsService
extends Object| java.lang.Object | |
| ↳ | com.gsma.services.rcs.RcsService |
 Known Direct Subclasses
|
Class Overview
Abstract RCS service
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | RcsService.Build | Information about the current build | |||||||||
| enum | RcsService.Direction | Direction of the communication for Chat message, Geolocation, Filetransfer, Imageshare, Videoshare etc. | |||||||||
| enum | RcsService.ReadStatus | Read status of the message | |||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ACTION_SERVICE_PROVISIONING_DATA_CHANGED | Action to broadcast when RCS service is provisioned. | |||||||||
| String | ACTION_SERVICE_UP | Action broadcasted when RCS service is up. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
addEventListener(RcsServiceRegistrationListener listener)
Adds a listener on service registration events
| ||||||||||
| abstract void |
connect()
Connects to the API
| ||||||||||
| abstract void |
disconnect()
Disconnects from the API
| ||||||||||
| CommonServiceConfiguration |
getCommonConfiguration()
Returns the configuration that is common for all the service APIs
| ||||||||||
| RcsServiceRegistration.ReasonCode |
getServiceRegistrationReasonCode()
Returns the reason code for the service registration
| ||||||||||
| int |
getServiceVersion()
Returns service version
| ||||||||||
| boolean |
isServiceConnected()
Returns true if the service is connected, else returns false
| ||||||||||
| boolean |
isServiceRegistered()
Returns true if the service is registered to the platform, else returns false
| ||||||||||
| void |
removeEventListener(RcsServiceRegistrationListener listener)
Removes a listener on service registration events
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Constants
public static final String ACTION_SERVICE_PROVISIONING_DATA_CHANGED
Since: API Level 1.5
Action to broadcast when RCS service is provisioned.
Constant Value:
"com.gsma.services.rcs.action.SERVICE_PROVISIONING_DATA_CHANGED"
public static final String ACTION_SERVICE_UP
Since: API Level 1.5
Action broadcasted when RCS service is up.
Constant Value:
"com.gsma.services.rcs.action.SERVICE_UP"
Public Methods
public void addEventListener (RcsServiceRegistrationListener listener)
Since: API Level 1.5
Adds a listener on service registration events
Parameters
| listener | Service registration listener |
|---|
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public abstract void connect ()
Since: API Level 1.5
Connects to the API
Throws
| RcsPermissionDeniedException |
|---|
public CommonServiceConfiguration getCommonConfiguration ()
Since: API Level 1.5
Returns the configuration that is common for all the service APIs
Returns
- CommonServiceConfiguration instance
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public RcsServiceRegistration.ReasonCode getServiceRegistrationReasonCode ()
Since: API Level 1.5
Returns the reason code for the service registration
Returns
- RcsServiceRegistration.ReasonCode
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public int getServiceVersion ()
Since: API Level 1.5
Returns service version
Returns
- int Version
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
See Also
public boolean isServiceConnected ()
Since: API Level 1.5
Returns true if the service is connected, else returns false
Returns
- Returns true if connected else returns false
public boolean isServiceRegistered ()
Since: API Level 1.5
Returns true if the service is registered to the platform, else returns false
Returns
- boolean true if registered else returns false
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public void removeEventListener (RcsServiceRegistrationListener listener)
Since: API Level 1.5
Removes a listener on service registration events
Parameters
| listener | Service registration listener |
|---|
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |