AWARE: Timezone
The timezone sensor keeps track of the user’s current timezone.
Requirements
iOS 10 or later
Installation
com.awareframework.ios.sensor.timezone is available through CocoaPods.
- To install it, simply add the following line to your Podfile:
pod 'com.awareframework.ios.sensor.timezone'- Import com.awareframework.ios.sensor.timezone library into your source code.
import com_awareframework_ios_sensor_timezone Public functions
TimezoneSensor
init(config:TimezoneSensor.Config?): Initializes the timezone sensor with the optional configuration.start(): Starts the timezone sensor with the optional configuration.stop(): Stops the service.
TimezoneSensor.Config
Class to hold the configuration of the sensor.
Fields
sensorObserver: TimezoneObserver: Callback for live data updates.enabled: BooleanSensor is enabled or not. (default =false)debug: Booleanenable/disable logging toLogcat. (default =false)label: StringLabel for the data. (default = "")deviceId: StringId of the device that will be associated with the events and the sensor. (default = "")dbEncryptionKeyEncryption key for the database. (default =null)dbType: EngineWhich db engine to use for saving data. (default =Engine.DatabaseType.NONE)dbPath: StringPath of the database. (default = "aware_timezone")dbHost: StringHost for syncing the database. (default =null)
Broadcasts
TimezoneSensor.ACTION_AWARE_TIMEZONEbroadcasted when there is new timezone information. Extra includesTimezoneSensor.EXTRA_DATAfor the new timezone.
Data Representations
Timezone Data
| Field | Type | Description |
|---|---|---|
| timezoneId | String | the timezone ID string, i.e., “America/Los_Angeles, GMT-08:00” |
| deviceId | String | AWARE device UUID |
| label | String | Customizable label. Useful for data calibration or traceability |
| timestamp | Long | unixtime milliseconds since 1970 |
| timezone | Int | Timezone of the device |
| os | String | Operating system of the device (ex. android) |
Example usage
let timezoneSensor = TimezoneSensor.init(TimezoneSensor.Config().apply{ config in
config.sensorObserver = Observer()
config.debug = true
config.dbType = .REALM
})
timezoneSensor?.start()class Observer:TimezoneObserver{
func onTimezoneChanged(data: TimezoneData) {
// Your code here..
}
}Author
Yuuki Nishiyama, [email protected]
License
Copyright (c) 2021 AWARE Mobile Context Instrumentation Middleware/Framework (http://www.awareframework.com)
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.