new UserSettingsService()
Methods
deleteUserSettings(request, callback)
Deletes all user settings (name/value pairs) currently defined for a specific storageKey.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
tibco.objectapi.service.request.DeleteUserSettingsRequest | A request set with data for this service call. |
callback |
tibco.objectapi.service.Callback | A callback to handle the service response of type NoContentResponse. |
getUserSettings(request, callback)
Retrieves the name/value pairs for the given setting key and name.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
tibco.objectapi.service.request.GetUserSettingsRequest | A request set with data for this service call. |
callback |
tibco.objectapi.service.Callback | A callback to handle the service response of type GetUserSettingsResponseType. |
listUserSettingIds(request, callback)
Lists all user settingIDs currently defined for a specific storageKey.
Note; This does not list the name/value pairs for the settings. Use getUserSettings to retrieve the name/values.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
tibco.objectapi.service.request.ListUserSettingIdsRequest | A request set with data for this service call. |
callback |
tibco.objectapi.service.Callback | A callback to handle the service response of type ListUserSettingIdsResponseType. |
saveUserSettings(request, callback)
Saves one or more user settings (name/value pairs) for a specific storageKey and settingID.
User settings allow the application to store any name/value pairs on the server for later retrieval (using the getUserSettings function).
Parameters:
| Name | Type | Description |
|---|---|---|
request |
tibco.objectapi.service.request.SaveUserSettingsRequest | A request set with data for this service call. |
callback |
tibco.objectapi.service.Callback | A callback to handle the service response of type NoContentResponse. |