SGAgent

Object
- com.sg.util.SGAgent

public class SGAgent
extends Object

SGAgent is the main class of SGUtil library. Before using it, you need to create an instance of the class and calling its method onCreate to do initialization. As a hint from the name, this method should be called in onCreate of application's main Activity. Besides onCreate, its methods with the same names as primary Android Activity lifecycle callbacks should be called (in callbacks) too. Please find details in the description of those methods. SGAgent takes the main Activity of application as a client, which should implement SGAgent.SGClient interface.

SGAgent manages user login state, information retrieval state and product purchase state in its state machines. Execution of its methods may lead to change of these states. You can override SGClient.onStateChange to monitor these changes and make proper processing. The state transfer and corresponding processing are listed in the table below.

Transfer of user login state

Old state	New state	Transfer operation	Transfer cause
USRSTATE_IDLE	USRSTATE_INITIALIZING	OP_INIT	Initialization: agent.onCreate()
USRSTATE_INITIALIZING	USRSTATE_INITIALIZED	OP_INIT	Initialization succeeded
USRSTATE_INITIALIZING	USRSTATE_IDLE	OP_INIT	Initialization failed
USRSTATE_INITIALIZED	USRSTATE_LOGINING	OP_LOGIN	Channel login: agent.login()
USRSTATE_LOGINING	USRSTATE_LOGINED	OP_LOGIN	Channel login succeeded
USRSTATE_LOGINING	USRSTATE_INITIALIZED	OP_LOGIN	Channel login failed
USRSTATE_LOGINED	USRSTATE_AUTHING	OP_AUTH	Channel login verification (auto)
USRSTATE_AUTHING	USRSTATE_AUTHED	OP_AUTH	Channel login verification succeeded
USRSTATE_AUTHING	USRSTATE_INITIALIZED	OP_AUTH	Channel login verification failed
USRSTATE_AUTHED	USRSTATE_LOGININGGAME	OP_LOGINGAME	Game server login (auto)
USRSTATE_LOGININGGAME	USRSTATE_LOGINEDGAME	OP_LOGINGAME	Game server login succeeded
USRSTATE_LOGININGGAME	USRSTATE_INITIALIZED	OP_LOGINGAME	Game server login failed
USRSTATE_LOGINEDGAME	USRSTATE_LOGOUTINGGAME	OP_LOGOUTGAME	Game server logout: agent.logout()
USRSTATE_LOGOUTINGGAME	USRSTATE_LOGOUTEDGAME	OP_LOGOUTGAME	Game server logout succeeded
USRSTATE_LOGOUTINGGAME	USRSTATE_LOGINEDGAME	OP_LOGOUTGAME	Game server logout failed
USRSTATE_LOGOUTEDGAME	USRSTATE_LOGOUTING	OP_LOGOUT	Channel logout (auto)
USRSTATE_LOGOUTING	USRSTATE_INITIALIZED	OP_LOGOUT	Channel logout (no matter) succeeded or failed
USRSTATE_LOGOUTED (Not used)
USRSTATE_ERROR (Not used)

Transfer of information retrieval state

Old state	New state	Transfer operation	Transfer cause)
JOBSTATE_IDLE	JOBSTATE_REQUESTINGSTARTGAME	OP_STARTGAME	Start game: agent.startGame()
JOBSTATE_REQUESTINGSTARTGAME	JOBSTATE_IDLE	OP_STARTGAME	finished starting game (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_REQUESTINGSTOPGAME	OP_STOPGAME	Stop game: agent.stopGame()
JOBSTATE_REQUESTINGSTOPGAME	JOBSTATE_IDLE	OP_STOPGAME	finished stopping game (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_GETTINGPRODUCTS	OP_GETPRODUCTS	Product list retrieval: agent.getProducts()
JOBSTATE_GETTINGPRODUCTS	JOBSTATE_IDLE	OP_GETPRODUCTS	Product list retrieval (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_GETTINGORDERINFOLIST	OP_GETORDERINFOLIST	Order info list retrieval: agent.getOrderInfoList()
JOBSTATE_GETTINGORDERINFOLIST	JOBSTATE_IDLE	OP_GETORDERINFOLIST	Order info list retrieval (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_GETTINGTREASURELIST	OP_GETTREASURELIST	Treasure list retrieval: agent.getTreasureList()
JOBSTATE_GETTINGTREASURELIST	JOBSTATE_IDLE	OP_GETTREASURELIST	Treasure list retrieval (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_INCINGTREASURE	OP_INCTREASURE	Increase treasure count: agent.incTreasure()
JOBSTATE_INCINGTREASURE	JOBSTATE_IDLE	OP_INCTREASURE	Increase treasure count (no matter) succeeded or failed
JOBSTATE_IDLE	JOBSTATE_GETTINGLOGVALUE	OP_GETLOGVALUE	Get value of logged key: agent.getLogValue()
JOBSTATE_GETTINGLOGVALUE	JOBSTATE_IDLE	OP_GETLOGVALUE	Get value of logged key (no matter) succeeded or failed
JOBSTATE_GOTPRODUCTS (Not used)
JOBSTATE_GOTORDERINFOLIST (Not used)
JOBSTATE_GOTLOGVALUE (Not used)
JOBSTATE_ERROR (Not used)

Transfer of product purchase state

Old state	New state	Transfer operation	Transfer cause
PAYSTATE_IDLE	PAYSTATE_GETTINGORDER	OP_GETORDER	Initiate purchase agent.buyProduct()
PAYSTATE_GETTINGORDER	PAYSTATE_IDLE	OP_GETORDER	Order generation failed
PAYSTATE_GETTINGORDER	PAYSTATE_GOTORDER	OP_GETORDER	Order generation succeeded
PAYSTATE_GOTORDER	PAYSTATE_PAYING	OP_PAY	Start channel payment operation (auto)
PAYSTATE_PAYING	PAYSTATE_IDLE	OP_PAY	Channel payment operation failed or cancelled
PAYSTATE_PAYING	PAYSTATE_PAID	OP_PAY	Channel payment operation succeeded (only UI operation succeeded, backend (server) verification is necessary)
PAYSTATE_PAID	PAYSTATE_GETTINGORDERSTATE	OP_GETORDERSTATE	Check whether money was received (might be auto, refer to setOrderStateCheckingIntervals)
PAYSTATE_GETTINGORDERSTATE	PAYSTATE_IDLE	OP_GETORDERSTATE	Payment failed or money is not enough (refer to getState)
PAYSTATE_GETTINGORDERSTATE	PAYSTATE_ORDERSUCCEEDED	OP_GETORDERSTATE	Payment succeeded
PAYSTATE_ORDERSUCCEEDED	PAYSTATE_DLVINGORDER	OP_DLVORDER	Changing game server order state to delivered
PAYSTATE_DLVINGORDER	PAYSTATE_IDLE	OP_DLVORDER	Game server order could not be changed
PAYSTATE_ERROR (Not used)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SGAgent.SGClient
SGClient interface.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SGAgent.SGClient` SGClient interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EXT_PROP_ARGS` Extended function need arguments.
`static int`	`EXT_PROP_ASYNC` Extended function is asynchronous.
`static int`	`EXT_PROP_LOGIN` Extended function only effective after login.
`static int`	`EXT_PROP_NONLOGIN` Extended function only effective before login.
`static int`	`EXT_PROP_VOID` Extended function returns void.
`static int`	`EXT_RET_CANCELLED` Asynchronous extended function cancelled.
`static int`	`EXT_RET_ERROR` Asynchronous extended function failed.
`static int`	`EXT_RET_OK` Asynchronous extended function succeeded.
`static String`	`EXTMETHOD_RET_PREFIX_BAD_CMD`
`static String`	`EXTMETHOD_RET_PREFIX_EMPTY_CMDLINE`
`static String`	`EXTMETHOD_RET_PREFIX_LOGIN`
`static String`	`EXTMETHOD_RET_PREFIX_NO_COOKIE`
`static String`	`EXTMETHOD_RET_PREFIX_NONLOGIN`
`static String`	`EXTMETHOD_RET_PREFIX_NULL`
`static String`	`EXTMETHOD_RET_PREFIX_NULL_ASYNC`
`static String`	`EXTMETHOD_RET_PREFIX_STRING`
`static String`	`EXTMETHOD_RET_PREFIX_STRING_ASYNC`
`static String`	`EXTMETHOD_RET_PREFIX_VOID`
`static String`	`EXTMETHOD_RET_PREFIX_VOID_ASYNC`
`static int`	`JOBSTATE_ERROR` Information retrieval state: Error
`static int`	`JOBSTATE_GETTINGLOGVALUE` Information retrieval state: Increasing treasure count
`static int`	`JOBSTATE_GETTINGORDERINFOLIST` Information retrieval state: Retrieving order info list
`static int`	`JOBSTATE_GETTINGPLAYERDETAILS` Information retrieval state: Getting player details
`static int`	`JOBSTATE_GETTINGPRODUCTS` Information retrieval state: Retrieving product list
`static int`	`JOBSTATE_GETTINGTREASURELIST` Information retrieval state: Retrieving treasure list
`static int`	`JOBSTATE_GOTPLAYERDETAILS` Information retrieval state: Got player details
`static int`	`JOBSTATE_IDLE` Information retrieval state: Idle
`static int`	`JOBSTATE_INCINGTREASURE` Information retrieval state: Increasing treasure count
`static int`	`JOBSTATE_REQUESTEDSTARTGAME` Information retrieval state: Starting game request processed
`static int`	`JOBSTATE_REQUESTEDSTOPGAME` Information retrieval state: Stopping game request processed
`static int`	`JOBSTATE_REQUESTINGSTARTGAME` Information retrieval state: Requesting to start game
`static int`	`JOBSTATE_REQUESTINGSTOPGAME` Information retrieval state: Requesting to stop game
`static int`	`JOBSTATE_SHAREDSCREEN` Information retrieval state: Shared screen
`static int`	`JOBSTATE_SHARINGSCREEN` Information retrieval state: Sharing screen
`static int`	`OP_AUTH` Channel login verification
`static int`	`OP_DLVORDER` Marking as delivered
`static int`	`OP_GETLOGVALUE` Get value of remote log key
`static int`	`OP_GETORDER` Order generation
`static int`	`OP_GETORDERINFOLIST` Order info list retrieval
`static int`	`OP_GETORDERSTATE` Order state retrieval
`static int`	`OP_GETPLAYERDETAILS` Get player details
`static int`	`OP_GETPRODUCTS` Product list retrieval
`static int`	`OP_GETTREASURELIST` Order info list retrieval
`static int`	`OP_INCTREASURE` Increase treasure count
`static int`	`OP_INIT` Initialization
`static int`	`OP_LOGIN` Channel login
`static int`	`OP_LOGINGAME` Game server login
`static int`	`OP_LOGOUT` Channel logout
`static int`	`OP_LOGOUTGAME` Game server logout
`static int`	`OP_NONE` No operation
`static int`	`OP_PAY` Pay
`static int`	`OP_SHARESCREEN` Share screen
`static int`	`OP_STARTGAME` Start game
`static int`	`OP_STOPGAME` Stop game
`static int`	`PAYSTATE_DLVINGORDER` Product purchase state: Delivering product
`static int`	`PAYSTATE_ERROR` Product purchase state: Error
`static int`	`PAYSTATE_GETTINGORDER` Product purchase state: Order is being generated
`static int`	`PAYSTATE_GETTINGORDERSTATE` Product purchase state: Retrieving order state
`static int`	`PAYSTATE_GOTORDER` Product purchase state: Order generated
`static int`	`PAYSTATE_IDLE` Product purchase state: Idle
`static int`	`PAYSTATE_ORDERSUCCEEDED` Product purchase state: Payment succeeded
`static int`	`PAYSTATE_PAID` Product purchase state: Payment UI operation succeeded
`static int`	`PAYSTATE_PAYING` Product purchase state: Payment UI operation ongoing
`static int`	`STATE_CHANGE_REASON_NONE` Reason of state change: None
`static int`	`STATE_CHANGE_REASON_OP` Reason of state change: An operation was performed
`static int`	`STATE_CHANGE_REASON_OP_CANCELED` Reason of state change: Operation cancelled
`static int`	`STATE_CHANGE_REASON_OP_FAILURE` Reason of state change: Operation failed
`static int`	`STATE_CHANGE_REASON_OP_SUCCESS` Reason of state change: Operation succeeded
`static int`	`STATE_TYPE_JOB` Information retrieval state
`static int`	`STATE_TYPE_PAY` Product purchase
`static int`	`STATE_TYPE_USR` User login state
`static int`	`USRSTATE_AUTHED` User login state: Verified channel login information
`static int`	`USRSTATE_AUTHING` User login state: Verifying channel login information
`static int`	`USRSTATE_ERROR` User login state: Error
`static int`	`USRSTATE_IDLE` User login state: Idle
`static int`	`USRSTATE_INITIALIZED` User login state: Initialized
`static int`	`USRSTATE_INITIALIZING` User login state: Initializing
`static int`	`USRSTATE_LOGINED` User login state: Logined to channel
`static int`	`USRSTATE_LOGINEDGAME` User login state: Logined to game server
`static int`	`USRSTATE_LOGINING` User login state: Logining to channel
`static int`	`USRSTATE_LOGININGGAME` User login state: Logining to game server
`static int`	`USRSTATE_LOGOUTED` User login state: Logouted from channel
`static int`	`USRSTATE_LOGOUTEDGAME` User login state: Logouted from game server
`static int`	`USRSTATE_LOGOUTING` User login state: Logouting from channel
`static int`	`USRSTATE_LOGOUTINGGAME` User login state: Logouting from game server

Constructor Summary

Constructors
Constructor and Description

SGAgent()

Constructors
Constructor and Description
`SGAgent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`buyProduct(String productID, int num, String treasure)` Initiate product purchase.
`void`	`exit()` Exit application.
`UAccount`	`getAccount()` Get final account.
`int`	`getApkVersionCode()` Get version code.
`String`	`getApkVersionName()` Get version name.
`int`	`getAppID()` Get application ID.
`String`	`getAppKey()` Get application key.
`Map<String,String>`	`getChannelConfigs()` Get channel config items.
`int`	`getChannelID()` Get channel ID.
`String`	`getChannelName()` Get channel short name.
`String`	`getDeviceID()` Get device ID.
`SGGameServerInterface`	`getGameServer()` Get current game server instance.
`int`	`getJobState()` Get information retrieval state.
`Map<String,String>`	`getLoginExtensionMap()`
`boolean`	`getLogValue(String key, int defaultValue)` Start progress to get value of remote log key.
`String`	`getOpName(int op)` Get name of operation, for readable debug output.
`boolean`	`getOrderInfoList(String filter)` Start order info list retrieval progress.
`boolean`	`getOrderState(String orderID)` Start payment result retrieval progress.
`int`	`getPayState()` Get product purchase state.
`boolean`	`getPlayerDetails()` Get player details.
`UProduct`	`getProductByOrderID(String orderID)` Find product corresponding to specified order ID.
`boolean`	`getProducts(String filter, boolean sorting)` Start product list retrieval progress.
`USession`	`getSession()` Get session.
`String`	`getStateChangeReasonName(int reason)` Get name of state change reason, for readable debug output.
`String`	`getStateName(int type, int state)` Get name of state, for readable debug output.
`String`	`getStateTypeName(int type)` Get name of state type, for readable debug output.
`String`	`getSubChannelName()` Get name of sub-channel.
`boolean`	`getTreasureList(String filter)` Start treasure list retrieval progress.
`int`	`getUsrState()` Get user login state.
`boolean`	`incTreasure(String name, int value)` Start progress to increase treasure.
`boolean`	`log(char action, String key, int value, String message)` Remote logging.
`boolean`	`login()` Start login progress.
`boolean`	`logout()` Start logout progress.
`void`	`notifyFuncRequestResult(String func, String id, String result)` Notify result of function request.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Called in onActivityResult callback of main Activity.
`void`	`onBackPressed()` Called in onBackPressed callback of main Activity.
`void`	`onCreate(Activity activity, SGAgent.SGClient client)` Initalize SGUtil library.
`void`	`onDestroy()` Called in onDestroy callback of main Activity.
`boolean`	`onKeyDown(int keyCode, KeyEvent event)` Called in onKeyDown callback of main Activity.
`void`	`onNewIntent(Intent newIntent)` Called in onNewIntent callback of main Activity.
`void`	`onPause()` Called in onPause callback of main Activity.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Called in onRequestPermissionsResult callback of main Activity.
`void`	`onRestart()` Called in onRestart callback of main Activity.
`void`	`onResume()` Called in onResume callback of main Activity.
`void`	`onStart()` Called in onStart callback of main Activity.
`void`	`onStop()` Called in onStop callback of main Activity.
`boolean`	`recover(String recoverToken)` Start recover progress.
`String`	`runExtMethod(String cookie, String cmdLine)` Run extended function.
`void`	`setGameServer(SGGameServerInterface gs, Map<String,String> params)` Set game server instance.
`void`	`setOrderStateCheckingIntervals(int[] intervals)` Set intervals in milliseconds to wait before starting automatic result query (after order payment is successfully submitted to channel -- that is, the payment UI operation succeeded).
`boolean`	`setStartupParams(String paramString)`
`boolean`	`shareScreen(String imageFile, String title, String content)` Share screen.
`boolean`	`startGame()` Request to start game.
`boolean`	`stopGame()` Request to stop game.
`void`	`wantOrderInfo()` Request SGAgent to send next order info via onOrderInfoBegin.
`void`	`wantProduct()` Request SGAgent to send next product info via onProductFound.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- EXT_PROP_ARGS
```
public static final int EXT_PROP_ARGS
```
  Extended function need arguments.
- EXT_PROP_ASYNC
```
public static final int EXT_PROP_ASYNC
```
  Extended function is asynchronous.
- EXT_PROP_LOGIN
```
public static final int EXT_PROP_LOGIN
```
  Extended function only effective after login.
- EXT_PROP_NONLOGIN
```
public static final int EXT_PROP_NONLOGIN
```
  Extended function only effective before login.
- EXT_PROP_VOID
```
public static final int EXT_PROP_VOID
```
  Extended function returns void.
- EXT_RET_CANCELLED
```
public static final int EXT_RET_CANCELLED
```
  Asynchronous extended function cancelled.
- EXT_RET_ERROR
```
public static final int EXT_RET_ERROR
```
  Asynchronous extended function failed.
- EXT_RET_OK
```
public static final int EXT_RET_OK
```
  Asynchronous extended function succeeded.
- EXTMETHOD_RET_PREFIX_BAD_CMD
```
public static final String EXTMETHOD_RET_PREFIX_BAD_CMD
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_EMPTY_CMDLINE
```
public static final String EXTMETHOD_RET_PREFIX_EMPTY_CMDLINE
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_LOGIN
```
public static final String EXTMETHOD_RET_PREFIX_LOGIN
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_NO_COOKIE
```
public static final String EXTMETHOD_RET_PREFIX_NO_COOKIE
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_NONLOGIN
```
public static final String EXTMETHOD_RET_PREFIX_NONLOGIN
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_NULL
```
public static final String EXTMETHOD_RET_PREFIX_NULL
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_NULL_ASYNC
```
public static final String EXTMETHOD_RET_PREFIX_NULL_ASYNC
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_STRING
```
public static final String EXTMETHOD_RET_PREFIX_STRING
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_STRING_ASYNC
```
public static final String EXTMETHOD_RET_PREFIX_STRING_ASYNC
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_VOID
```
public static final String EXTMETHOD_RET_PREFIX_VOID
```
  See Also:
  
  Constant Field Values
- EXTMETHOD_RET_PREFIX_VOID_ASYNC
```
public static final String EXTMETHOD_RET_PREFIX_VOID_ASYNC
```
  See Also:
  
  Constant Field Values
- JOBSTATE_ERROR
```
public static final int JOBSTATE_ERROR
```
  Information retrieval state: Error
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GETTINGLOGVALUE
```
public static final int JOBSTATE_GETTINGLOGVALUE
```
  Information retrieval state: Increasing treasure count
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GETTINGORDERINFOLIST
```
public static final int JOBSTATE_GETTINGORDERINFOLIST
```
  Information retrieval state: Retrieving order info list
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GETTINGPLAYERDETAILS
```
public static final int JOBSTATE_GETTINGPLAYERDETAILS
```
  Information retrieval state: Getting player details
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GETTINGPRODUCTS
```
public static final int JOBSTATE_GETTINGPRODUCTS
```
  Information retrieval state: Retrieving product list
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GETTINGTREASURELIST
```
public static final int JOBSTATE_GETTINGTREASURELIST
```
  Information retrieval state: Retrieving treasure list
  
  See Also:
  
  Constant Field Values
- JOBSTATE_GOTPLAYERDETAILS
```
public static final int JOBSTATE_GOTPLAYERDETAILS
```
  Information retrieval state: Got player details
  
  See Also:
  
  Constant Field Values
- JOBSTATE_IDLE
```
public static final int JOBSTATE_IDLE
```
  Information retrieval state: Idle
  
  See Also:
  
  Constant Field Values
- JOBSTATE_INCINGTREASURE
```
public static final int JOBSTATE_INCINGTREASURE
```
  Information retrieval state: Increasing treasure count
  
  See Also:
  
  Constant Field Values
- JOBSTATE_REQUESTEDSTARTGAME
```
public static final int JOBSTATE_REQUESTEDSTARTGAME
```
  Information retrieval state: Starting game request processed
  
  See Also:
  
  Constant Field Values
- JOBSTATE_REQUESTEDSTOPGAME
```
public static final int JOBSTATE_REQUESTEDSTOPGAME
```
  Information retrieval state: Stopping game request processed
  
  See Also:
  
  Constant Field Values
- JOBSTATE_REQUESTINGSTARTGAME
```
public static final int JOBSTATE_REQUESTINGSTARTGAME
```
  Information retrieval state: Requesting to start game
  
  See Also:
  
  Constant Field Values
- JOBSTATE_REQUESTINGSTOPGAME
```
public static final int JOBSTATE_REQUESTINGSTOPGAME
```
  Information retrieval state: Requesting to stop game
  
  See Also:
  
  Constant Field Values
- JOBSTATE_SHAREDSCREEN
```
public static final int JOBSTATE_SHAREDSCREEN
```
  Information retrieval state: Shared screen
  
  See Also:
  
  Constant Field Values
- JOBSTATE_SHARINGSCREEN
```
public static final int JOBSTATE_SHARINGSCREEN
```
  Information retrieval state: Sharing screen
  
  See Also:
  
  Constant Field Values
- OP_AUTH
```
public static final int OP_AUTH
```
  Channel login verification
  
  See Also:
  
  Constant Field Values
- OP_DLVORDER
```
public static final int OP_DLVORDER
```
  Marking as delivered
  
  See Also:
  
  Constant Field Values
- OP_GETLOGVALUE
```
public static final int OP_GETLOGVALUE
```
  Get value of remote log key
  
  See Also:
  
  Constant Field Values
- OP_GETORDER
```
public static final int OP_GETORDER
```
  Order generation
  
  See Also:
  
  Constant Field Values
- OP_GETORDERINFOLIST
```
public static final int OP_GETORDERINFOLIST
```
  Order info list retrieval
  
  See Also:
  
  Constant Field Values
- OP_GETORDERSTATE
```
public static final int OP_GETORDERSTATE
```
  Order state retrieval
  
  See Also:
  
  Constant Field Values
- OP_GETPLAYERDETAILS
```
public static final int OP_GETPLAYERDETAILS
```
  Get player details
  
  See Also:
  
  Constant Field Values
- OP_GETPRODUCTS
```
public static final int OP_GETPRODUCTS
```
  Product list retrieval
  
  See Also:
  
  Constant Field Values
- OP_GETTREASURELIST
```
public static final int OP_GETTREASURELIST
```
  Order info list retrieval
  
  See Also:
  
  Constant Field Values
- OP_INCTREASURE
```
public static final int OP_INCTREASURE
```
  Increase treasure count
  
  See Also:
  
  Constant Field Values
- OP_INIT
```
public static final int OP_INIT
```
  Initialization
  
  See Also:
  
  Constant Field Values
- OP_LOGIN
```
public static final int OP_LOGIN
```
  Channel login
  
  See Also:
  
  Constant Field Values
- OP_LOGINGAME
```
public static final int OP_LOGINGAME
```
  Game server login
  
  See Also:
  
  Constant Field Values
- OP_LOGOUT
```
public static final int OP_LOGOUT
```
  Channel logout
  
  See Also:
  
  Constant Field Values
- OP_LOGOUTGAME
```
public static final int OP_LOGOUTGAME
```
  Game server logout
  
  See Also:
  
  Constant Field Values
- OP_NONE
```
public static final int OP_NONE
```
  No operation
  
  See Also:
  
  Constant Field Values
- OP_PAY
```
public static final int OP_PAY
```
  Pay
  
  See Also:
  
  Constant Field Values
- OP_SHARESCREEN
```
public static final int OP_SHARESCREEN
```
  Share screen
  
  See Also:
  
  Constant Field Values
- OP_STARTGAME
```
public static final int OP_STARTGAME
```
  Start game
  
  See Also:
  
  Constant Field Values
- OP_STOPGAME
```
public static final int OP_STOPGAME
```
  Stop game
  
  See Also:
  
  Constant Field Values
- PAYSTATE_DLVINGORDER
```
public static final int PAYSTATE_DLVINGORDER
```
  Product purchase state: Delivering product
  
  See Also:
  
  Constant Field Values
- PAYSTATE_ERROR
```
public static final int PAYSTATE_ERROR
```
  Product purchase state: Error
  
  See Also:
  
  Constant Field Values
- PAYSTATE_GETTINGORDER
```
public static final int PAYSTATE_GETTINGORDER
```
  Product purchase state: Order is being generated
  
  See Also:
  
  Constant Field Values
- PAYSTATE_GETTINGORDERSTATE
```
public static final int PAYSTATE_GETTINGORDERSTATE
```
  Product purchase state: Retrieving order state
  
  See Also:
  
  Constant Field Values
- PAYSTATE_GOTORDER
```
public static final int PAYSTATE_GOTORDER
```
  Product purchase state: Order generated
  
  See Also:
  
  Constant Field Values
- PAYSTATE_IDLE
```
public static final int PAYSTATE_IDLE
```
  Product purchase state: Idle
  
  See Also:
  
  Constant Field Values
- PAYSTATE_ORDERSUCCEEDED
```
public static final int PAYSTATE_ORDERSUCCEEDED
```
  Product purchase state: Payment succeeded
  
  See Also:
  
  Constant Field Values
- PAYSTATE_PAID
```
public static final int PAYSTATE_PAID
```
  Product purchase state: Payment UI operation succeeded
  
  See Also:
  
  Constant Field Values
- PAYSTATE_PAYING
```
public static final int PAYSTATE_PAYING
```
  Product purchase state: Payment UI operation ongoing
  
  See Also:
  
  Constant Field Values
- STATE_CHANGE_REASON_NONE
```
public static final int STATE_CHANGE_REASON_NONE
```
  Reason of state change: None
  
  See Also:
  
  Constant Field Values
- STATE_CHANGE_REASON_OP
```
public static final int STATE_CHANGE_REASON_OP
```
  Reason of state change: An operation was performed
  
  See Also:
  
  Constant Field Values
- STATE_CHANGE_REASON_OP_CANCELED
```
public static final int STATE_CHANGE_REASON_OP_CANCELED
```
  Reason of state change: Operation cancelled
  
  See Also:
  
  Constant Field Values
- STATE_CHANGE_REASON_OP_FAILURE
```
public static final int STATE_CHANGE_REASON_OP_FAILURE
```
  Reason of state change: Operation failed
  
  See Also:
  
  Constant Field Values
- STATE_CHANGE_REASON_OP_SUCCESS
```
public static final int STATE_CHANGE_REASON_OP_SUCCESS
```
  Reason of state change: Operation succeeded
  
  See Also:
  
  Constant Field Values
- STATE_TYPE_JOB
```
public static final int STATE_TYPE_JOB
```
  Information retrieval state
  
  See Also:
  
  Constant Field Values
- STATE_TYPE_PAY
```
public static final int STATE_TYPE_PAY
```
  Product purchase
  
  See Also:
  
  Constant Field Values
- STATE_TYPE_USR
```
public static final int STATE_TYPE_USR
```
  User login state
  
  See Also:
  
  Constant Field Values
- USRSTATE_AUTHED
```
public static final int USRSTATE_AUTHED
```
  User login state: Verified channel login information
  
  See Also:
  
  Constant Field Values
- USRSTATE_AUTHING
```
public static final int USRSTATE_AUTHING
```
  User login state: Verifying channel login information
  
  See Also:
  
  Constant Field Values
- USRSTATE_ERROR
```
public static final int USRSTATE_ERROR
```
  User login state: Error
  
  See Also:
  
  Constant Field Values
- USRSTATE_IDLE
```
public static final int USRSTATE_IDLE
```
  User login state: Idle
  
  See Also:
  
  Constant Field Values
- USRSTATE_INITIALIZED
```
public static final int USRSTATE_INITIALIZED
```
  User login state: Initialized
  
  See Also:
  
  Constant Field Values
- USRSTATE_INITIALIZING
```
public static final int USRSTATE_INITIALIZING
```
  User login state: Initializing
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGINED
```
public static final int USRSTATE_LOGINED
```
  User login state: Logined to channel
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGINEDGAME
```
public static final int USRSTATE_LOGINEDGAME
```
  User login state: Logined to game server
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGINING
```
public static final int USRSTATE_LOGINING
```
  User login state: Logining to channel
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGININGGAME
```
public static final int USRSTATE_LOGININGGAME
```
  User login state: Logining to game server
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGOUTED
```
public static final int USRSTATE_LOGOUTED
```
  User login state: Logouted from channel
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGOUTEDGAME
```
public static final int USRSTATE_LOGOUTEDGAME
```
  User login state: Logouted from game server
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGOUTING
```
public static final int USRSTATE_LOGOUTING
```
  User login state: Logouting from channel
  
  See Also:
  
  Constant Field Values
- USRSTATE_LOGOUTINGGAME
```
public static final int USRSTATE_LOGOUTINGGAME
```
  User login state: Logouting from game server
  
  See Also:
  
  Constant Field Values

Constructor Detail
- SGAgent
```
public SGAgent()
```

Method Detail

buyProduct
```
public boolean buyProduct(String productID,
                          int num,
                          String treasure)
```
Initiate product purchase.

Parameters:

productID - product ID

num - copied to buy, should be 1 at present

Returns:

true for success, false otherwise. Failure is caused by bad state.

exit
```
public void exit()
```
Exit application. Exit immediately or after showing confirmation according to internal state and channel SDK support status.

getAccount
```
public UAccount getAccount()
```
Get final account.

Returns:

final account

getApkVersionCode
```
public int getApkVersionCode()
```
Get version code.

Returns:

version code

getApkVersionName
```
public String getApkVersionName()
```
Get version name.

Returns:

version name

getAppID
```
public int getAppID()
```
Get application ID.

Returns:

application ID

getAppKey
```
public String getAppKey()
```
Get application key.

Returns:

application key

getChannelConfigs
```
public Map<String,String> getChannelConfigs()
```
Get channel config items.

Returns:

channel config items

getChannelID
```
public int getChannelID()
```
Get channel ID.

Returns:

channel ID

getChannelName
```
public String getChannelName()
```
Get channel short name.

Returns:

channel short name

getDeviceID
```
public String getDeviceID()
```
Get device ID.

Returns:

device ID

getGameServer
```
public SGGameServerInterface getGameServer()
```
Get current game server instance.

Returns:

current game server instance

getJobState
```
public int getJobState()
```
Get information retrieval state.

Returns:

information retrieval state

getLoginExtensionMap

public Map<String,String> getLoginExtensionMap()

getLogValue
```
public boolean getLogValue(String key,
                           int defaultValue)
```
Start progress to get value of remote log key. If true is returned, value will be notified via SGClient.onLogValue asynchronously. Refer to SGGameServerInterface.getLogValue.

Parameters:

key - key to match

defaultValue - default value to return in case of failure

Returns:

true for success, false otherwise. Failure is caused by bad state.

getOpName
```
public String getOpName(int op)
```
Get name of operation, for readable debug output.

Parameters:

op - operation code

Returns:

name of operation

getOrderInfoList
```
public boolean getOrderInfoList(String filter)
```
Start order info list retrieval progress. If true is returned, order info will be notified via SGClient.onOrderInfoFound asynchronously.

Parameters:

filter - a string to be passed to game server as a query item in URL, may be used for a filter.

Returns:

true for success, false otherwise. Failure is caused by bad state.

getOrderState
```
public boolean getOrderState(String orderID)
```
Start payment result retrieval progress. If true is returned, payment result will be notified via SGClient.onOrderStateChange asynchronously. The process includes checking whether the money has been funded to your account, and marking the order as delivered after that.

Parameters:

orderID - order ID

Returns:

true for success, failure otherwise. Failure is caused by bad state.

getPayState
```
public int getPayState()
```
Get product purchase state.

Returns:

product purchase state

getPlayerDetails
```
public boolean getPlayerDetails()
```
Get player details.

Returns:

true for success, false otherwise. Failure is caused by bad state.

getProductByOrderID
```
public UProduct getProductByOrderID(String orderID)
```
Find product corresponding to specified order ID.

Parameters:

orderID - order ID

Returns:

product bought in specified order, null if not found

getProducts
```
public boolean getProducts(String filter,
                           boolean sorting)
```
Start product list retrieval progress. If true is returned, product info will be notified via SGClient.onProductFound asynchronously.

Parameters:

filter - string to be passed to game server as a query item in URL, may be used as a filter.

sorting - specify whether sort the products or not. Sorting criteria is product price and coins.

Returns:

true for success, false otherwise. Failure is caused by bad state.

getSession
```
public USession getSession()
```
Get session.

Returns:

session

getStateChangeReasonName
```
public String getStateChangeReasonName(int reason)
```
Get name of state change reason, for readable debug output.

Parameters:

reason - state change reason. One of STATE_CHANGE_REASON_NONE, STATE_CHANGE_REASON_OP, STATE_CHANGE_REASON_OP_SUCCESS, STATE_CHANGE_REASON_OP_FAILURE and STATE_CHANGE_REASON_OP_CANCELED.

Returns:

name of state change reason

getStateName
```
public String getStateName(int type,
                           int state)
```
Get name of state, for readable debug output.

Parameters:

type - state type. One of STATE_TYPE_USR, STATE_TYPE_JOB and STATE_TYPE_PAY.

state - state

Returns:

state name

getStateTypeName
```
public String getStateTypeName(int type)
```
Get name of state type, for readable debug output.

Parameters:

type - state type. One of STATE_TYPE_USR, STATE_TYPE_JOB and STATE_TYPE_PAY.

Returns:

name of state type

getSubChannelName
```
public String getSubChannelName()
```
Get name of sub-channel.

Returns:

name of sub-channel

getTreasureList
```
public boolean getTreasureList(String filter)
```
Start treasure list retrieval progress. If true is returned, treasure list will be notified via SGClient.onTreasureListFound asynchronously.

Parameters:

filter - filter string

Returns:

true for success, false otherwise. Failure is caused by bad state.

getUsrState
```
public int getUsrState()
```
Get user login state.

Returns:

user login state

incTreasure
```
public boolean incTreasure(String name,
                           int value)
```
Start progress to increase treasure. If true is returned, the new treasure count will be notified via SGClient.onTreasureChange asynchronously.

Returns:

true for success, false otherwise. Failure is caused by bad state.

log
```
public boolean log(char action,
                   String key,
                   int value,
                   String message)
```
Remote logging. Refer to 参见SGGameServerInterface.log.

Parameters:

action - action code

key - used to match (and update) existing record with the same key

value - integer value

message - additional information

Returns:

true for success, false otherwise. Failure is caused by bad state or queue size limitation.

login
```
public boolean login()
```
Start login progress.

Returns:

true for success, false otherwise. Failure is caused by bad state.

logout
```
public boolean logout()
```
Start logout progress.

Returns:

true for success, false otherwise. Failure is caused by bad state.

notifyFuncRequestResult
```
public void notifyFuncRequestResult(String func,
                                    String id,
                                    String result)
```
Notify result of function request. Refer to SGClient.onFuncRequest .

Parameters:

func - Function name.

id - Function ID.

result - Result. One of "succeeded", "failed" and "cancelled".

onActivityResult
```
public void onActivityResult(int requestCode,
                             int resultCode,
                             Intent data)
```
Called in onActivityResult callback of main Activity.

Parameters:

requestCode - Android standard parameter

resultCode - Android standard parameter

data - Android standard parameter

onBackPressed
```
public void onBackPressed()
```
Called in onBackPressed callback of main Activity. SGAgent will not terminate main Activity on the call, you should manually terminate it if you want.

onCreate
```
public void onCreate(Activity activity,
                     SGAgent.SGClient client)
```
Initalize SGUtil library. Must be called in onCreate callback of main Activity.

Parameters:

activity - main Activity

client - object that implemented SGClient interface

onDestroy
```
public void onDestroy()
```
Called in onDestroy callback of main Activity.

onKeyDown
```
public boolean onKeyDown(int keyCode,
                         KeyEvent event)
```
Called in onKeyDown callback of main Activity.

Parameters:

keyCode - Android standard parameter

event - Android standard parameter

Returns:

true for handled, false otherwise

onNewIntent
```
public void onNewIntent(Intent newIntent)
```
Called in onNewIntent callback of main Activity.

Parameters:

newIntent - Android standard parameter

onPause
```
public void onPause()
```
Called in onPause callback of main Activity.

onRequestPermissionsResult
```
public void onRequestPermissionsResult(int requestCode,
                                       String[] permissions,
                                       int[] grantResults)
```
Called in onRequestPermissionsResult callback of main Activity.

Parameters:

requestCode - Android standard parameter

permissions - Android standard parameter

grantResults - Android standard parameter

onRestart
```
public void onRestart()
```
Called in onRestart callback of main Activity.

onResume
```
public void onResume()
```
Called in onResume callback of main Activity.

onStart
```
public void onStart()
```
Called in onStart callback of main Activity.

onStop
```
public void onStop()
```
Called in onStop callback of main Activity.

recover
```
public boolean recover(String recoverToken)
```
Start recover progress.

Returns:

true for success, false otherwise. Failure is caused by bad state.

runExtMethod

public String runExtMethod(String cookie,
                           String cmdLine)

Run extended function. Extended functions depend on channel SDK implementation, and thus is not inter-operable. All extended methos only accept String arguments, and return only String result. There 8 prototypes:

String methodName() flags=0
String methodName(String ... args) flags=4
void methodName() flags=1
void methodName(String ... args) flags=5
String methodName(String cookie) flags=2
String methodName(String cookie, String ... args) flags=6
void methodName(String cookie) flags=3
void methodName(String cookie, String ... args) flags=7

Bit 0 (EXT_PROP_VOID) indicates a void method if set, otherwise a method returning String；bit 1 (EXT_PROP_ASYNC) indicates a asynchronous method and there will be a notification of result; bit 2 (EXT_PROP_ARGS) indicates the method accepts String ... arguments. If set, bit 4 (EXT_PROP_NONLOGIN) indicates the method is only usable before login, while bit 5 ((EXT_PROP_LOGIN) indicates the method is only usable after login. SGAgent hides direct calls of extended methods, so you should call them via this method in following command line formats.

Format	Meaning
?	Display all methods in format methodName=flags.
?*	Display all methods in format String methodName(String cookie, String ... args).
? methodName	Display specified method in format methodName=flags.
?* methodName	Display specified method in format String methodName(String cookie, String ... args).
methodName	Run method without arguments
methodName arg0 arg1 ...	Run method with arguments
methodName cookie	Run asynchronous method without arguments
methodName cookie arg0 arg1 ...	Run asynchronous method with arguments

Method name, cookie and arguments must be separated with space. If an argument has spaces you should quote it with double quotation mark. If it has double quotation mark itself, you should escape it with "\".

Asynchronous notification is delivered via SGClient.onExtMethodNotification.

Refer to DocumentWorkspace for channel individual description.

Parameters:

cookie - string used as cookie for asynchronous method

cmdLine - command line

Returns:

This method always returns a string, with the first 2 characters as indicator, followed by string returned by extended functions. The indicator has following meanings:

!u Error: not loginned
!e Error: empty command line
!b Error: no such method
!c Error: cookie not specified
*v the return type is void
@v the return type is void, there will be asynchronous notification
*n the extended function returned null
@n the extended function returned null, there will be asynchronous notification
*s the extended function returned String
@s the extended function returned String, there will be asynchronous notification

setGameServer
```
public void setGameServer(SGGameServerInterface gs,
                          Map<String,String> params)
```
Set game server instance. The default is not set, hence you need to implement SGGameServerInterface and set via this method.

Parameters:

gs - Instance of game server interface implementation

params - Parameters to be passed to method SGGameServerInterface.ini

setOrderStateCheckingIntervals
```
public void setOrderStateCheckingIntervals(int[] intervals)
```
Set intervals in milliseconds to wait before starting automatic result query (after order payment is successfully submitted to channel -- that is, the payment UI operation succeeded).

Parameters:

intervals - Time intervals in milliseconds. Wait intervals[0] milliseconds before first query, intervals[1] milliseconds before second query, and so on, until query succeeds. Automatic query is given up if all intervals is run out. Automatic query is not performed if intervals is null or an empty array. You should call getOrderState to start query manually in this case. Other function cannot be executed during the automatic query period. If you think it a problem, please set intervals to null and call getOrderState to start query by yourself.

setStartupParams

public boolean setStartupParams(String paramString)

shareScreen
```
public boolean shareScreen(String imageFile,
                           String title,
                           String content)
```
Share screen.

Parameters:

imageFile - path of image to share.

title - Title.

content - Content of description.

Returns:

true for success, false otherwise. Failure is caused by bad state.

startGame
```
public boolean startGame()
```
Request to start game.

Returns:

true for success of submission, false otherwise. Failure is caused by bad state.

stopGame
```
public boolean stopGame()
```
Request to stop game.

Returns:

true for success of submission, false otherwise. Failure is caused by bad state.

wantOrderInfo
```
public void wantOrderInfo()
```
Request SGAgent to send next order info via onOrderInfoBegin. Effective only when onOrderInfoBegin returns false.

wantProduct
```
public void wantProduct()
```
Request SGAgent to send next product info via onProductFound. Effective only when onProductBegin returns false.

Class SGAgent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

EXT_PROP_ARGS

EXT_PROP_ASYNC

EXT_PROP_LOGIN

EXT_PROP_NONLOGIN

EXT_PROP_VOID

EXT_RET_CANCELLED

EXT_RET_ERROR

EXT_RET_OK

EXTMETHOD_RET_PREFIX_BAD_CMD

EXTMETHOD_RET_PREFIX_EMPTY_CMDLINE

EXTMETHOD_RET_PREFIX_LOGIN

EXTMETHOD_RET_PREFIX_NO_COOKIE

EXTMETHOD_RET_PREFIX_NONLOGIN

EXTMETHOD_RET_PREFIX_NULL

EXTMETHOD_RET_PREFIX_NULL_ASYNC

EXTMETHOD_RET_PREFIX_STRING

EXTMETHOD_RET_PREFIX_STRING_ASYNC

EXTMETHOD_RET_PREFIX_VOID

EXTMETHOD_RET_PREFIX_VOID_ASYNC

JOBSTATE_ERROR

JOBSTATE_GETTINGLOGVALUE

JOBSTATE_GETTINGORDERINFOLIST

JOBSTATE_GETTINGPLAYERDETAILS

JOBSTATE_GETTINGPRODUCTS

JOBSTATE_GETTINGTREASURELIST

JOBSTATE_GOTPLAYERDETAILS

JOBSTATE_IDLE

JOBSTATE_INCINGTREASURE

JOBSTATE_REQUESTEDSTARTGAME

JOBSTATE_REQUESTEDSTOPGAME

JOBSTATE_REQUESTINGSTARTGAME

JOBSTATE_REQUESTINGSTOPGAME

JOBSTATE_SHAREDSCREEN

JOBSTATE_SHARINGSCREEN

OP_AUTH

OP_DLVORDER

OP_GETLOGVALUE

OP_GETORDER

OP_GETORDERINFOLIST

OP_GETORDERSTATE

OP_GETPLAYERDETAILS

OP_GETPRODUCTS

OP_GETTREASURELIST

OP_INCTREASURE

OP_INIT

OP_LOGIN

OP_LOGINGAME

OP_LOGOUT

OP_LOGOUTGAME

OP_NONE

OP_PAY

OP_SHARESCREEN

OP_STARTGAME

OP_STOPGAME

PAYSTATE_DLVINGORDER

PAYSTATE_ERROR

PAYSTATE_GETTINGORDER

PAYSTATE_GETTINGORDERSTATE

PAYSTATE_GOTORDER

PAYSTATE_IDLE

PAYSTATE_ORDERSUCCEEDED

PAYSTATE_PAID

PAYSTATE_PAYING

STATE_CHANGE_REASON_NONE

STATE_CHANGE_REASON_OP

STATE_CHANGE_REASON_OP_CANCELED

STATE_CHANGE_REASON_OP_FAILURE

STATE_CHANGE_REASON_OP_SUCCESS

STATE_TYPE_JOB

STATE_TYPE_PAY

STATE_TYPE_USR

USRSTATE_AUTHED

USRSTATE_AUTHING