Module Skype :: Class Account

Class Account

source code

     object --+        
              |        
skypekit.Cached --+    
                  |    
    skypekit.Object --+
                      |
                     Account

Represents a local account. Encapsulates methods for Skype account creation, login and logout as well as account profile setting properties. NB! Unlike all the other SkypeKit classes, most of the Account class properties are actually read-write. In fact, there are two sorts of Account's read-write properties: server-side properties and local properties. Different setter methods need to be used for those two kinds.

The subset of server-side properties consists of all the policy properties (everything with _POLICY suffix) that are all of type int and can be set with SetServersideIntProperty method. There is currently only one server-side string property - OFFLINE_CALLFORWARD which can be set with SetServersideStrProperty setter.

The set of writeable account profile properties (local profile) is as follows;

These can be set with SetIntProperty, SetStrProperty and SetBinProperty setter methods. Note that there are special methods for changing account online status (availability) and enabling/disabling auto-login - SetAvailability and SetSavePwd.

Note that to set Account properties, you that Account needs to be logged in. Generally, assumption is that the first thing you do with an Account object after you retrieve it with Skype::GetAccount is login, with exception of creating a new account.

The Account class has no default constructor and creating an Account instance is not the same as creating a Skype account. To create a Skype account:

Instance Methods
 
_sk_init_(self, object_id, transport)
actual constructor
source code
 
__str__(self)
str(x)
source code
 
OnPropertyChange(self, property_name)
notifies from a property change
source code
 
GetStatusWithProgress(self)
No description available.
source code
 
Login(self, set_availability_to='UNKNOWN')
Login an auto-login enabled account (P_STATUS is LOGGED_OUT_AND_PWD_SAVED) and optionally set the availability, for example login in as Contact::DO_NOT_DISTURB.
source code
 
LoginWithPassword(self, password, save_pwd=False, save_data_locally=True)
Login in an account by specifying its password.
source code
 
Register(self, password, save_pwd=False, save_data_locally=True, email='', allow_spam=False)
This command can be used to create a new Skype account, based on the Account object.
source code
 
Logout(self, clear_saved_pwd=False)
Logs out current account.
source code
 
ChangePassword(self, old_password, new_password, save_pwd=False)
Changes this account's password.
source code
 
SetPasswordSaved(self, save_pwd)
save or clear credentials for auto-login whilst already logged in
source code
 
SetServersideIntProperty(self, prop_key, value)
Setter for integer (and enum) server-side properties.
source code
 
SetServersideStrProperty(self, prop_key, value)
Setter for String server-side properties.
source code
 
CancelServerCommit(self)
Cancels an attempt to commit a server-side P_XXX_POLICY or the P_OFFLINE_CALLFORWARD server-side property.
source code
 
SetIntProperty(self, prop_key, value)
Setter for integer properties.
source code
 
SetStrProperty(self, prop_key, value)
Setter for String properties.
source code
 
SetBinProperty(self, prop_key, value)
Setter for BLOB properties, such as its avatar image.
source code
 
SetAvailability(self, availability)
Sets online status of the currently logged in account to one of the values from Contact class AVAILABILITY enumerator.
source code
 
SetStandby(self, standby)
Transitions the availability of this account's associated user, who is assumed to be logged in.
source code
 
GetCapabilityStatus(self, capability)
Returns state of a given account capability.
source code
 
GetSkypenameHash(self)
Response is empty when called with an inactive or invalid account
source code
 
GetVerifiedEmail(self)
returns verified-by-Skype e-mail for this account if exists and verifiable
source code
 
GetVerifiedCompany(self)
returns verified-by-Skype company for this account if exists and verifiable
source code
 
Delete(self)
Deletes all account data stored locally.
source code
 
mget_profile(self)
get multiple properties from self
source code

Inherited from skypekit.Object: multiget

Inherited from skypekit.Cached: __copy__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Static Methods
 
propid(propname)
convert a property name to the enum of the property
source code

Inherited from skypekit.Cached: __new__, sk_exists

Class Variables
  event_handlers = {}
  propid2label = {4: 'skypename', 5: 'fullname', 7: 'birthday', ...
  module_id = 5
  STATUS = {1: 'LOGGED_OUT', 2: 'LOGGED_OUT_AND_PWD_SAVED', 3: '...
LOGGED_OUT
  CBLSYNCSTATUS = {0: 'CBL_INITIALIZING', 1: 'CBL_INITIAL_SYNC_P...
Recognized values for the P_CBLSYNCSTATUS property.
  LOGOUTREASON = {1: 'LOGOUT_CALLED', 2: 'HTTPS_PROXY_AUTH_FAILE...
Recognized values for the Account::P_LOGOUTREASON.
  PWDCHANGESTATUS = {0: 'PWD_OK', 1: 'PWD_CHANGING', 2: 'PWD_INV...
Recognized values for the P_PWDCHANGESTATUS property that provides information on whether a password change succeeded or failed, giving detailed failure reason.
  COMMITSTATUS = {1: 'COMMITTED', 2: 'COMMITTING_TO_SERVER', 3: ...
The list of possible values of Account class COMMITSTATUS property.
  CHATPOLICY = {0: 'EVERYONE_CAN_ADD', 2: 'BUDDIES_OR_AUTHORIZED...
Recognized values for the P_CHAT_POLICY property that controls whether non-authorized users can initiate text chat with the currently logged in account.
  SKYPECALLPOLICY = {0: 'EVERYONE_CAN_CALL', 2: 'BUDDIES_OR_AUTH...
Recognized values for the P_SKYPECALLPOLICY property that controls acceptance of incoming Skype calls.
  PSTNCALLPOLICY = {0: 'ALL_NUMBERS_CAN_CALL', 1: 'DISCLOSED_NUM...
Recognized values for the P_PSTNCALLPOLICY property that controls whether (and from whom) this account accepts incoming PSTN calls.
  AVATARPOLICY = {0: 'BUDDIES_OR_AUTHORIZED_CAN_SEE', 2: 'EVERYO...
Recognized values for the P_AVATAR_POLICY property that controls whether remote contacts can view local account's avatar image.
  BUDDYCOUNTPOLICY = {0: 'DISCLOSE_TO_AUTHORIZED', 1: 'DISCLOSE_...
Recognized values for the P_BUDDYCOUNT_POLICY property that controls whether the number of this user's authorized contacts is visible to other users, either through Account::GetPropNrofAuthedBuddies or Contact::GetPropNrofAuthedBuddies when those instances reference this user.
  TIMEZONEPOLICY = {0: 'TZ_AUTOMATIC', 1: 'TZ_MANUAL', 2: 'TZ_UN...
Recognized values for the P_TIMEZONEPOLICY property that sets the rules for timezone offset so remote clients can determine your local time.
  WEBPRESENCEPOLICY = {0: 'WEBPRESENCE_DISABLED', 1: 'WEBPRESENC...
Recognized values for the P_WEBPRESENCEPOLICY property that controls whether your online status (presence) can be seen using the "Skype buttons" ( http://www.skype.com/share/buttons/ ) embedded in web pages.
  PHONENUMBERSPOLICY = {0: 'PHONENUMBERS_VISIBLE_FOR_BUDDIES', 1...
Recognized values for the P_PHONENUMBERSPOLICY property that controls whether unauthorized remote users can see associated phone numbers in their UI (for reference, see the different phone number tabs in Windows desktop Client contact view).
  VOICEMAILPOLICY = {0: 'VOICEMAIL_ENABLED', 1: 'VOICEMAIL_DISAB...
Recognized values for the P_VOICEMAILPOLICY property that controls acceptance of incoming voicemail messages.
  CAPABILITYSTATUS = {0: 'NO_CAPABILITY', 1: 'CAPABILITY_EXISTS'...
Account capabability statuses are possible values of Contact class CAPABILITY enumerator, when that enumerator is used in context of account.
  P_STATUS = 70
  P_PWDCHANGESTATUS = 71
  P_LOGOUTREASON = 73
  P_COMMITSTATUS = 78
  P_SUGGESTED_SKYPENAME = 72
  P_SKYPEOUT_BALANCE_CURRENCY = 74
  P_SKYPEOUT_BALANCE = 75
  P_SKYPEOUT_PRECISION = 804
  P_SKYPEIN_NUMBERS = 76
  P_CBLSYNCSTATUS = 79
  P_OFFLINE_CALLFORWARD = 77
  P_CHAT_POLICY = 160
  P_SKYPE_CALL_POLICY = 161
  P_PSTN_CALL_POLICY = 162
  P_AVATAR_POLICY = 163
  P_BUDDYCOUNT_POLICY = 164
  P_TIMEZONE_POLICY = 165
  P_WEBPRESENCE_POLICY = 166
  P_PHONENUMBERS_POLICY = 168
  P_VOICEMAIL_POLICY = 169
  P_PARTNER_OPTEDOUT = 773
  P_SERVICE_PROVIDER_INFO = 800
  P_REGISTRATION_TIMESTAMP = 801
  P_NR_OF_OTHER_INSTANCES = 802
  P_SKYPENAME = 4
  P_FULLNAME = 5
  P_BIRTHDAY = 7
  P_GENDER = 8
  P_LANGUAGES = 9
  P_COUNTRY = 10
  P_PROVINCE = 11
  P_CITY = 12
  P_PHONE_HOME = 13
  P_PHONE_OFFICE = 14
  P_PHONE_MOBILE = 15
  P_EMAILS = 16
  P_HOMEPAGE = 17
  P_ABOUT = 18
  P_PROFILE_TIMESTAMP = 19
  P_MOOD_TEXT = 26
  P_TIMEZONE = 27
  P_NROF_AUTHED_BUDDIES = 28
  P_AVAILABILITY = 34
  P_AVATAR_IMAGE = 37
  P_AVATAR_TIMESTAMP = 182
  P_MOOD_TIMESTAMP = 183
  P_RICH_MOOD_TEXT = 205

Inherited from skypekit.Object: rwlock

Instance Variables

Inherited from skypekit.Object: properties

Properties
  status
Account::STATUS
  pwdchangestatus
Account::PWDCHANGESTATUS
  logoutreason
This property should only be examined when Account::P_STATUS is LOGGED_OUT or LOGGED_OUT_AND_PWD_SAVED.
  commitstatus
Account::COMMITSTATUS
  suggested_skypename
suggested skypenames, semi-colon separated.
  skypeout_balance_currency
'EUR', 'USD', etc.
  skypeout_balance
balance in 'cents'
  skypeout_precision
decimal points in ACCOUNT_SKYPEOUT_BALANCE
  skypein_numbers
space-separated list of skypein numbers
  cblsyncstatus
Account::CBLSYNCSTATUS
  offline_callforward
space-separated list of 'begSecond,endSecond,identity' tokens
  chat_policy
Server-side account property, use SetServerside*Property() to set
  skype_call_policy
Server-side account property, use SetServerside*Property() to set
  pstn_call_policy
Server-side account property, use SetServerside*Property() to set
  avatar_policy
Server-side account property, use SetServerside*Property() to set
  buddycount_policy
Server-side account property, use SetServerside*Property() to set
  timezone_policy
Server-side account property, use SetServerside*Property() to set
  webpresence_policy
Server-side account property, use SetServerside*Property() to set
  phonenumbers_policy
Server-side account property, use SetServerside*Property() to set
  voicemail_policy
Server-side account property, use SetServerside*Property() to set
  partner_optedout
Alerts: opted out partner id's, space separated
  service_provider_info
service information if the user is a paid service provider
  registration_timestamp
NB! Unlike your common UNIX timestamps, the registration_timestamp is special, as it counts MINUTES rather than seconds, from Epoch (January 1, 1970)
  nr_of_other_instances
number of times this user is logged in from other computers
  skypename
  fullname
  birthday
YYYYMMDD
  gender
1-male, 2-female
  languages
ISO language codes, space-separated
  country
ISO country code
  province
  city
  phone_home
NB! string not integer
  phone_office
  phone_mobile
  emails
This is a string property, that contains space-separated list of email addresses.
  homepage
  about
arbitrary introductory text
  profile_timestamp
UNIX timestamp of last profile change
  mood_text
Personal mood text (visible to authorised users only).
  timezone
24*3600+diff_to_UTC_in_seconds.
  nrof_authed_buddies
Count of this user's authorized contacts.
  availability
Contact::AVAILABILITY
  avatar_image
Account avatar picture can be set with Account::SetBinProperty method.
  avatar_timestamp
UNIX timestamp of when current avatar was set
  mood_timestamp
UNIX timestamp of when current mood was set
  rich_mood_text
XML version of CONTACT_MOOD_TEXT.

Inherited from object: __class__

Method Details

_sk_init_(self, object_id, transport)

source code 

actual constructor

Overrides: skypekit.Object._sk_init_

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

GetStatusWithProgress(self)

source code 

No description available.

Return values:

  • status - Current value of this account's P_STATUS property
  • progress - This argument returns 0.

Login(self, set_availability_to='UNKNOWN')

source code 

Login an auto-login enabled account (P_STATUS is LOGGED_OUT_AND_PWD_SAVED) and optionally set the availability, for example login in as Contact::DO_NOT_DISTURB. To find out whether there is an auto-login enabled account available, you can use Skype::GetDefaultAccountName to retrieve the skypename of that account. You can then get an Account instance for login by invoking Skype::GetAccount.

If no accounts with stored login credentials are available (GetDefaultAccountName returns an empty string), then you will have to prompt the user for account name and password and then use LoginWithPassword. Account name field in the UI can be pre-populated with strings retrieved with Skype::GetExistingAccounts

Arguments:

  • set_availability_to - force this account's initial online status to the specified Contact::AVAILABILITY value.

LoginWithPassword(self, password, save_pwd=False, save_data_locally=True)

source code 

Login in an account by specifying its password. To retrieve an account instance for login, invoke Skype::GetAccount.

Arguments:

  • password - Password string (plaintext) for this account, which should be pre-validated (Skype::ValidatePassword)
  • save_pwd -
    • true: Saves the password, ensuring that auto-login is enabled.
    • false (default): Does not save the password, and so the user might not be able to effect auto-login until they explicitly invoke Account::SetPasswordSaved(true).
  • save_data_locally - For internal use only.

Register(self, password, save_pwd=False, save_data_locally=True, email='', allow_spam=False)

source code 

This command can be used to create a new Skype account, based on the Account object. When successful, this command will also log in with the newly created account. If the new account registration was not successful, Account status property will change to LOGGED_OUT. A common reason for registration failures is that the an account with that name already exists. In that case, Account LOGOUT_REASON will be set to SKYPENAME_TAKEN. Also, Account SUGGESTED_SKYPENAME property will be set to a list of similar but still available skypenames that could be used instead. The property will contain up to 5 semicolon-separated alternative skypenames. In if no suggested skypenames were available, then this property will contain an empty string. NB! You should pre-validate your P_SKYPENAME value and any email string (Skype::ValidateProfileString) prior to invoking this method.

Arguments:

  • password - Password string (plaintext) for this account, which should be pre-validated (Skype::ValidatePassword)
  • save_pwd -
    • true: Saves the password and enables auto-login.
    • false (default): Does not save the password, and the user needs to be prompted for password on the next login attempt.
  • save_data_locally - For internal use only.
  • email - An email address for retrieving lost passwords and receiving news and information from Skype.
  • allow_spam - enable/disable news and information from Skype being sent to account's e-mail.

Logout(self, clear_saved_pwd=False)

source code 

Logs out current account. Note that calling this on client application exit is optional.

Arguments:

  • clear_saved_pwd -
    • true: Clears any saved password use with auto-login and so disables auto-login until you explicitly invoke Account::SetPasswordSaved(true).
    • false (default): Does not clear any saved password and so does not affect existing auto-login behavior.

ChangePassword(self, old_password, new_password, save_pwd=False)

source code 

Changes this account's password. Returns false if the change failed. NB! You should pre-validate your password strings (Skype::ValidatePassword) and ensure that they are different prior to invoking this method.

Arguments:

  • old_password - "Current password string (plaintext) for this account
  • new_password - New password string (plaintext) for this account
  • save_pwd -
    • true: Saves the new password and enables auto-login.
    • false (default): Clears any existing saved password and so the user cannot effect auto-login until they explicitly invoke Account::SetPasswordSaved(true)

SetPasswordSaved(self, save_pwd)

source code 

save or clear credentials for auto-login whilst already logged in

Arguments:

  • save_pwd

SetServersideIntProperty(self, prop_key, value)

source code 

Setter for integer (and enum) server-side properties. For a list of writeable server-side properties, see the detailed description of the Account class.

Arguments:

  • prop_key
  • value

SetServersideStrProperty(self, prop_key, value)

source code 

Setter for String server-side properties. For a list of writeable server-side properties, see the detailed description of the Account class.

Arguments:

  • prop_key
  • value

CancelServerCommit(self)

source code 

Cancels an attempt to commit a server-side P_XXX_POLICY or the P_OFFLINE_CALLFORWARD server-side property. Invoking this cancellation only makes sense whilst the P_COMMITTSTATUS is in COMMITTING_TO_SERVER state.

SetIntProperty(self, prop_key, value)

source code 

Setter for integer properties. For a list of writeable account profile properties, see the detailed description of the Account class.

Arguments:

  • prop_key
  • value

SetStrProperty(self, prop_key, value)

source code 

Setter for String properties. For a list of writeable account profile properties, see the detailed description of the Account class. NB! You should pre-validate your about and mood message strings (Skype::ValidateProfileString) prior to invoking this method.

Arguments:

  • prop_key
  • value

SetBinProperty(self, prop_key, value)

source code 

Setter for BLOB properties, such as its avatar image. For a list of writeable account profile properties, see the detailed description of the Account class. NB! You should pre-validate your avatar image (Skype::ValidateAvatar) prior to invoking this method.

Arguments:

  • prop_key
  • value

SetAvailability(self, availability)

source code 

Sets online status of the currently logged in account to one of the values from Contact class AVAILABILITY enumerator.

Arguments:

  • availability - only subset of all contact availabilities allowed

SetStandby(self, standby)

source code 

Transitions the availability of this account's associated user, who is assumed to be logged in.

Arguments:

  • standby -
    • true: Saves the user's current availability, then sets it to CONTACT::AVAILABILITY.OFFLINE
    • false: Reconnects the user and restores their previous availability

GetCapabilityStatus(self, capability)

source code 

Returns state of a given account capability. Takes Contact class CAPABILITY property as input argument and returns its state and expiration timestamp where appropriate. For example (C++ wrapper, with other wrappers the syntax may vary but the idea is the same) MyAccount.GetCapabilityStatus(Contact::CAPABILITY_SKYPEOUT, Cap, T); will return Account::CAPABILITY_EXISTS if local account has SkypeOut enabled.

Arguments:

  • capability

Return values:

  • status
  • expiry_timestamp

GetSkypenameHash(self)

source code 

Response is empty when called with an inactive or invalid account

Return values:

  • skypename_hash

GetVerifiedEmail(self)

source code 

returns verified-by-Skype e-mail for this account if exists and verifiable

Return values:

  • email

GetVerifiedCompany(self)

source code 

returns verified-by-Skype company for this account if exists and verifiable

Return values:

  • company

Delete(self)

source code 

Deletes all account data stored locally. Does not remove any account data from the server!


Class Variable Details

propid2label

Value:
{4: 'skypename',
 5: 'fullname',
 7: 'birthday',
 8: 'gender',
 9: 'languages',
 10: 'country',
 11: 'province',
 12: 'city',
...

STATUS

  • LOGGED_OUT
  • LOGGED_OUT_AND_PWD_SAVED - the account is logged out, but password is not needed for re-login
  • CONNECTING_TO_P2P - connecting to P2P network
  • CONNECTING_TO_SERVER - connecting to login server
  • LOGGING_IN - waiting for response from server
  • INITIALIZING - response OK. initialising account-specific lib structures
  • LOGGED_IN - alright, we're good to go!
  • LOGGING_OUT - Logout() has been called but not processed yet
Value:
{1: 'LOGGED_OUT',
 2: 'LOGGED_OUT_AND_PWD_SAVED',
 3: 'CONNECTING_TO_P2P',
 4: 'CONNECTING_TO_SERVER',
 5: 'LOGGING_IN',
 6: 'INITIALIZING',
 7: 'LOGGED_IN',
 8: 'LOGGING_OUT',
...

CBLSYNCSTATUS

Recognized values for the P_CBLSYNCSTATUS property. CBL stands for Central Buddy List. In principle, this property and its states can be ignored by most UI developers. However, it can help to optimize UI buildup and behaviour, particularly in case of limited resources (such as mobile devices).

CBL is used to backup your contact list, contact groups, and profile information, and also used to synchronize this information with other Skype instances of your account (i.e. on another device). CBL sync can occur both during login and during normal operation. Note that CBL synchronization does not take place immediately after an Account property is changed. A delay between the first property change and CBL sync initiation enables the client to accumulate changes and do the synchronization in bulk.

Clients with limited resources might want to wait for CBL_IN_SYNC status before generating their UI's contact list representation. Otherwise it might be forced to redraw the contact list multiple times, as new updates get retrieved from the server-side. Similarly, applications that modify an account's mood message might want to know when the P_MOOD_TEXT or P_RICH_MOOD_TEXT property is synchronized to the server. Note that this sync is only for CBL and other logged in instances of the same account - other contacts will receive the mood message update directly.

  • CBL_INITIALIZING - status is not clear (yet)
  • CBL_INITIAL_SYNC_PENDING - first sync with empty profile
  • CBL_SYNC_PENDING - Account properties are considered to be out of sync with CBL - attempt at synchronization is imminent. You might wish to wait with updating UI components that display the data that is about to change anyway.
  • CBL_SYNC_IN_PROGRESS - CBL synchronization is currently taking place.
  • CBL_IN_SYNC - Account properties are up-to-date.
  • CBL_SYNC_FAILED - CBL sync has. Another attempt will be made after several minutes. If a second attempt also fails, subsequent attempts at synchronization will be made at ever increasing intervals.
  • CBL_REMOTE_SYNC_PENDING - we have received a hint that there is a remote data change in CBL
Value:
{0: 'CBL_INITIALIZING',
 1: 'CBL_INITIAL_SYNC_PENDING',
 2: 'CBL_SYNC_PENDING',
 3: 'CBL_SYNC_IN_PROGRESS',
 4: 'CBL_IN_SYNC',
 5: 'CBL_SYNC_FAILED',
 6: 'CBL_REMOTE_SYNC_PENDING',
 'CBL_INITIALIZING': 0,
...

LOGOUTREASON

Recognized values for the Account::P_LOGOUTREASON. Note that this property should only be examined when Account::P_STATUS is LOGGED_OUT or LOGGED_OUT_AND_PWD_SAVED. That is, you should not monitor changes to this property in Account::OnChange callback, other than after already having checked that P_STATUS property has appropriate value. The reason for this is that the LOGOUTREASON does not get reset before the next login attempt. For example: if a user tried to log in with a wrong password, the LOGOUTREASON gets set to INCORRECT_PASSWORD. Now, if the user tries to log in again, and yet again submits an incorrect password, the value of the LOGOUTREASON does not change anymore, because it already is set to INCORRECT_PASSWORD. Consequently, Account::OnChange will not fire in this case.

  • LOGOUT_CALLED - manual logout (or unknown reason from previous session)
  • HTTPS_PROXY_AUTH_FAILED - sync errors at login/registration
  • SOCKS_PROXY_AUTH_FAILED - sync errors at login/registration
  • P2P_CONNECT_FAILED - sync errors at login/registration
  • SERVER_CONNECT_FAILED - sync errors at login/registration
  • SERVER_OVERLOADED - sync errors at login/registration
  • DB_IN_USE - sync errors at login/registration
  • INVALID_SKYPENAME - sync errors at registration
  • INVALID_EMAIL - sync errors at registration
  • UNACCEPTABLE_PASSWORD - sync errors at registration
  • SKYPENAME_TAKEN - sync errors at registration
  • REJECTED_AS_UNDERAGE - sync errors at registration
  • NO_SUCH_IDENTITY - sync errors at login
  • INCORRECT_PASSWORD - sync errors at login
  • TOO_MANY_LOGIN_ATTEMPTS - sync errors at login
  • PASSWORD_HAS_CHANGED - async errors (can happen anytime while logged in)
  • PERIODIC_UIC_UPDATE_FAILED - async errors (can happen anytime while logged in)
  • DB_DISK_FULL - async errors (can happen anytime while logged in)
  • DB_IO_ERROR - async errors (can happen anytime while logged in)
  • DB_CORRUPT - async errors (can happen anytime while logged in)
  • DB_FAILURE - deprecated (superceded by more detailed DB_* errors)
  • INVALID_APP_ID - platform sdk
  • APP_ID_FAILURE - platform sdk
  • UNSUPPORTED_VERSION - forced upgrade/discontinuation
Value:
{1: 'LOGOUT_CALLED',
 2: 'HTTPS_PROXY_AUTH_FAILED',
 3: 'SOCKS_PROXY_AUTH_FAILED',
 4: 'P2P_CONNECT_FAILED',
 5: 'SERVER_CONNECT_FAILED',
 6: 'SERVER_OVERLOADED',
 7: 'DB_IN_USE',
 8: 'INVALID_SKYPENAME',
...

PWDCHANGESTATUS

Recognized values for the P_PWDCHANGESTATUS property that provides information on whether a password change succeeded or failed, giving detailed failure reason. After successful return from the Change Password method, clients should monitor the P_PWDCHANGESTATUS property changes.

  • PWD_CHANGING - consider displaying an "in progress" indicator and continue polling
  • PWD_OK - consider displaying an updated indicator and stop polling
  • PWD_OK_BUT_CHANGE_SUGGESTED - consider displaying an updated indicator, along with a recommendation to change again to a stronger password.
  • PWD_OK - Password change succeeded.
  • PWD_CHANGING - Password change is in progress.
  • PWD_INVALID_OLD_PASSWORD - Old password was incorrect.
  • PWD_SERVER_CONNECT_FAILED - Failed to verify password because of no connection to server.
  • PWD_OK_BUT_CHANGE_SUGGESTED - Password was set but server didn't like it much.
  • PWD_MUST_DIFFER_FROM_OLD - New password was exactly the same as old one.
  • PWD_INVALID_NEW_PWD - The new password was unacceptable. (too short, too simple, etc.)
  • PWD_MUST_LOG_IN_TO_CHANGE - Account was currently not logged in.
Value:
{0: 'PWD_OK',
 1: 'PWD_CHANGING',
 2: 'PWD_INVALID_OLD_PASSWORD',
 3: 'PWD_SERVER_CONNECT_FAILED',
 4: 'PWD_OK_BUT_CHANGE_SUGGESTED',
 5: 'PWD_MUST_DIFFER_FROM_OLD',
 6: 'PWD_INVALID_NEW_PWD',
 7: 'PWD_MUST_LOG_IN_TO_CHANGE',
...

COMMITSTATUS

The list of possible values of Account class COMMITSTATUS property. Note that this property and its values have nothing to do with (automatic) CBL synchronization. Rather, the COMMITSTATUS reflects commit status to account's server side properties initiated with calls to Account class SetServersideIntProperty and Account class SetServersideStrProperty methods. After those methods, your client UI may want to wait until the COMMITSTATUS becomes COMMITTING_TO_SERVER followed by COMMITTED and inform the user if the value becomes COMMIT_FAILED. SetServerside<type>Property methods are used for writing privacy policy related and call forwarding related Account properties to the server. Unlike CBL synchronization, those updates are executed immediately.

  • COMMITTED - No pending updates to the server.
  • COMMITTING_TO_SERVER - Update to the server in progress.
  • COMMIT_FAILED - Server update has failed.
Value:
{1: 'COMMITTED',
 2: 'COMMITTING_TO_SERVER',
 3: 'COMMIT_FAILED',
 'COMMITTED': 1,
 'COMMITTING_TO_SERVER': 2,
 'COMMIT_FAILED': 3}

CHATPOLICY

Recognized values for the P_CHAT_POLICY property that controls whether non-authorized users can initiate text chat with the currently logged in account. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntProperty

  • EVERYONE_CAN_ADD - Unauthorized contacts can initiate text chat.
  • BUDDIES_OR_AUTHORIZED_CAN_ADD - Only authorized contacts can initiate chat (default policy).
Value:
{0: 'EVERYONE_CAN_ADD',
 2: 'BUDDIES_OR_AUTHORIZED_CAN_ADD',
 'BUDDIES_OR_AUTHORIZED_CAN_ADD': 2,
 'EVERYONE_CAN_ADD': 0}

SKYPECALLPOLICY

Recognized values for the P_SKYPECALLPOLICY property that controls acceptance of incoming Skype calls. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntPropertyserver-side.

  • EVERYONE_CAN_CALL - Skype calls accepted from unauthorized contacts.
  • BUDDIES_OR_AUTHORIZED_CAN_CALL - Skype calls not accepted from unauthorized contacts.
Value:
{0: 'EVERYONE_CAN_CALL',
 2: 'BUDDIES_OR_AUTHORIZED_CAN_CALL',
 'BUDDIES_OR_AUTHORIZED_CAN_CALL': 2,
 'EVERYONE_CAN_CALL': 0}

PSTNCALLPOLICY

Recognized values for the P_PSTNCALLPOLICY property that controls whether (and from whom) this account accepts incoming PSTN calls. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntProperty

  • ALL_NUMBERS_CAN_CALL - All incoming PSTN calls are accepted.
  • DISCLOSED_NUMBERS_CAN_CALL - Only PSTN calls that report caller ID are accepted.
  • BUDDY_NUMBERS_CAN_CALL - Only calls from PSTN numbers found in local contact list are accepted.
Value:
{0: 'ALL_NUMBERS_CAN_CALL',
 1: 'DISCLOSED_NUMBERS_CAN_CALL',
 2: 'BUDDY_NUMBERS_CAN_CALL',
 'ALL_NUMBERS_CAN_CALL': 0,
 'BUDDY_NUMBERS_CAN_CALL': 2,
 'DISCLOSED_NUMBERS_CAN_CALL': 1}

AVATARPOLICY

Recognized values for the P_AVATAR_POLICY property that controls whether remote contacts can view local account's avatar image. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntPropertyserver-side. Note that setting account's AVATAR_POLICY to BUDDIES_OR_AUTHORIZED_CAN_SEE does not guarantee that remote users will be able to immediately retrieve the avatar picture via corresponding Contact object. Avatar changes propagate between clients only when direct sessions between clients are established. Direct sessions are established during live sessions or whilst online contacts are engaged in chat.

  • BUDDIES_OR_AUTHORIZED_CAN_SEE - Only authorized remote users can see this user's avatar image
  • EVERYONE_CAN_SEE - Everyone can see this user's avatar image, once the contact/account avatar property has been synchronized during a direct session. The avatar image may also become viewable on some Skype Web-based services.
Value:
{0: 'BUDDIES_OR_AUTHORIZED_CAN_SEE',
 2: 'EVERYONE_CAN_SEE',
 'BUDDIES_OR_AUTHORIZED_CAN_SEE': 0,
 'EVERYONE_CAN_SEE': 2}

BUDDYCOUNTPOLICY

Recognized values for the P_BUDDYCOUNT_POLICY property that controls whether the number of this user's authorized contacts is visible to other users, either through Account::GetPropNrofAuthedBuddies or Contact::GetPropNrofAuthedBuddies when those instances reference this user. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntProperty, like this: account->SetServersideIntProperty(Account::P_BUDDYCOUNT_POLICY, Account::DISCLOSE_TO_AUTHORIZED); account->SetServersideIntProperty(Account::P_BUDDYCOUNT_POLICY, Account::DISCLOSE_TO_NOONE );

  • DISCLOSE_TO_AUTHORIZED - Authorized remote users can retrieve the number of this user's authorized contacts (Contact::P_NROF_AUTHED_BUDDIES)
  • DISCLOSE_TO_NOONE - No remote user - regardless their authorization status - can retrieve the number of this user's authorized contacts. Account::GetPropNrofAuthedBuddies and Contact::GetPropNrofAuthedBuddies will always return 0
Value:
{0: 'DISCLOSE_TO_AUTHORIZED',
 1: 'DISCLOSE_TO_NOONE',
 'DISCLOSE_TO_AUTHORIZED': 0,
 'DISCLOSE_TO_NOONE': 1}

TIMEZONEPOLICY

Recognized values for the P_TIMEZONEPOLICY property that sets the rules for timezone offset so remote clients can determine your local time. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntPropertyserver-side.

  • TZ_AUTOMATIC - Account's timezone setting is determined automatically.
  • TZ_MANUAL - Account's timezone setting is set manually.
  • TZ_UNDISCLOSED - Remote users will have no idea what your local time is.
Value:
{0: 'TZ_AUTOMATIC',
 1: 'TZ_MANUAL',
 2: 'TZ_UNDISCLOSED',
 'TZ_AUTOMATIC': 0,
 'TZ_MANUAL': 1,
 'TZ_UNDISCLOSED': 2}

WEBPRESENCEPOLICY

Recognized values for the P_WEBPRESENCEPOLICY property that controls whether your online status (presence) can be seen using the "Skype buttons" ( http://www.skype.com/share/buttons/ ) embedded in web pages. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntPropertyserver-side.

  • WEBPRESENCE_DISABLED - Disable displaying online status on web for this account.
  • WEBPRESENCE_ENABLED - Enable displaying online status on web for this account.
Value:
{0: 'WEBPRESENCE_DISABLED',
 1: 'WEBPRESENCE_ENABLED',
 'WEBPRESENCE_DISABLED': 0,
 'WEBPRESENCE_ENABLED': 1}

PHONENUMBERSPOLICY

Recognized values for the P_PHONENUMBERSPOLICY property that controls whether unauthorized remote users can see associated phone numbers in their UI (for reference, see the different phone number tabs in Windows desktop Client contact view). Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntProperty

  • PHONENUMBERS_VISIBLE_FOR_BUDDIES - Only authorized contacts can see the phone numbers.
  • PHONENUMBERS_VISIBLE_FOR_EVERYONE - Everyone can see the phone numbers.
Value:
{0: 'PHONENUMBERS_VISIBLE_FOR_BUDDIES',
 1: 'PHONENUMBERS_VISIBLE_FOR_EVERYONE',
 'PHONENUMBERS_VISIBLE_FOR_BUDDIES': 0,
 'PHONENUMBERS_VISIBLE_FOR_EVERYONE': 1}

VOICEMAILPOLICY

Recognized values for the P_VOICEMAILPOLICY property that controls acceptance of incoming voicemail messages. Note that since this set of values is associated with a server-side property, you must set that property using Account::SetServersideIntPropertyserver-side.

  • VOICEMAIL_ENABLED - Incoming voicemails enabled.
  • VOICEMAIL_DISABLED - Incoming voicemails disabled.
Value:
{0: 'VOICEMAIL_ENABLED',
 1: 'VOICEMAIL_DISABLED',
 'VOICEMAIL_DISABLED': 1,
 'VOICEMAIL_ENABLED': 0}

CAPABILITYSTATUS

Account capabability statuses are possible values of Contact class CAPABILITY enumerator, when that enumerator is used in context of account. Compared to Contact class CAPABILITYSTATUS enums, Account class CAPABILITYSTATUS has additional items for subscription expiration warnings.

  • NO_CAPABILITY - Capability is not supported by the currently logged in SkypeKit client.
  • CAPABILITY_EXISTS - Capability is supported by the currently logged in SkypeKit client.
  • FIRST_EXPIRY_WARNING - Support for this capability ends this month (within 30 days)
  • SECOND_EXPIRY_WARNING - Support for this capability ends this week (within 7 days)
  • FINAL_EXPIRY_WARNING - Support for this capability ends today
Value:
{0: 'NO_CAPABILITY',
 1: 'CAPABILITY_EXISTS',
 2: 'FIRST_EXPIRY_WARNING',
 3: 'SECOND_EXPIRY_WARNING',
 4: 'FINAL_EXPIRY_WARNING',
 'CAPABILITY_EXISTS': 1,
 'FINAL_EXPIRY_WARNING': 4,
 'FIRST_EXPIRY_WARNING': 2,
...

Property Details

status

Account::STATUS

Get Method:
_sk_get_status(self) - Account::STATUS

pwdchangestatus

Account::PWDCHANGESTATUS

Get Method:
_sk_get_pwdchangestatus(self) - Account::PWDCHANGESTATUS

logoutreason

This property should only be examined when Account::P_STATUS is LOGGED_OUT or LOGGED_OUT_AND_PWD_SAVED. That is, you should not monitor changes to this property in Account::OnChange callback, other than after already having checked that P_STATUS property has appropriate value. The reason for this is that the LOGOUTREASON does not get reset before the next login attempt. For example: if a user tried to log in with a wrong password, the LOGOUTREASON gets set to INCORRECT_PASSWORD. Now, if the user tries to log in again, and yet again submits an incorrect password, the value of the LOGOUTREASON does not change anymore, because it already is set to INCORRECT_PASSWORD. Consequently, Account::OnChange will not fire in this case.

Get Method:
_sk_get_logoutreason(self) - This property should only be examined when Account::P_STATUS is LOGGED_OUT or LOGGED_OUT_AND_PWD_SAVED.

commitstatus

Account::COMMITSTATUS

Get Method:
_sk_get_commitstatus(self) - Account::COMMITSTATUS

suggested_skypename

suggested skypenames, semi-colon separated. present if logoutreason==SKYPENAME_TAKEN

Get Method:
_sk_get_suggested_skypename(self) - suggested skypenames, semi-colon separated.

skypeout_balance_currency

'EUR', 'USD', etc.

Get Method:
_sk_get_skypeout_balance_currency(self) - 'EUR', 'USD', etc.

skypeout_balance

balance in 'cents'

Get Method:
_sk_get_skypeout_balance(self) - balance in 'cents'

skypeout_precision

decimal points in ACCOUNT_SKYPEOUT_BALANCE

Get Method:
_sk_get_skypeout_precision(self) - decimal points in ACCOUNT_SKYPEOUT_BALANCE

skypein_numbers

space-separated list of skypein numbers

Get Method:
_sk_get_skypein_numbers(self) - space-separated list of skypein numbers

cblsyncstatus

Account::CBLSYNCSTATUS

Get Method:
_sk_get_cblsyncstatus(self) - Account::CBLSYNCSTATUS

offline_callforward

space-separated list of 'begSecond,endSecond,identity' tokens

Get Method:
_sk_get_offline_callforward(self) - space-separated list of 'begSecond,endSecond,identity' tokens

chat_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_chat_policy(self) - Server-side account property, use SetServerside*Property() to set

skype_call_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_skype_call_policy(self) - Server-side account property, use SetServerside*Property() to set

pstn_call_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_pstn_call_policy(self) - Server-side account property, use SetServerside*Property() to set

avatar_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_avatar_policy(self) - Server-side account property, use SetServerside*Property() to set

buddycount_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_buddycount_policy(self) - Server-side account property, use SetServerside*Property() to set

timezone_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_timezone_policy(self) - Server-side account property, use SetServerside*Property() to set

webpresence_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_webpresence_policy(self) - Server-side account property, use SetServerside*Property() to set

phonenumbers_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_phonenumbers_policy(self) - Server-side account property, use SetServerside*Property() to set

voicemail_policy

Server-side account property, use SetServerside*Property() to set

Get Method:
_sk_get_voicemail_policy(self) - Server-side account property, use SetServerside*Property() to set

partner_optedout

Alerts: opted out partner id's, space separated

Get Method:
_sk_get_partner_optedout(self) - Alerts: opted out partner id's, space separated

service_provider_info

service information if the user is a paid service provider

Get Method:
_sk_get_service_provider_info(self) - service information if the user is a paid service provider

registration_timestamp

NB! Unlike your common UNIX timestamps, the registration_timestamp is special, as it counts MINUTES rather than seconds, from Epoch (January 1, 1970)

Get Method:
_sk_get_registration_timestamp(self) - NB! Unlike your common UNIX timestamps, the registration_timestamp is special, as it counts MINUTES rather than seconds, from Epoch (January 1, 1970)

nr_of_other_instances

number of times this user is logged in from other computers

Get Method:
_sk_get_nr_of_other_instances(self) - number of times this user is logged in from other computers

skypename

Get Method:
_sk_get_skypename(self)

fullname

Get Method:
_sk_get_fullname(self)

birthday

YYYYMMDD

Get Method:
_sk_get_birthday(self) - YYYYMMDD

gender

1-male, 2-female

Get Method:
_sk_get_gender(self) - 1-male, 2-female

languages

ISO language codes, space-separated

Get Method:
_sk_get_languages(self) - ISO language codes, space-separated

country

ISO country code

Get Method:
_sk_get_country(self) - ISO country code

province

Get Method:
_sk_get_province(self)

city

Get Method:
_sk_get_city(self)

phone_home

NB! string not integer

Get Method:
_sk_get_phone_home(self) - NB! string not integer

phone_office

Get Method:
_sk_get_phone_office(self)

phone_mobile

Get Method:
_sk_get_phone_mobile(self)

emails

This is a string property, that contains space-separated list of email addresses. When surfacing this property in your UI, you will need to take into account that there may be more than one email addresses in this property (i.e. split the value at spaces and display them as list). Similarly, when modifying this property with SetStrProperty method, your editor should allow editing of component email addresses separately and add them all up again, before submitting back to the account.

Get Method:
_sk_get_emails(self) - This is a string property, that contains space-separated list of email addresses.

homepage

Get Method:
_sk_get_homepage(self)

about

arbitrary introductory text

Get Method:
_sk_get_about(self) - arbitrary introductory text

profile_timestamp

UNIX timestamp of last profile change

Get Method:
_sk_get_profile_timestamp(self) - UNIX timestamp of last profile change

mood_text

Personal mood text (visible to authorised users only). Max length 300 bytes.

Get Method:
_sk_get_mood_text(self) - Personal mood text (visible to authorised users only).

timezone

24*3600+diff_to_UTC_in_seconds. nb! changes with DST

Get Method:
_sk_get_timezone(self) - 24*3600+diff_to_UTC_in_seconds.

nrof_authed_buddies

Count of this user's authorized contacts.

Get Method:
_sk_get_nrof_authed_buddies(self) - Count of this user's authorized contacts.

availability

Contact::AVAILABILITY

Get Method:
_sk_get_availability(self) - Contact::AVAILABILITY

avatar_image

Account avatar picture can be set with Account::SetBinProperty method. The contact avatar picture is limited to max 96x96 pixels and 32000 bytes. If the submitted avatar picture exceeds either of these size limits, it is the responsibility of your client to scale the image down to appropriate size.

The avatar pictures have to be in JPG format. A SkypeKit client can enable the user to set the Account avatar in other picture formats, in which case the picture should be converted to JPG before submitting it.

In any case, the avatar picture should be pre-validated with the Skype::ValidateAvatar method.

Get Method:
_sk_get_avatar_image(self) - Account avatar picture can be set with Account::SetBinProperty method.

avatar_timestamp

UNIX timestamp of when current avatar was set

Get Method:
_sk_get_avatar_timestamp(self) - UNIX timestamp of when current avatar was set

mood_timestamp

UNIX timestamp of when current mood was set

Get Method:
_sk_get_mood_timestamp(self) - UNIX timestamp of when current mood was set

rich_mood_text

XML version of CONTACT_MOOD_TEXT. Max length 1000 bytes.

Get Method:
_sk_get_rich_mood_text(self) - XML version of CONTACT_MOOD_TEXT.