top

'Tizen::TV::Service::Sso::Sso' class Reference

Public Types

LoginState
Type for current user log on or off. More...
Result
The type of each API's result whether success or not. More...
PageType
Type for SSO each pages More...

Public Attributes

const string TermsOntvTnc
One of Terms and Condition(TnC). This Tnc use persnal account. More...
const string TermsOntvPn
One of Terms and Condition(TnC). This Tnc use persnal account. More...
const string TermsGame
One of Terms and Condition(TnC). This Tnc use game service. More...
const string TermsTvplus
One of Terms and Condition(TnC). This Tnc use tvplus service. More...

Public Static Functions

int GetLoginInfo ( out LoginInfo info )
Get data which current login user More...
int GetLoginStatus ( )
Get whether user login or not. More...
string GetGuid ( )
Get guid of current login user's GUID. More...
string GetLoginUid ( )
Get guid of current login user's UID. More...
int UnsubscribeLoginState ( )
Unsubcribe user's log on or off state. More...

Public Functions

delegate int ShowCallback ( IntPtr userData, int result, int state )
When ShowSso is work correctly, this callback is invoked More...
delegate int RequestAccessTokenCallback ( IntPtr userData, int result, string token )
When RequestAccessToken is work correctly, this callback is invoked. More...
delegate int GetCpAccountMappingListCallback ( IntPtr userData, int result, string tccountInfo )
When GetCpAccountMappingList is work correctly, this callback is invoked. More...
delegate int AddCpAccountMapingInfoCallback ( IntPtr userData, int result )
When AddCpAccountMappingList is work correctly, this callback is invoked. More...
delegate int RemoveCpAccountMappingInfoCallback ( IntPtr userData, int result )
When RemoveCpAccountMappingList is work correctly, this callback is invoked. More...

Public Types

LoginState
Enumerator
OffUser is log off
OnUser is log on

   Type for current user log on or off.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

Result
Enumerator
SuccessWhen API is work correctly, return Success
FailWhen API is work not correctly, return fail

   The type of each API's result whether success or not.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

PageType
Enumerator
LoginThis page have enter id and password.
CreateAccountThis page have creating account. Check the valid email and password.
CreateAccountFacebookThis page have creating account with facebook.
LogoutThis page have showing current login user and click user then would be logout.
EditProfileThis page have editng user's info, birth day and name etc.
RemoveAccountThis page have removing account show ime and if password is correct, it will be removed.
TermsDcaThis page have showing tnc with tnc type.
VdOpionalTermsThis page have showing vd tnc.
DefaultThis page have showing login page.

   Type for SSO each pages

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

Public Attributes

const string TermsOntvTnc

   One of Terms and Condition(TnC). This Tnc use persnal account.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

const string TermsOntvPn

   One of Terms and Condition(TnC). This Tnc use persnal account.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

const string TermsGame

   One of Terms and Condition(TnC). This Tnc use game service.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

const string TermsTvplus

   One of Terms and Condition(TnC). This Tnc use tvplus service.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

Public Static Functions

int GetLoginInfo(out LoginInfo info)

   Get data which current login user

Parameters

info
   The struct is assigned the data

Exceptions

InvalidOperationException
   Thrown when interop's api return null

Privilege Level

platform

Privilege

http://developer.samsung.com/privilege/sso.platform

Returns

The result is 0(success) or -1(fail)

Version

4.4.0

int RunSso( PageType type, string payload, string callerId, ShowCallback callback, IntPtr userData)

   Run SSO application with type.

Parameters

type
   The one of PageType's enum value.
payload
   The extra data use with each page.
callerId
   The application's Id which call this api.
callback
   If SSO application is run success, invoke callback.
userData
   By pass the object through callback.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Privilege Level

platform

Privilege

http://developer.samsung.com/privilege/sso.platform

Returns

The result is 0(success) or -1(fail).

Version

4.4.0

int GetLoginStatus()

   Get whether user login or not.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Returns

If user login in then the value is true. If not the value is false.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

string GetGuid()

   Get guid of current login user's GUID.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Returns

The string of login user's GUID.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

string GetLoginUid()

   Get guid of current login user's UID.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Returns

The string of login user's UID.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int UnsubscribeLoginState()

   Unsubcribe user's log on or off state.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Privilege Level

platform

Privilege

http://developer.samsung.com/privilege/sso.platform

Returns

The result is 0(success) or -1(fail when subscribed callback is not exist).

Version

4.4.0

int SubscribeLoginState( SubscribeLoginStateCallback callback, IntPtr userData)

   Subcribe user's log on or off state.

Parameters

callback
   This callback is invoked, when user log on or off.
userData
   By pass the object through callback.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Privilege Level

platform

Privilege

http://developer.samsung.com/privilege/sso.platform

Returns

The result is 0(success) or -1(fail when subscribe two more times).

Version

4.4.0

int RemoveCpAccountMappingInfo(string appId, string cpName, string uid, RemoveCpAccountMappingInfoCallback callback, IntPtr userData)

   Register new service to server

Parameters

appId
   The requester's Id.
cpName
   The service name
uid
   The login user's UID
callback
   When appId's token is support service, callback is invoked with list.
userData
   By pass the object through callback.

Exceptions

ArgumentNullException
   Thrown when appId, secretKey or uid is null.
InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int AddCpAccountMappingInfo(string appId, string cpName, string uid, AddCpAccountMapingInfoCallback callback, IntPtr userData)

   Register new service to server

Parameters

appId
   The requester's Id.
cpName
   The service name
uid
   The login user's UID
callback
   When appId's token is support service, callback is invoked with list.
userData
   By pass the object through callback.

Exceptions

ArgumentNullException
   Thrown when appId, secretKey or uid is null.
InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int GetCpAccountMappingList(string appId, string cpName, GetCpAccountMappingListCallback callback, IntPtr userData)

   Get user's subscribed service list.

Parameters

appId
   The requester's Id.
cpName
   The service name
callback
   When appId's token is support service, callback is invoked with list.
userData
   By pass the object through callback.

Exceptions

ArgumentNullException
   Thrown when appId or secretKey is null.
InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int GetOspAccessToken(string appId, string secretKey, RequestAccessTokenCallback callback, IntPtr userData)

   Get token by application id and secretKey.

Parameters

appId
   The string which request this api.
secretKey
   The string pair with application.
callback
   When appId's token is support service, callback is invoked with token.
userData
   By pass the object through callback.

Exceptions

ArgumentNullException
   Thrown when appId or secretKey is null
InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int RequestAccessToken(string appId, string secretKey, RequestAccessTokenCallback callback, IntPtr userData)

   Get token by application id and secretKey.

Parameters

appId
   The string which request this api.
secretKey
   The string pair with application.
callback
   When appId's token is support service, callback is invoked with token.
userData
   By pass the object through callback.

Exceptions

ArgumentNullException
   Thrown when appId or secretKey is null
InvalidOperationException
   Thrown when interop's api return null.

Privilege Level

platform

Privilege

http://developer.samsung.com/privilege/sso.platform

Returns

The result is 0(success) or -1(fail).

Version

4.4.0

int ShowCreateAccountView(string callerId, ShowCallback callback)

   Run SSO application to create account page.

Parameters

callerId
   The application's Id which call this api.
callback
   If SSO application is run success, invoke callback.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

int ShowAccountView(string callerId, ShowCallback callback)

   Run SSO application to Login Page.

Parameters

callerId
   The requester's Id.
callback
   If SSO application is run success, invoke callback.

Exceptions

InvalidOperationException
   Thrown when interop's api return null.

Returns

The result is 0(success) or -1(fail).

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

Public Functions

delegate int ShowCallback(IntPtr userData, int result, int state)

   When ShowSso is work correctly, this callback is invoked

Parameters

userData
   The by pass instance, through ShowSso
result
   If SSO application run success, then the result is 1. If not, the value is 0.
state
   The state of popup(not ready, off, on).

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

delegate int RequestAccessTokenCallback(IntPtr userData, int result, string token)

   When RequestAccessToken is work correctly, this callback is invoked.

Parameters

userData
   By pass the object through callback.
result
   If SSO application run success, then the result is 1. If not, the value is 0.
token
   The access token which use when login through another device

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

delegate int GetCpAccountMappingListCallback(IntPtr userData, int result, string tccountInfo)

   When GetCpAccountMappingList is work correctly, this callback is invoked.

Parameters

userData
   By pass the object through callback.
result
   If SSO application run success, then the result is 1. If not, the value is 0.
tccountInfo
   The stringfied json.

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

delegate int AddCpAccountMapingInfoCallback(IntPtr userData, int result)

   When AddCpAccountMappingList is work correctly, this callback is invoked.

Parameters

userData
   By pass the object through callback.
result
   If SSO application run success, then the result is 1. If not, the value is 0.

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

delegate int RemoveCpAccountMappingInfoCallback(IntPtr userData, int result)

   When RemoveCpAccountMappingList is work correctly, this callback is invoked.

Parameters

userData
   By pass the object through callback.
result
   If SSO application run success, then the result is 1. If not, the value is 0.

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0

delegate int SubscribeLoginStateCallback(IntPtr userData, int result, LoginState state, string account, string userIcon)

   When user do log on or off and subscribe callback, then this callback is invoked.

Parameters

userData
   By pass the object through callback.
result
   If SSO application run success, then the result is 1. If not, the value is 0.
state
   If user have been log on, receive ' LoginState.On '. If not, receive ' LoginState.Off '.
account
   The string of user account.
userIcon
   The path of user icon.

Returns

Deprecated but use it for matching so library.

Privilege Level

partner

Privilege

http://developer.samsung.com/privilege/sso.partner

Version

4.4.0