ServiceConfig
DataServiceUrl
เป็น object class ที่รวม path การยิง Service ของ AtlasX Web Service และมี Content-type ที่ใช้บ่อย มีการใช้ค่าร่วมกับ object class อื่น คือ ContentType และ ServiceType
Variables
| Name | Description | Type | Default | Variable Type |
|---|---|---|---|---|
| BASE_URL | Base Service ที่ Retrofit ใช้ยิง Web Service | String | “https://portal-atlasx.cdg.co.th/axws-demo/api/” | var |
| JSON_HEADERS | Header Json ที่ไว้ใช้ยิง Service | String | “Content-Type: ${JSON}; charset=utf-8” | const val |
| FORM_DATA_HEADERS | Header Form data ที่ไว้ใช้ยิง Service | String | “Content-Type: ${FORM_DATA}; charset=utf-8” | const val |
| POST_URL_STR | Post Url ที่เอาไว้ต่อ path Base Url | String | “postUrl” | const val |
| POST_URL_TAG | Tag ที่จะนำเอา POST_URL_STR ไปต่อกับ path Base Service | String | “{${POST_URL_STR}}” | const val |
| APPAUTHEN | Service Url ที่ไว้สำหรับยิง App Authen ของ AtlasX Web Service | String | “${APP_AUTHEN}/token” | var |
| APPSYNCOFFLINE | Service Url ที่ไว้สำหรับยิง Sync ของ AtlasX Web Service | String | “${APP_SYNC_OFFLINE}/upload” | var |
ContentType
เป็น object class ประเภทของข้อมูลที่จะส่งไปภายใน Request
Example
object ContentType {
const val JSON = "application/json"
const val FORM_DATA = "multipart/form-data"
const val OCTET_STREAM = "application/octet-stream"
}ServiceType
เป็น object class ที่รวม Service ต่างๆที่ AtlasX Web Service รองรับ
Example
object ServiceType {
const val APP_AUTHEN = "appauthen"
const val APP_DATA = "appdata"
const val APP_MAIL = "appmail"
const val APP_FILE = "appFile"
const val APP_NOTI = "appnoti"
const val APP_SYNC_OFFLINE = "appsyncoffline"
}HttpHeaderField
เป็น object class ที่รวม Parameters ของ Http Header ที่ใช้สำหรับการเรียก Web Service
Example
object HttpHeaderField {
const val AUTHENTICATION = "Authorization"
const val ACCEPT_TYPE = "Accept"
const val ACCEPT_ENCODING = "Accept-Encoding"
const val CACHE_CONTROL = "Cache-Control"
const val CONTENT_TYPE = "Content-Type"
const val REFERER = "Referer"
}HttpRequest
เป็น object class ที่รวมการตั้งค่า เวลาหน่วยวินาที ของการยิง OkHttpClient
Example
object HttpRequest {
var callTimeout = 2
var connectTimeout = 20
var readTimeout = 30
var writeTimeout = 30
}ApiError
เป็น object class ที่รวม ประเภทของ Error ที่ได้จากการเรียก Web Service
Example
object ApiError {
const val FORBIDDEN = 403
const val NOT_FOUND = 404
const val CONFLICT = 409
const val INTERNAL_SERVER_ERROR = 500
const val NOT_SUCCESS = 400
}LoginType
เป็น object class ที่รวม ประเภทของการเข้าสู่ระบบ
Example
object LoginType {
const val ACCOUNT = 0
const val FACEBOOK = 1
const val GOOGLE_PLUS = 2
}TokenType
เป็น object class ที่รวม Key ประเภทของ token เมื่อทำการเข้าสู่ระบบ โดยสามารถใช้ Key นี้ใน SharedPreferences ได้
Example
object TokenType {
const val ACCESS_TOKEN = "access_token"
const val TOKEN_TYPE = "token_type"
const val EXPIRES_IN = "expires_in"
const val REFRESH_TOKEN = "refresh_token"
}Variables
| Name | Description | Type |
|---|---|---|
| ACCESS_TOKEN | key ของ Token ที่ใช้สำหรับการยิง Request | String |
| TOKEN_TYPE | key ของ ประเภทของ Token | String |
| EXPIRES_IN | key ของ Timestamp ที่ Access Token จะหมดอายุ | String |
| REFRESH_TOKEN | key ของ Token ที่ใช้สำหรับการขอ Access Token ใหม่เมื่อหมดอายุ | String |
LoginKeyParam
เป็น object class ที่รวม Key ของ params ตอนยิง App Authen Service
Example
object LoginKeyParam{
const val CLIENT_ID = "client_id"
const val GRANT_TYPE = "grant_type"
const val USERNAME = "username"
const val LOGIN_TYPE = "login_type"
const val PASSWORD = "password"
}Variables
| Name | Description | Type |
|---|---|---|
| CLIENT_ID | key ของ text อะไรก็ได้ที่ไม่สามารถคาดเดาได้ง่าย | String |
| GRANT_TYPE | key ของ ประเภท token | String |
| USERNAME | key ของ รหัสผู้ใช้ | String |
| LOGIN_TYPE | key ของ ประเภทการ login | String |
| PASSWORD | key ของ รหัสผ่านผู้ใช้ | String |
GrantType
เป็น object class ที่รวมค่าของ Grant Type ตอนยิง App Authen Service
Example
object GrantType {<br> const val PASSWORD = "password"<br> const val REFRESH_TOKEN = "refresh_token"<br>}Variables
| Name | Description | Type |
|---|---|---|
| PASSWORD | value ของ grant_type ตอนยิง login | String |
| REFRESH_TOKEN | value ของ grant_type ตอนยิง Refresh Token | String |