AsleepConfig
1. Initialize Config
Asleep.initAsleepConfig()
- SDK를 초기화 합니다.
initAsleepConfig(
context: Context,
apiKey: String,
userId: String?,
baseUrl: String?,
callbackUrl: String?,
service: String?,
asleepConfigListener: Asleep.AsleepConfigListener,
asleepLogger: AsleepLogger?
)
Parameter Name | Type | Description | |
---|---|---|---|
context | Context | applicationContext를 입력 | |
apiKey | String | Generate API key 에서 발급받은 값을 입력 | |
userId | String? | 초기 userId가 없을 땐 null을 입력, 이후 발급받은 userId를 입력 | |
baseUrl | String? | null이면 기본값을 사용, 프록시 서버의 url을 입력 | |
callbackUrl | String? | 수면 세션 분석 결과를 받아올 서버의 url을 입력 | |
service | String? | 앱 이름 | |
asleepConfigListener | AsleepConfigListener | userId를 콜백 받을 수 있는 리스너 | |
asleepLogger | AsleepLogger? | SDK의 log를 콜백 받을 수 있는 리스너 | 2.4.2<=SDK |
Asleep.ConfigListener
interface AsleepConfigListener {
fun onSuccess(userId: String?, asleepConfig: AsleepConfig?)
fun onFail(errorCode: Int, detail: String)
}
- 성공 시, onSuccess()가 호출됩니다.
Parameter Name | Type | Description |
---|---|---|
userId | String? | 새로 발급 하거나 입력한 userId |
asleepConfig | AsleepConfig? | SDK를 사용하기 위해 필요한 설정값 |
- 실패 시, onFail()이 호출됩니다.
Parameter Name | Type | Description |
---|---|---|
errorCode | Int | AsleepErrorCode 참조 |
detail | String | errorCode에 관련된 메세지 |
Asleep.AsleepLogger
interface AsleepLogger {
fun d(tag: String, msg: String, throwable: Throwable? = null)
fun e(tag: String, msg: String, throwable: Throwable? = null)
fun i(tag: String, msg: String, throwable: Throwable? = null)
fun w(tag: String, msg: String, throwable: Throwable? = null)
}
- SDK 내부에서 d(debug), e(error), i(info), w(warn)이 각각 발생하였을 때 호출됩니다.
Parameter Name | Type | Description |
---|---|---|
tag | String | "[Asleep SDK]" |
msg | String | log message |
throwable | Throwable? | SDK 실행 중 발생할 수 있는 문제를 나타내는 class |
2. Delete User
Asleep.deleteUser()
- userId를 포함한 사용자의 모든 데이터를 삭제합니다.
fun deleteUser(deleteUserIdListener: DeleteUserIdListener?)
Parameter Name | Type | Description |
---|---|---|
deleteUserIdListener | DeleteUserIdListener? | 삭제된 userId를 콜백 받을 수 있는 리스너 |
Asleep.DeleteUserIdListener
interface DeleteUserIdListener {
fun onSuccess(userId: String?)
fun onFail(errorCode: Int, detail: String)
}
- 성공 시, onSuccess()가 호출됩니다.
Parameter Name | Type | Description |
---|---|---|
userId | String? | 삭제된 userId |
- 실패 시, onFail()이 호출됩니다.
Parameter Name | Type | Description |
---|---|---|
errorCode | Int | AsleepErrorCode 참조 |
detail | String | errorCode에 관련된 메세지 |
3. Continue Session
- v2.3.0 이상부터 사용 가능
Asleep.hasUnfinishedSession()
- 포그라운드 서비스가 강제종료 된 후 재시작 되었을 때 종료되지 않은 세션이 존재하는지 체크합니다.
hasUnfinishedSession(context: Context): Boolean
Parameter Name | Type | Description |
---|---|---|
context | Context? | applicationContext를 입력 |
Asleep.getSavedAsleepConfig()
- 포그라운드 서비스가 강제종료 된 후 재시작 되었을 때 이전에 저장된 asleepConfig를 가져옵니다.
getSavedAsleepConfig(context: Context, apiKey: String): AsleepConfig?
Parameter Name | Type | Description |
---|---|---|
context | Context? | applicationContext를 입력 |
apiKey | String | Generate API key 에서 발급받은 값을 입력 |
Updated 5 months ago