| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
skypekit.Cached --+
|
skypekit.Object --+
|
Contact
Address book entry. Encapsulates methods like GetType, GetIdentity, GetAvatar, SendAuthRequest, OpenConversation etc. Single contact can have additional phone numbers attached to it (ASSIGNED_PHONE1 .. ASSIGNED_PHONE3). Note that in the context of a conversation, Contacts are represented by Participant objects. Contact member functions all return a Boolean indicating the success (true) or failure (false) of processing the request itself (transport, runtime availability, and so forth)?not the success or failure of its associated functionality. For example, Contact::IsMemberOf returns true if it was able to make a determination, and its result parameter reflects whether this Contact is a member of the target group. Similarly, Contact::IsMemberOf returns false if it was unable to make a determination, and the value of its result parameter is undefined.
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
| Static Methods | |||
|
|||
|
Inherited from |
|||
| Class Variables | |
event_handlers =
|
|
propid2label =
|
|
module_id = 2
|
|
TYPE = Same as with CAPABILITY, enumerator is used by both Contact and Account objects. |
|
AUTHLEVEL = Describes the recognized relational states between a local account and a remote contact. |
|
AVAILABILITY = Describes the superset list of possible Account and Contact online statuses. |
|
EXTRA_AUTHREQ_FIELDS = SEND_VERIFIED_EMAIL - send verified e-mail blob with this auth request |
|
CAPABILITY = This enumerator is used by both Contact and Account objects. |
|
CAPABILITYSTATUS = List of possible states of each of the Contact class CAPABILITY items. |
|
P_TYPE = 202
|
|
P_SKYPENAME = 4
|
|
P_PSTNNUMBER = 6
|
|
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_AVATAR_IMAGE = 37
|
|
P_MOOD_TEXT = 26
|
|
P_RICH_MOOD_TEXT = 205
|
|
P_TIMEZONE = 27
|
|
P_CAPABILITIES = 36
|
|
P_PROFILE_TIMESTAMP = 19
|
|
P_NROF_AUTHED_BUDDIES = 28
|
|
P_IPCOUNTRY = 29
|
|
P_AVATAR_TIMESTAMP = 182
|
|
P_MOOD_TIMESTAMP = 183
|
|
P_RECEIVED_AUTHREQUEST = 20
|
|
P_AUTHREQ_TIMESTAMP = 25
|
|
P_LASTONLINE_TIMESTAMP = 35
|
|
P_AVAILABILITY = 34
|
|
P_DISPLAYNAME = 21
|
|
P_REFRESHING = 22
|
|
P_GIVEN_AUTHLEVEL = 23
|
|
P_GIVEN_DISPLAYNAME = 33
|
|
P_ASSIGNED_COMMENT = 180
|
|
P_LASTUSED_TIMESTAMP = 39
|
|
P_AUTHREQUEST_COUNT = 41
|
|
P_ASSIGNED_PHONE1 = 184
|
|
P_ASSIGNED_PHONE1_LABEL = 185
|
|
P_ASSIGNED_PHONE2 = 186
|
|
P_ASSIGNED_PHONE2_LABEL = 187
|
|
P_ASSIGNED_PHONE3 = 188
|
|
P_ASSIGNED_PHONE3_LABEL = 189
|
|
P_POPULARITY_ORD = 42
|
|
|
Inherited from |
|
| Instance Variables | |
|
Inherited from |
| Properties | |
| type | |
|
skypename defined if it is a SKYPE contact |
|
| pstnnumber | |
| fullname | |
|
birthday integer of YYYYMMDD format |
|
|
gender 1-male, 2-female |
|
|
languages ISO language code list, space separated |
|
|
country ISO country code |
|
| province | |
| city | |
|
phone_home This corresponds to the Account::P_PHONE_HOME property. |
|
|
phone_office This corresponds to the Account::P_PHONE_OFFICE property. |
|
|
phone_mobile This corresponds to the Account::P_PHONE_MOBILE property. |
|
|
emails will be hashed before advertising/querying, space separated |
|
| homepage | |
|
about arbitrary introductory text |
|
|
avatar_image Contact avatar pictures are in JPG format. |
|
|
mood_text Personal mood message (visible to authorized users only). |
|
|
rich_mood_text XML version of personal mood text |
|
|
timezone 24*3600+diff_to_UTC_in_seconds. |
|
|
capabilities binary tag that can be queried via Contact::HasCapability() |
|
|
profile_timestamp UNIX timestamp of last profile change |
|
|
nrof_authed_buddies count of this user's authorized contacts |
|
|
ipcountry ISO country code assigned by the IP |
|
|
avatar_timestamp UNIX timestamp of when current avatar was set |
|
|
mood_timestamp UNIX timestamp of when current mood was set |
|
|
received_authrequest set if the contact is waiting to be authorized. |
|
|
authreq_timestamp timestamp of last received auth-request |
|
|
lastonline_timestamp X timestamp of last successful ping to that user |
|
|
availability Contact::AVAILABILITY |
|
|
displayname always set (assigned by lib by looking at various fields) |
|
|
refreshing true if querying additional information from p2p or server |
|
|
given_authlevel Contact::AUTHLEVEL, change via Contact::GiveAuthlevel() |
|
|
given_displayname change via Contact::GiveDisplayname() |
|
|
assigned_comment change via Contact::AssignComment() |
|
|
lastused_timestamp UNIX timestamp of last outbound session (call, chat, FT, etc) |
|
|
authrequest_count for contacts that have CONTACT_RECEIVED_AUTHREQUEST, how many times in a row they have requested it without positive answer |
|
|
assigned_phone1 Office phone no. |
|
|
assigned_phone1_label Value "1" in this property will be translated as "Office" by Skype Windows desktop client, according to UI language settings |
|
|
assigned_phone2 Mobile phone no. |
|
|
assigned_phone2_label Value "2" in this property will be translated as "Mobile" by Skype Windows desktop client, according to UI language settings |
|
|
assigned_phone3 "Other phone no. |
|
|
assigned_phone3_label Value "3" in this property will be translated as "Other" by Skype Windows desktop client, according to UI language settings |
|
|
popularity_ord Contact's order by presence popularity |
|
|
Inherited from |
|
| Method Details |
actual constructor
|
str(x)
|
Getter method for the TYPE property. Return values:
|
No description available. Return values:
|
Returns Conrtact's avatar image (JPG). Return values:
|
returns verified-by-Skype e-mail for this contact if exists and verifiable Return values: |
returns verified-by-Skype company for this contact if exists and verifiable Return values:
|
Checks whether the contact is member of a contact group given in group reference argument. Arguments:
Return values:
|
Checks whether the contact is member of a pre-defined contact group given in the TYPE argument (type for this property comes from the ContactGroup class). Arguments:
Return values:
|
Blocks or unblocks any further incoming communication attempts from this contact. Arguments:
|
sets CONTACT_GIVEN_DISPLAYNAME. clears if size(name)==0 Arguments:
|
Adds or removes this Contact from the ALL_BUDDIES hardwired group. Arguments:
|
Sends a contact authorization request to this user. Arguments:
|
the contact has accepted my auth request Return values:
|
Sets the three P_ASSIGNED_PHONEx and P_ASSIGNED_PHONEx_LABEL properties, where x reflects the value of num. The Skype Windows desktop client uses the following conventions when interpreting and assigning values to these properties. While your solution can assign arbitrary values to these properties, we strongly recommend using these conventions to ensure interoperability with the Skype Windows desktop client. Keep in mind that the "number" of these property pairs has no relationship to how the Skype Windows client interprets their label property value strings. For example, the Skype Windows client will interpret P_ASSIGNED_PHONE3_LABEL as "Home" if its value is the string "0". Label strings: Populate the label properties with string representations of the numbers "0" through "3", rather than descriptive strings like "Home", "Mobile", and so forth. The Skype desktop clients interpret the numeric string values as:
|
Retrieves a dialog conversation with the Contact. Return values:
|
Retrieves a Contact::Capability value. Sets P_REFRESHING to true while querying from server. This method is functionally the same as Contact::GetCapabilityStatus except that it returns a bool value rather than Contact::CAPABILITYSTATUS Arguments:
|
Retrieves a Contact::Capability value. Sets P_REFRESHING to true while querying from server. Arguments:
|
| Class Variable Details |
propid2label
|
TYPESame as with CAPABILITY, enumerator is used by both Contact and Account objects.
|
AUTHLEVELDescribes the recognized relational states between a local account and a remote contact.
|
AVAILABILITYDescribes the superset list of possible Account and Contact online statuses. In case of Account they apply to local user, in case of Contact they apply to remote contacts.
|
EXTRA_AUTHREQ_FIELDS
|
CAPABILITYThis enumerator is used by both Contact and Account objects. Thus the items here can have slightly different meaning, depending on which context you will examine their values. In case of Contact, the values apply to a user - across all the instances that user has logged in with Skype. In case of Account, the capability is that of a local, currently logged in instance of Skype client. The values that CAPABILITY items can have are also dependant on class context. In context of Contact, a capability can be CAPABILITY_MIXED. Which in case of CAPABILITY_VIDEO, for example, would mean that the remote use has logged in with different clients, some of which support video calls and some of which don't. In context of Account - there are no mixed result. Currently logged in Skype instance either supports video or it doesn't.
|
CAPABILITYSTATUSList of possible states of each of the Contact class CAPABILITY items.
|
| Property Details |
type
|
skypenamedefined if it is a SKYPE contact
|
pstnnumber
|
fullname
|
birthdayinteger of YYYYMMDD format
|
gender1-male, 2-female
|
languagesISO language code list, space separated
|
countryISO country code
|
province
|
city
|
phone_homeThis corresponds to the Account::P_PHONE_HOME property. The value is set by the remote user in Account profile. As Contact property, this is read-only.
|
phone_officeThis corresponds to the Account::P_PHONE_OFFICE property. The value is set by the remote user in Account profile. As Contact property, this is read-only. If the Contact has not populated his Account profile with sufficient phone numbers, the UI should implement locally adding additional phone numbers to Contact P_ASSIGNED_PHONE1 .. P_ASSIGNED_PHONE3 properties (and corresponding labels). See Contact::SetPhoneNumber method for more information.
|
phone_mobileThis corresponds to the Account::P_PHONE_MOBILE property. The value is set by the remote user in Account profile. As Contact property, this is read-only.
|
emailswill be hashed before advertising/querying, space separated
|
homepage
|
aboutarbitrary introductory text
|
avatar_imageContact avatar pictures are in JPG format. The original size of avatar pictures are in no more than 96 x 96 pixels in size. However, as they can be smaller, scaling the pictures up too much to fit your UI can lead to distorted images.
|
mood_textPersonal mood message (visible to authorized users only).
|
rich_mood_textXML version of personal mood text
|
timezone24*3600+diff_to_UTC_in_seconds. NB! changes with DST
|
capabilitiesbinary tag that can be queried via Contact::HasCapability()
|
profile_timestampUNIX timestamp of last profile change
|
nrof_authed_buddiescount of this user's authorized contacts
|
ipcountryISO country code assigned by the IP
|
avatar_timestampUNIX timestamp of when current avatar was set
|
mood_timestampUNIX timestamp of when current mood was set
|
received_authrequestset if the contact is waiting to be authorized. The value contains auth. request text
|
authreq_timestamptimestamp of last received auth-request
|
lastonline_timestampX timestamp of last successful ping to that user
|
availabilityContact::AVAILABILITY
|
displaynamealways set (assigned by lib by looking at various fields)
|
refreshingtrue if querying additional information from p2p or server
|
given_authlevelContact::AUTHLEVEL, change via Contact::GiveAuthlevel()
|
given_displaynamechange via Contact::GiveDisplayname()
|
assigned_commentchange via Contact::AssignComment()
|
lastused_timestampUNIX timestamp of last outbound session (call, chat, FT, etc)
|
authrequest_countfor contacts that have CONTACT_RECEIVED_AUTHREQUEST, how many times in a row they have requested it without positive answer
|
assigned_phone1Office phone no. of the contact. This property should NOT be used for SkypeOut contacts
|
assigned_phone1_labelValue "1" in this property will be translated as "Office" by Skype Windows desktop client, according to UI language settings
|
assigned_phone2Mobile phone no. of the contact
|
assigned_phone2_labelValue "2" in this property will be translated as "Mobile" by Skype Windows desktop client, according to UI language settings
|
assigned_phone3"Other phone no. of the contact
|
assigned_phone3_labelValue "3" in this property will be translated as "Other" by Skype Windows desktop client, according to UI language settings
|
popularity_ordContact's order by presence popularity
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Fri Mar 16 16:40:37 2012 | http://epydoc.sourceforge.net |