| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
skypekit.Cached --+
|
skypekit.Object --+
|
Sms
Wrapper class that includes SMS-specific properties and methods, such as P_BODY and GetTargetPrice. Instantiate SMS instances using Skype::CreateOutgoingSms; post SMS messages to a Conversation using Conversation::PostSMS. Each SMS can have multiple targets (normalized phone numbers). Note that in a Conversation context, every SMS instance has a corresponding Message instance. Once you've posted an SMS, you can retrieve its corresponding Message instance using Sms::GetPropChatmsgId. That Message instance's P_BODY_XML property contains the SMS message data, such as price, target phone number(s), failure codes, and so forth, which you can parsed out and display in the UI. To put it another way, the object chain goes like this: :: Conversation->Message->SMS Note that SkypeKit SDK supports outgoing SMS messages only. SkypeKit clients, even when logged in with accounts that have SkypeIn numbers, cannot receive SMS messages.
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
| Static Methods | |||
|
|||
|
Inherited from |
|||
| Class Variables | |
event_handlers =
|
|
propid2label =
|
|
module_id = 12
|
|
TYPE = OUTGOING |
|
STATUS = COMPOSING |
|
FAILUREREASON = MISC_ERROR |
|
TARGETSTATUS = TARGET_ANALYZING |
|
SETBODYRESULT = BODY_INVALID - body not set. |
|
CONFIRM_TYPE = ID_SMS - Confirm mobile number as SMS sender number |
|
P_TYPE = 190
|
|
P_STATUS = 191
|
|
P_FAILUREREASON = 192
|
|
P_IS_FAILED_UNSEEN = 48
|
|
P_TIMESTAMP = 198
|
|
P_PRICE = 193
|
|
P_PRICE_PRECISION = 49
|
|
P_PRICE_CURRENCY = 194
|
|
P_REPLY_TO_NUMBER = 199
|
|
P_TARGET_NUMBERS = 195
|
|
P_TARGET_STATUSES = 196
|
|
P_BODY = 197
|
|
P_CHATMSG_ID = 840
|
|
|
Inherited from |
|
| Instance Variables | |
|
Inherited from |
| Properties | |
| type | |
| status | |
|
failurereason Set asynchronously and meaningful only after invoking Conversation::PostSMS and detecting Sms::STATUS of SOME_TARGETS_FAILED or FAILED. |
|
|
is_failed_unseen set to 1 when status goes to FAILED. |
|
|
timestamp unix timestamp of message submission |
|
|
price The total price of sending this SMS message (sum of the individual prices to send to each recipient). |
|
|
price_precision The decimal precision of the SMS price values, both individual and total. |
|
|
price_currency should be same as account currency at the time of composing/sending |
|
|
reply_to_number number that should receive the replies |
|
|
target_numbers space-separated normalised pstn numbers |
|
|
target_statuses binary blob. |
|
|
body actual payload |
|
|
chatmsg_id reference to Message |
|
|
Inherited from |
|
| Method Details |
actual constructor
|
str(x)
|
Retrieves the send status of this SMS to a particular recipient (P_TARGET_STATUSES) either prior to or after invoking Conversation::PostSMS. Arguments:
Return values:
|
Retrieves the amount of Skype credit necessary to send the SMS to a particular recipient. Defaults to -1 on instantiation and set only when that recipient's status reflects TARGET_ACCEPTABLE. Use Sms::GetPropPrice to retrieve the total cost of this SMS.
Note that the target price is an integer value. Calculate the actual price (in units specified by P_PRICE_CURRENCY) using P_PRICE_PRECISION as:
::
actualTargetPrice = targetPrice / 10^pricePrecision;
B{Arguments:}
- B{target} - The normalized phone number of the target recipient.
B{Return values:}
- B{price} - The price of sending this SMS message to the target recipient.
|
Sets the recipient(s) of this SMS. Note that each invocation replaces the target list and re-calculates all prices - they are not additive! Arguments:
Return values:
|
-The- method for setting the body text of this SMS. While Conversation::PostSMS does have a body argument, that argument is currently unused. Arguments:
Return values:
|
Retrieves string list of SMS text chunks in first argument, while the second argument contains the number of available characters until creation of the next chunk becomes necessary. Return values:
|
| Class Variable Details |
propid2label
|
TYPE
|
STATUS
|
FAILUREREASON
|
TARGETSTATUS
|
SETBODYRESULT
|
CONFIRM_TYPE
|
| Property Details |
type
|
status
|
failurereasonSet asynchronously and meaningful only after invoking Conversation::PostSMS and detecting Sms::STATUS of SOME_TARGETS_FAILED or FAILED.
|
is_failed_unseenset to 1 when status goes to FAILED. use MarkSeen() to clear
|
timestampunix timestamp of message submission
|
price
The total price of sending this SMS message (sum of the individual prices to send to each recipient). Defaults to -1 on instantiation and incremented by the price for each recipient once that recipient's status reflects TARGET_ACCEPTABLE. Use Sms::GetTargetPrice to retrieve individual target prices.
A value of MAX_UINT indicates that SkypeKit is actively querying and/or updating the value. Note that P_PRICE is an integer value. Calculate the actual price (in units specified by P_PRICE_CURRENCY) using P_PRICE_PRECISION as:
::
actualPrice = price / 10^pricePrecision;
|
price_precisionThe decimal precision of the SMS price values, both individual and total. For example, a value of 2 indicates that you should divide the price (represented as an integer) by 100 (10^2) to obtain the actual price.
|
price_currencyshould be same as account currency at the time of composing/sending
|
reply_to_numbernumber that should receive the replies
|
target_numbersspace-separated normalised pstn numbers
|
target_statusesbinary blob. track with OnPropertyChange(), access with GetTargetStatus(target)
|
bodyactual payload
|
chatmsg_idreference to Message
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Fri Mar 16 16:40:38 2012 | http://epydoc.sourceforge.net |