com.sg.util

Interface SGAgent.SGClient

All Known Implementing Classes:

SGActivity

Enclosing class:

SGAgent

public static interface SGAgent.SGClient

SGClient interface. Defines methods to be implemented as SGAgent's client. These methods are called by SGAgent to notify Activity information or request Activity to do specified job.

Method Summary

Modifier and Type	Method and Description
void	onExitCancelled() Notify that the exit operation was cancelled.
void	onExtMethodNotification(String cookie, int code, String msg) Notify the result of asynchronous function.
void	onFuncRequest(String func, String id, String arg) Notify client the underlying layer request application to execute a function.
void	onLog(String text) Display debug message.
void	onLog(String text, String postfix) Display debug message.
void	onLogValue(String key, int value, String msg) Inform client value of remote log key.
boolean	onOrderInfoBegin(int num) Inform client that order information notification will be started.
void	onOrderInfoEnd() Inform client that order information notification is finished.
void	onOrderInfoFound(UOrder order) Send order information to client.
void	onOrderStateChange(String productID, int num, String orderID, String state, String message) Notify client the state change of product purchase.
void	onPlayerDetails(String details) Notify player details.
boolean	onProductBegin(int num) Inform client that product information notification will be started.
void	onProductEnd() Inform client that product information notification is finished.
void	onProductFound(UProduct product) Send product information to client.
void	onStateChange(int type, int orgState, int newState, int reason, int op, String arg) Notify client the internal state change in SGAgent.
void	onTreasureChange(String name, int count) Inform client updated treasure count.
void	onTreasureListFound(String[] treasures) Inform client that treasure list is retrieved.

Method Detail

onExitCancelled

void onExitCancelled()

Notify that the exit operation was cancelled. Application should recover current screen and go on.

onExtMethodNotification

void onExtMethodNotification(String cookie,
                             int code,
                             String msg)

Notify the result of asynchronous function.

Parameters:

cookie - string for identification passed when run the function

code - result code. One of EXT_RET_OK, EXT_RET_ERROR and EXT_RET_CANCELLED.

msg - content of notification. The format depends on function implementation.

onFuncRequest

void onFuncRequest(String func,
                   String id,
                   String arg)

Notify client the underlying layer request application to execute a function.

Parameters:

func - Function name. Should be on of "screenshot" and "logout".

id - Operation ID. Application may use it to perform multiple operations.

arg - Argument. For "screenshot", it is the file path to which the screen shot should be saved to. Notify that the exit operation was cancelled. Application should recover current screen and go on.

onLog

void onLog(String text)

Display debug message. Used to display debug message on screen.

Parameters:

text - message to display

onLog

void onLog(String text,
           String postfix)

Display debug message. Used to display debug message on screen.

Parameters:

text - message to display

postfix - postfix to be appended after text

onLogValue

void onLogValue(String key,
                int value,
                String msg)

Inform client value of remote log key.

Parameters:

key - key to match

value - value of key or specified default value

msg - content text of the log

onOrderInfoBegin

boolean onOrderInfoBegin(int num)

Inform client that order information notification will be started.

Parameters:

num - number of orders

Returns:

true for expecting SGAgent to send order information immediately, otherwise expecting SGAgent to send next order information every time SGAgent.wantOrderInfo() is called.

onOrderInfoEnd

void onOrderInfoEnd()

Inform client that order information notification is finished.

onOrderInfoFound

void onOrderInfoFound(UOrder order)

Send order information to client.

Parameters:

order - order information, null indicating no more information is available

onOrderStateChange

void onOrderStateChange(String productID,
                        int num,
                        String orderID,
                        String state,
                        String message)

Notify client the state change of product purchase.

Parameters:

productID - product ID

orderID - order ID

num - number of copies

state - state. One of the following text strings:
"ordering" - generating order
"ordered" - generated order
"paying" - payment UI operation ongoing
"cancelled" - cancelled by user
"accepted" - payment request accepted by channel
"confirming" - confirming order state
"succeeded" - payment succeeded (money received)
"cheated" - money is less than the price
"failed" - payment failed
"delivering" - (game server) marking order to be delivered
"delivered" - (game server) marked order to be delivered

onPlayerDetails

void onPlayerDetails(String details)

Notify player details.

Parameters:

details - player details

onProductBegin

boolean onProductBegin(int num)

Inform client that product information notification will be started.

Parameters:

num - number of products

Returns:

true for expecting SGAgent to send product information immediately, otherwise expecting SGAgent to send next product information every time SGAgent.wantProduct() is called.

onProductEnd

void onProductEnd()

Inform client that product information notification is finished.

onProductFound

void onProductFound(UProduct product)

Send product information to client.

Parameters:

product - product information, null indicating no more information is available

onStateChange

void onStateChange(int type,
                   int orgState,
                   int newState,
                   int reason,
                   int op,
                   String arg)

Notify client the internal state change in SGAgent. You may use this notification to update UI or do relevant processing.

Parameters:

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

orgState - original state

newState - new state

reason - reason of state change. 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.

op - operation leading to the change

arg - extra string information. arg is set to the value of parameter imageFile passed to SGAgent.shareScreen by application. Application may use this string to delete temporary image file created for sharing.

onTreasureChange

void onTreasureChange(String name,
                      int count)

Inform client updated treasure count.

Parameters:

name - treasure name

count - treasure count

onTreasureListFound

void onTreasureListFound(String[] treasures)

Inform client that treasure list is retrieved.

Parameters:

treasures - Treasure array. Each item of the array has format "name=count", where 'count' is an integer indicating number of a certain treasure.