To use Samsung Product API, <script type="text/javascript" src="$WEBAPIS/webapis/webapis.js"></script> Should be loaded in index.html
To use Samsung Product API,
<script type="text/javascript" src="$WEBAPIS/webapis/webapis.js"></script>
Should be loaded in index.html
This module defines the SSO functionalities provided by the Tizen Samsung Product API.
Since : 2.3
Product : TV, BD
Privilege Level : Partner
Privilege : http://developer.samsung.com/privilege/sso.partner
Defines a dictionary for login data.
dictionary SsoData { boolean bLogin; DOMString id; DOMString authToken; DOMString uid; DOMString guid; };
The following values are supported
Defines a WebApi object instance of the Tizen Samsung Product API. The webapis.sso object enables access to SSO API functionality.
[NoInterfaceObject] interface SsoManagerObject { readonly attribute SsoManager sso; };
WebApi implements SsoManagerObject;
Provides methods for SSO functionalities.
[NoInterfaceObject] interface SsoManager { void showAccountView(DOMString widgetName, SsoCallDataSuccessCallback onsuccess, optional ErrorCallback? onerror); DOMString getVersion(); DOMString getLoginUid(); SsoLoginState getLoginStatus(); void showCreateAccountView(SsoNumSuccessCallback onsuccess, optional ErrorCallback? onerror); };
Shows the SSO login or logout page, and returns the SSO login or logout information.
void showAccountView(DOMString widgetName, SsoCallDataSuccessCallback onsuccess, optional ErrorCallback? onerror);
Parameters :
Exceptions :
Code Example :
var onsuccess = function(result) { console.log('success : ' + JSON.stringify(result)); }; var onerror = function (error) { console.log('error : ' + error); }; webapis.sso.showAccountView("Facebook", onsuccess, onerror);
Retrieves the plugin version number.
DOMString getVersion();
Return Value :
var result = webapis.sso.getVersion();
Retrieves the UID.
The UID is considered personally-identifying information and must be handled according to the privacy regulations for each country. It must not be used for any purpose other than as an input parameter for the Samsung Checkout API. Whenever the UID value is sent outside the device, a secure protocol, such as HTTPS, must be used.
DOMString getLoginUid();
var result = webapis.sso.getLoginUid();
Retrieves the SSO login status.
SsoLoginState getLoginStatus();
var result = webapis.sso.getLoginStatus();
Shows the SSO account creation screen.
void showCreateAccountView(SsoNumSuccessCallback onsuccess, optional ErrorCallback? onerror);
var onsuccess = function(result) { console.log('success : ' + result); }; var onerror = function (error) { console.log('error : ' + error); }; webapis.sso.showCreateAccountView(onsuccess, onerror);
Defines the login success callback.
[Callback = FunctionOnly, NoInterfaceObject] interface SsoCallDataSuccessCallback { void onsuccess(SsoCallData data); };
Callback method returning the login success data.
void onsuccess(SsoCallData data);
Defines the success callback for string data.
[Callback = FunctionOnly, NoInterfaceObject] interface SsoStringSuccessCallback { void onsuccess(DOMString data); };
Callback method returning string data.
void onsuccess(DOMString data);
Defines the success callback for number data.
[Callback = FunctionOnly, NoInterfaceObject] interface SsoNumSuccessCallback { void onsuccess(Long data); };
Callback method returning number data.
void onsuccess(Long data);
Defines constants for login status.
[NoInterfaceObject] interface SsoLoginState { const unsigned short SSO_NOT_LOGIN = 0; const unsigned short SSO_LOGIN = 1; };
Defines constants for agreement status.
[NoInterfaceObject] interface SsoTermsAgreementState { const unsigned short SSO_NOT_AGREE = 0; const unsigned short SSO_AGREE = 1; };
module Sso { dictionary SsoData { boolean bLogin; DOMString id; DOMString authToken; DOMString uid; DOMString guid; }; [NoInterfaceObject] interface SsoManagerObject { readonly attribute SsoManager sso; }; WebApi implements SsoManagerObject; [NoInterfaceObject] interface SsoManager { void showAccountView(DOMString widgetName, SsoCallDataSuccessCallback onsuccess, optional ErrorCallback? onerror); DOMString getVersion(); DOMString getLoginUid(); SsoLoginState getLoginStatus(); void showCreateAccountView(SsoNumSuccessCallback onsuccess, optional ErrorCallback? onerror); }; [Callback = FunctionOnly, NoInterfaceObject] interface SsoCallDataSuccessCallback { void onsuccess(SsoCallData data); }; [Callback = FunctionOnly, NoInterfaceObject] interface SsoStringSuccessCallback { void onsuccess(DOMString data); }; [Callback = FunctionOnly, NoInterfaceObject] interface SsoNumSuccessCallback { void onsuccess(Long data); }; [NoInterfaceObject] interface SsoLoginState { const unsigned short SSO_NOT_LOGIN = 0; const unsigned short SSO_LOGIN = 1; }; [NoInterfaceObject] interface SsoTermsAgreementState { const unsigned short SSO_NOT_AGREE = 0; const unsigned short SSO_AGREE = 1; }; };