Payment System

The Payment System of SGUtil For Unity provides following methods.

Get Product List

Method

void GetProductList(string filter)

Parameters
  • filter - the string parmater to be passed to getProductList method of game server, used by game server to filter/control results.
Remark
  • Retrieve product(property) list from game server.
  • Product(Property) list is notified via OnProduct.

Get Product List Callback

Method

void OnProduct(SGUResult resultCode, SGUProduct product)

Parameters
  • resultCode - result code
  • product - Product information, see SGU.cs for its member definition. Refer to UProduct.
Remark
  • Product notification begins with RESULT_ITEM_BEGIN, followed by RESULT_ITEM, and ends with RESULT_ITEM_END.

Buy Product

Method

void Buy(string product_id)

Parameters
  • product_id - product ID
Remark
  • Starts up progress of product purchase.
  • Generation of order and its state change are notified via OnOrderStateChange. The caller must save the order ID for future use.
  • The result of payment UI operation is notified via OnPay.
  • OnOrderStateChange is called before OnPay to notify order generation and state change.

Buy Product Callback

Method

void OnPay(SGUResult resultCode)

Parameters
  • resultCode - result code
Remark
  • 'result' being RESULT_OK indicates user confirmed to pay and the order was accepted by channel. The caller may call GetOrderState to confirm whether correct amount of money has been transferred to account.

Get Order State

Method

void GetOrderState(string order_id)

Parameters
  • order_id - order ID
Remark
  • This method is typically called after user completed payment UI operation to confirm whether correct amount of money has been transferred to account.
  • Please note success of payment UI operation DO NOT INIDICATE success of money transfer.
  • The result is notified to caller via OnOrderStateChange.

Get Order State Callback

Method

void OnOrderStateChange(SGUResult resultCode, SGUOrderState order_state)

Parameters
  • resultCode - result code
  • order_state - order state
Remark
  • This callback is initiated after Buy or GetOrderState are called.
  • SGUOrderState's member 'OrderID' is null when member 'State' is "ordering",it has a fulfilling value after 'State' becomes "ordered". The caller should save the order ID for future state query and management.
  • For values of SGUOrderState's member 'State', please refer to SGAgent.SGClient.onOrderStateChange. However, if 'State' is 'error', it means GetOrderState cannot be done at present.

Get Treasure List

Method

void GetTreasureList(string filter)

Parameters
  • filter - the string parmater to be passed to getTreasureList method of game server, used by game server to filter/control results.
Remark
  • Retrieve treasure list owned by the user from game server.
  • Treasure data are notified via OnTreasureList.

Get Treasure List Callback

Method

void OnTreasureList(SGUResult resultCode, SGUTreasure treasure)

Parameters
  • resultCode - result code
  • treaure - treasure data, see SGU.cs for its member definition.
Remark
  • Treasure data notification begins with RESULT_ITEM_BEGIN, followed by RESULT_ITEM, and ends with RESULT_ITEM_END.