ServiceConfig

ServiceConfig

DataServiceUrl

เป็น object class ที่รวม path การยิง Service ของ AtlasX Web Service และมี Content-type ที่ใช้บ่อย มีการใช้ค่าร่วมกับ object class อื่น คือ ContentType และ ServiceType

Variables

NameDescriptionTypeDefaultVariable Type
BASE_URLBase Service ที่ Retrofit ใช้ยิง Web ServiceStringhttps://portal-atlasx.cdg.co.th/axws-demo/api/”var
JSON_HEADERSHeader Json ที่ไว้ใช้ยิง ServiceString“Content-Type: ${JSON}; charset=utf-8”const val
FORM_DATA_HEADERSHeader Form data ที่ไว้ใช้ยิง ServiceString“Content-Type: ${FORM_DATA}; charset=utf-8”const val
POST_URL_STRPost Url ที่เอาไว้ต่อ path Base UrlString“postUrl”const val
POST_URL_TAGTag ที่จะนำเอา POST_URL_STR ไปต่อกับ path Base ServiceString“{${POST_URL_STR}}”const val
APPAUTHENService Url ที่ไว้สำหรับยิง App Authen ของ AtlasX Web ServiceString“${APP_AUTHEN}/token”var
APPSYNCOFFLINEService Url ที่ไว้สำหรับยิง Sync ของ AtlasX Web ServiceString“${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

NameDescriptionType
ACCESS_TOKENkey ของ Token ที่ใช้สำหรับการยิง RequestString
TOKEN_TYPEkey ของ ประเภทของ TokenString
EXPIRES_INkey ของ Timestamp ที่ Access Token จะหมดอายุString
REFRESH_TOKENkey ของ 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

NameDescriptionType
CLIENT_IDkey ของ text อะไรก็ได้ที่ไม่สามารถคาดเดาได้ง่ายString
GRANT_TYPEkey ของ ประเภท tokenString
USERNAMEkey ของ รหัสผู้ใช้String
LOGIN_TYPEkey ของ ประเภทการ loginString
PASSWORDkey ของ รหัสผ่านผู้ใช้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

NameDescriptionType
PASSWORDvalue ของ grant_type ตอนยิง loginString
REFRESH_TOKENvalue ของ grant_type ตอนยิง Refresh TokenString