top

'Tizen::TV::Service::Billing::BillingPlugin' class Reference

Events

BillingClientClosedEventHandler BuyItemEventHandler
The billing transaction event handler, which can be added/removed. More...
BillingRequestAPICallbackEventHandler RequestAPIEventHandler
The billing request API event handler, which can be added/removed. More...
BillingShowDeepLinkCallbackEventHandler ShowDeepLinkEventHandler
The billing deep-link feature event handler, which can be added/removed. More...

Public Functions

BillingPlugin ( )
The Billing plugin constructor. More...
string GetVersion ( )
Gets the Billing CS plugin version. More...
bool ShowPurchaseHistory ( string strHistoryApp, BillingRequestPurchaseHistoryType eHistoryDetail )
A billing client deep-link feature. Launches the billing client's purchaseHistory page. More...
bool ShowRegisterPromotionalCode ( )
A billing client deep-link feature. Launches the billing client's promotional codes page. More...
bool ShowRegisterCreditCard ( )
A billing client deep-link feature. Launch the billing client's credit card registration page. More...

Events

BillingClientClosedEventHandler BuyItemEventHandler

   The billing transaction event handler, which can be added/removed.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

BillingRequestAPICallbackEventHandler RequestAPIEventHandler

   The billing request API event handler, which can be added/removed.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

BillingShowDeepLinkCallbackEventHandler ShowDeepLinkEventHandler

   The billing deep-link feature event handler, which can be added/removed.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

Public Functions

BillingPlugin()

   The Billing plugin constructor.

Exceptions

PlatformNotSupportedException
   Thrown when billing api is used on the emulator.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

string GetVersion()

   Gets the Billing CS plugin version.

Returns

Billing CS plugin version string value.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool BuyItem(string appId, BillingRequestServerType serverType, string payDetail)

   Launches the billing client.

Parameters

appId
   The application ID.
serverType
   The payment server type.
payDetail
   The detailed payment information.

Returns

A boolean value. Returns true if the Billing client is launched.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool IsServiceAvailable(BillingRequestServerType eServerType)

   Gets the payment service availability.

Parameters

eServerType
   The billing server type to check.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool GetPurchaseList(string strAppId, string strCustomId, string strCountryCode, int iPageNumber, string strCheckValue, BillingRequestServerType eServerType)

   'Get Purchase List' server open API interface.

Parameters

strAppId
   The application ID.
strCustomId
   The same as the OrderCustomID in the third parameter of the "BuyItem" API (detailed payment information). It is usually the user's Samsung Account UID.
strCountryCode
   The country code, such as "US".
iPageNumber
   The page number.
strCheckValue
   The security hash code. For more information, see the API guide documentation.
eServerType
   The request server type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool ShowPurchaseHistory(string strHistoryApp, BillingRequestPurchaseHistoryType eHistoryDetail)

   A billing client deep-link feature. Launches the billing client's purchaseHistory page.

Parameters

strHistoryApp
   The application ID to view the payment history for. To view the payment history for all applications, use the string "ALL".
eHistoryDetail
   The requested payment history data type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool ShowRegisterPromotionalCode()

   A billing client deep-link feature. Launches the billing client's promotional codes page.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool ShowRegisterCreditCard()

   A billing client deep-link feature. Launch the billing client's credit card registration page.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool CancelSubscription(string strAppId, string strCustomId, string strInvoiceId, string strCountryCode, BillingRequestServerType eServerType)

   The 'Cancel Subscription' server open API interface.

Parameters

strAppId
   The application ID.
strCustomId
   The same as the OrderCustomID in the third parameter of the "BuyItem" API (detailed payment information). It is usually the user's Samsung Account UID.
strInvoiceId
   The invoice ID for which the subscription is to be cancelled.
strCountryCode
   The country code, such as "US".
eServerType
   The request server type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool ApplyInvoice(string strAppId, string strCustomId, string strInvoiceId, string strCountryCode, BillingRequestServerType eServerType)

   The 'ApplyInvoice' server open API Interface.

Parameters

strAppId
   The application ID.
strCustomId
   The same as the OrderCustomID in the third parameter of the "BuyItem" API (detailed payment information). It is usually the user's Samsung Account UID.
strInvoiceId
   The invoice ID to set the invoice status to "apply".
strCountryCode
   The country code, such as "US".
eServerType
   The request server type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool VerifyInvoice(string strAppId, string strCustomId, string strInvoiceId, string strCountryCode, BillingRequestServerType eServerType)

   The 'VerifyInvoice' server open API interface.

Parameters

strAppId
   The application ID.
strCustomId
   The same as the OrderCustomID in the third parameter of the "BuyItem" API (detailed payment information). It is usually the user's Samsung Account UID.
strInvoiceId
   The invoice ID whose status is to be checked.
strCountryCode
   The country code, such as "US".
eServerType
   The request server type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0

bool GetProductsList(string strAppId, string strCountryCode, int iPageSize, int iPageNumber, string strCheckValue, BillingRequestServerType eServerType)

   The 'Request Product list' server open API interface.

Parameters

strAppId
   The application ID.
strCountryCode
   The country code, such as "US".
iPageSize
   The number of products to show on each page.
iPageNumber
   The page number.
strCheckValue
   The security hash code. For more information, see the API guide documentation.
eServerType
   The request server type. For more information, see the API guide documentation.

Returns

A boolean value. Returns true if this API is called successfully.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/billing

Version

4.4.0