Since: API Level 1.5
| java.lang.Object | ||
| ↳ | com.gsma.services.rcs.RcsService | |
| ↳ | com.gsma.services.rcs.history.HistoryService | |
Class Overview
History service offers the entry point to register and unregister extra history log provider members to the API.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.gsma.services.rcs.RcsService
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
HistoryService(Context ctx, RcsServiceListener listener)
Constructor
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| final void |
connect()
Connects to the API
| ||||||||||
| long |
createUniqueId(int providerId)
Creates an id that will be unique across all tables in the base column "_id".
| ||||||||||
| void |
disconnect()
Disconnects from the API
| ||||||||||
| void |
registerExtraHistoryLogMember(int providerId, Uri providerUri, Uri database, String table, Map<String, String> columnMapping)
Registers an external history log member.
| ||||||||||
| void |
unregisterExtraHistoryLogMember(int providerId)
Unregisters an external history log member.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.gsma.services.rcs.RcsService
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public HistoryService (Context ctx, RcsServiceListener listener)
Since: API Level 1.5
Constructor
Parameters
| ctx | Application context |
|---|---|
| listener | Service listener |
Public Methods
public final void connect ()
Since: API Level 1.5
Connects to the API
Throws
| RcsPermissionDeniedException |
|---|
public long createUniqueId (int providerId)
Since: API Level 1.5
Creates an id that will be unique across all tables in the base column "_id".
Parameters
| providerId | of the provider that requires the generated id for its table |
|---|
Returns
- long the generated id as long
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public void registerExtraHistoryLogMember (int providerId, Uri providerUri, Uri database, String table, Map<String, String> columnMapping)
Since: API Level 1.5
Registers an external history log member.
Parameters
| providerId | Provider ID of history log member |
|---|---|
| providerUri | Provider Uri |
| database | URI of database to register |
| table | Name of table to register |
| columnMapping | Translator of internal field names to history log provider field names |
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |
public void unregisterExtraHistoryLogMember (int providerId)
Since: API Level 1.5
Unregisters an external history log member.
Parameters
| providerId | Provider ID of history log member |
|---|
Throws
| RcsServiceNotAvailableException | |
| RcsGenericException | |
| RcsServiceNotAvailableException |