Package Skype4Py :: Module enums
[frames] | no frames]

Source Code for Module Skype4Py.enums

  1  ''' 
  2  Skype4Py constants. 
  3   
  4    1. Usage. 
  5   
  6      All constants are available at the C{Skype4Py} package level. Example:: 
  7   
  8          import Skype4Py 
  9   
 10          status = Skype4Py.apiAttachUnknown 
 11  ''' 
 12   
 13   
 14  #{ Attachment status 
 15  apiAttachUnknown = -1 
 16  apiAttachSuccess = 0 
 17  apiAttachPendingAuthorization = 1 
 18  apiAttachRefused = 2 
 19  apiAttachNotAvailable = 3 
 20  apiAttachAvailable = 0x8001 
 21   
 22   
 23  #{ Connection status 
 24  conUnknown = 'UNKNOWN' 
 25  conOffline = 'OFFLINE' 
 26  conConnecting = 'CONNECTING' 
 27  conPausing = 'PAUSING' 
 28  conOnline = 'ONLINE' 
 29   
 30   
 31  #{ User status 
 32  cusUnknown = 'UNKNOWN' 
 33  cusOffline = 'OFFLINE' 
 34  cusOnline = 'ONLINE' 
 35  cusAway = 'AWAY' 
 36  cusNotAvailable = 'NA' 
 37  cusDoNotDisturb = 'DND' 
 38  cusInvisible = 'INVISIBLE' 
 39  cusLoggedOut = 'LOGGEDOUT' 
 40  cusSkypeMe = 'SKYPEME' 
 41   
 42   
 43  #{ Call failure reason 
 44  cfrUnknown = -1 
 45  cfrMiscError = 1 
 46  cfrUserDoesNotExist = 2 
 47  cfrUserIsOffline = 3 
 48  cfrNoProxyFound = 4 
 49  cfrSessionTerminated = 5 
 50  cfrNoCommonCodec = 6 
 51  cfrSoundIOError = 7 
 52  cfrRemoteDeviceError = 8 
 53  cfrBlockedByRecipient = 9 
 54  cfrRecipientNotFriend = 10 
 55  cfrNotAuthorizedByRecipient = 11 
 56  cfrSoundRecordingError = 12 
 57   
 58   
 59  #{ Call status 
 60  clsUnknown = 'NOT_AVAILABLE' 
 61  clsUnplaced = 'UNPLACED' 
 62  clsRouting = 'ROUTING' 
 63  clsEarlyMedia = 'EARLYMEDIA' 
 64  clsFailed = 'FAILED' 
 65  clsRinging = 'RINGING' 
 66  clsInProgress = 'INPROGRESS' 
 67  clsOnHold = 'ONHOLD' 
 68  clsFinished = 'FINISHED' 
 69  clsMissed = 'MISSED' 
 70  clsRefused = 'REFUSED' 
 71  clsBusy = 'BUSY' 
 72  clsCancelled = 'CANCELLED' 
 73  clsLocalHold = 'REDIAL_PENDING' 
 74  clsRemoteHold = 'WAITING_REDIAL_COMMAND' 
 75  clsVoicemailBufferingGreeting = 'VM_BUFFERING_GREETING' 
 76  clsVoicemailPlayingGreeting = 'VM_PLAYING_GREETING' 
 77  clsVoicemailRecording = 'VM_RECORDING' 
 78  clsVoicemailUploading = 'VM_UPLOADING' 
 79  clsVoicemailSent = 'VM_SENT' 
 80  clsVoicemailCancelled = 'VM_CANCELLED' 
 81  clsVoicemailFailed = 'VM_FAILED' 
 82  clsTransferring = 'TRANSFERRING' 
 83  clsTransferred = 'TRANSFERRED' 
 84   
 85   
 86  #{ Call type 
 87  cltUnknown = 'UNKNOWN' 
 88  cltIncomingPSTN = 'INCOMING_PSTN' 
 89  cltOutgoingPSTN = 'OUTGOING_PSTN' 
 90  cltIncomingP2P = 'INCOMING_P2P' 
 91  cltOutgoingP2P = 'OUTGOING_P2P' 
 92   
 93   
 94  #{ Call history 
 95  chsAllCalls = 'ALL' 
 96  chsMissedCalls = 'MISSED' 
 97  chsIncomingCalls = 'INCOMING' 
 98  chsOutgoingCalls = 'OUTGOING' 
 99   
100   
101  #{ Call video status 
102  cvsUnknown = 'UNKNOWN' 
103  cvsNone = 'VIDEO_NONE' 
104  cvsSendEnabled = 'VIDEO_SEND_ENABLED' 
105  cvsReceiveEnabled = 'VIDEO_RECV_ENABLED' 
106  cvsBothEnabled = 'VIDEO_BOTH_ENABLED' 
107   
108   
109  #{ Call video send status 
110  vssUnknown = 'UNKNOWN' 
111  vssNotAvailable = 'NOT_AVAILABLE' 
112  vssAvailable = 'AVAILABLE' 
113  vssStarting = 'STARTING' 
114  vssRejected = 'REJECTED' 
115  vssRunning = 'RUNNING' 
116  vssStopping = 'STOPPING' 
117  vssPaused = 'PAUSED' 
118   
119   
120  #{ Call IO device type 
121  callIoDeviceTypeUnknown = 'UNKNOWN' 
122  callIoDeviceTypeSoundcard = 'SOUNDCARD' 
123  callIoDeviceTypePort = 'PORT' 
124  callIoDeviceTypeFile = 'FILE' 
125   
126   
127  #{ Chat message type 
128  cmeUnknown = 'UNKNOWN' 
129  cmeCreatedChatWith = 'CREATEDCHATWITH' 
130  cmeSawMembers = 'SAWMEMBERS' 
131  cmeAddedMembers = 'ADDEDMEMBERS' 
132  cmeSetTopic = 'SETTOPIC' 
133  cmeSaid = 'SAID' 
134  cmeLeft = 'LEFT' 
135  cmeEmoted = 'EMOTED' 
136  cmePostedContacts = 'POSTEDCONTACTS' 
137  cmeGapInChat = 'GAP_IN_CHAT' 
138  cmeSetRole = 'SETROLE' 
139  cmeKicked = 'KICKED' 
140  cmeKickBanned = 'KICKBANNED' 
141  cmeSetOptions = 'SETOPTIONS' 
142  cmeSetPicture = 'SETPICTURE' 
143  cmeSetGuidelines = 'SETGUIDELINES' 
144  cmeJoinedAsApplicant = 'JOINEDASAPPLICANT' 
145   
146   
147  #{ Chat message status 
148  cmsUnknown = 'UNKNOWN' 
149  cmsSending = 'SENDING' 
150  cmsSent = 'SENT' 
151  cmsReceived = 'RECEIVED' 
152  cmsRead = 'READ' 
153   
154   
155  #{ User sex 
156  usexUnknown = 'UNKNOWN' 
157  usexMale = 'MALE' 
158  usexFemale = 'FEMALE' 
159   
160   
161  #{ Buddy status 
162  budUnknown = -1 
163  budNeverBeenFriend = 0 
164  budDeletedFriend = 1 
165  budPendingAuthorization = 2 
166  budFriend = 3 
167   
168   
169  #{ Online status 
170  olsUnknown = 'UNKNOWN' 
171  olsOffline = 'OFFLINE' 
172  olsOnline = 'ONLINE' 
173  olsAway = 'AWAY' 
174  olsNotAvailable = 'NA' 
175  olsDoNotDisturb = 'DND' 
176  olsInvisible = 'INVISIBLE' 
177  olsSkypeOut = 'SKYPEOUT' 
178  olsSkypeMe = 'SKYPEME' 
179   
180   
181  #{ Chat leave reason 
182  leaUnknown = '' 
183  leaUserNotFound = 'USER_NOT_FOUND' 
184  leaUserIncapable = 'USER_INCAPABLE' 
185  leaAdderNotFriend = 'ADDER_MUST_BE_FRIEND' 
186  leaAddedNotAuthorized = 'ADDED_MUST_BE_AUTHORIZED' 
187  leaAddDeclined = 'ADD_DECLINED' 
188  leaUnsubscribe = 'UNSUBSCRIBE' 
189   
190   
191  #{ Chat status 
192  chsUnknown = 'UNKNOWN' 
193  chsLegacyDialog = 'LEGACY_DIALOG' 
194  chsDialog = 'DIALOG' 
195  chsMultiNeedAccept = 'MULTI_NEED_ACCEPT' 
196  chsMultiSubscribed = 'MULTI_SUBSCRIBED' 
197  chsUnsubscribed = 'UNSUBSCRIBED' 
198   
199   
200  #{ Voicemail type 
201  vmtUnknown = 'UNKNOWN' 
202  vmtIncoming = 'INCOMING' 
203  vmtDefaultGreeting = 'DEFAULT_GREETING' 
204  vmtCustomGreeting = 'CUSTOM_GREETING' 
205  vmtOutgoing = 'OUTGOING' 
206   
207   
208  #{ Voicemail status 
209  vmsUnknown = 'UNKNOWN' 
210  vmsNotDownloaded = 'NOTDOWNLOADED' 
211  vmsDownloading = 'DOWNLOADING' 
212  vmsUnplayed = 'UNPLAYED' 
213  vmsBuffering = 'BUFFERING' 
214  vmsPlaying = 'PLAYING' 
215  vmsPlayed = 'PLAYED' 
216  vmsBlank = 'BLANK' 
217  vmsRecording = 'RECORDING' 
218  vmsRecorded = 'RECORDED' 
219  vmsUploading = 'UPLOADING' 
220  vmsUploaded = 'UPLOADED' 
221  vmsDeleting = 'DELETING' 
222  vmsFailed = 'FAILED' 
223   
224   
225  #{ Voicemail failure reason 
226  vmrUnknown = 'UNKNOWN' 
227  vmrNoError = 'NOERROR' 
228  vmrMiscError = 'MISC_ERROR' 
229  vmrConnectError = 'CONNECT_ERROR' 
230  vmrNoPrivilege = 'NO_VOICEMAIL_PRIVILEGE' 
231  vmrNoVoicemail = 'NO_SUCH_VOICEMAIL' 
232  vmrFileReadError = 'FILE_READ_ERROR' 
233  vmrFileWriteError = 'FILE_WRITE_ERROR' 
234  vmrRecordingError = 'RECORDING_ERROR' 
235  vmrPlaybackError = 'PLAYBACK_ERROR' 
236   
237   
238  #{ Group type 
239  grpUnknown = 'UNKNOWN' 
240  grpCustomGroup = 'CUSTOM_GROUP' 
241  grpAllUsers = 'ALL_USERS' 
242  grpAllFriends = 'ALL_FRIENDS' 
243  grpSkypeFriends = 'SKYPE_FRIENDS' 
244  grpSkypeOutFriends = 'SKYPEOUT_FRIENDS' 
245  grpOnlineFriends = 'ONLINE_FRIENDS' 
246  grpPendingAuthorizationFriends = 'UNKNOWN_OR_PENDINGAUTH_FRIENDS' 
247  grpRecentlyContactedUsers = 'RECENTLY_CONTACTED_USERS' 
248  grpUsersWaitingMyAuthorization = 'USERS_WAITING_MY_AUTHORIZATION' 
249  grpUsersAuthorizedByMe = 'USERS_AUTHORIZED_BY_ME' 
250  grpUsersBlockedByMe = 'USERS_BLOCKED_BY_ME' 
251  grpUngroupedFriends = 'UNGROUPED_FRIENDS' 
252  grpSharedGroup = 'SHARED_GROUP' 
253  grpProposedSharedGroup = 'PROPOSED_SHARED_GROUP' 
254   
255   
256  #{ Call channel type 
257  cctUnknown = 'UNKNOWN' 
258  cctDatagram = 'DATAGRAM' 
259  cctReliable = 'RELIABLE' 
260   
261   
262  #{ API security context 
263  apiContextUnknown = 0 
264  apiContextVoice = 1 
265  apiContextMessaging = 2 
266  apiContextAccount = 4 
267  apiContextContacts = 8 
268   
269   
270  #{ SMS message type 
271  smsMessageTypeUnknown = 'UNKNOWN' 
272  smsMessageTypeIncoming = 'INCOMING' 
273  smsMessageTypeOutgoing = 'OUTGOING' 
274  smsMessageTypeCCRequest = 'CONFIRMATION_CODE_REQUEST' 
275  smsMessageTypeCCSubmit = 'CONFRIMATION_CODE_SUBMIT' 
276   
277   
278  #{ SMS message status 
279  smsMessageStatusUnknown = 'UNKNOWN' 
280  smsMessageStatusReceived = 'RECEIVED' 
281  smsMessageStatusRead = 'READ' 
282  smsMessageStatusComposing = 'COMPOSING' 
283  smsMessageStatusSendingToServer = 'SENDING_TO_SERVER' 
284  smsMessageStatusSentToServer = 'SENT_TO_SERVER' 
285  smsMessageStatusDelivered = 'DELIVERED' 
286  smsMessageStatusSomeTargetsFailed = 'SOME_TARGETS_FAILED' 
287  smsMessageStatusFailed = 'FAILED' 
288   
289   
290  #{ SMS failure reason 
291  smsFailureReasonUnknown = 'UNKNOWN' 
292  smsFailureReasonMiscError = 'MISC_ERROR' 
293  smsFailureReasonServerConnectFailed = 'SERVER_CONNECT_FAILED' 
294  smsFailureReasonNoSmsCapability = 'NO_SMS_CAPABILITY' 
295  smsFailureReasonInsufficientFunds = 'INSUFFICIENT_FUNDS' 
296  smsFailureReasonInvalidConfirmationCode = 'INVALID_CONFIRMATION_CODE' 
297  smsFailureReasonUserBlocked = 'USER_BLOCKED' 
298  smsFailureReasonIPBlocked = 'IP_BLOCKED' 
299  smsFailureReasonNodeBlocked = 'NODE_BLOCKED' 
300  smsFailureReasonNoSenderIdCapability = 'NO_SENDERID_CAPABILITY' 
301   
302   
303  #{ SMS target status 
304  smsTargetStatusUnknown = 'UNKNOWN' 
305  smsTargetStatusUndefined = 'TARGET_UNDEFINED' 
306  smsTargetStatusAnalyzing = 'TARGET_ANALYZING' 
307  smsTargetStatusAcceptable = 'TARGET_ACCEPTABLE' 
308  smsTargetStatusNotRoutable = 'TARGET_NOT_ROUTABLE' 
309  smsTargetStatusDeliveryPending = 'TARGET_DELIVERY_PENDING' 
310  smsTargetStatusDeliverySuccessful = 'TARGET_DELIVERY_SUCCESSFUL' 
311  smsTargetStatusDeliveryFailed = 'TARGET_DELIVERY_FAILED' 
312   
313   
314  #{ Plug-in context 
315  pluginContextUnknown = 'unknown' 
316  pluginContextChat = 'chat' 
317  pluginContextCall = 'call' 
318  pluginContextContact = 'contact' 
319  pluginContextMyself = 'myself' 
320  pluginContextTools = 'tools' 
321   
322   
323  #{ Plug-in contact type 
324  pluginContactTypeUnknown = 'unknown' 
325  pluginContactTypeAll = 'all' 
326  pluginContactTypeSkype = 'skype' 
327  pluginContactTypeSkypeOut = 'skypeout' 
328   
329   
330  #{ File transfer type 
331  fileTransferTypeIncoming = 'INCOMING' 
332  fileTransferTypeOutgoing = 'OUTGOING' 
333   
334   
335  #{ File transfer status 
336  fileTransferStatusNew = 'NEW' 
337  fileTransferStatusConnecting = 'CONNECTING' 
338  fileTransferStatusWaitingForAccept = 'WAITING_FOR_ACCEPT' 
339  fileTransferStatusTransferring = 'TRANSFERRING' 
340  fileTransferStatusTransferringOverRelay = 'TRANSFERRING_OVER_RELAY' 
341  fileTransferStatusPaused = 'PAUSED' 
342  fileTransferStatusRemotelyPaused = 'REMOTELY_PAUSED' 
343  fileTransferStatusCancelled = 'CANCELLED' 
344  fileTransferStatusCompleted = 'COMPLETED' 
345  fileTransferStatusFailed = 'FAILED' 
346   
347   
348  #{ File transfer failure reason 
349  fileTransferFailureReasonSenderNotAuthorized = 'SENDER_NOT_AUTHORIZED' 
350  fileTransferFailureReasonRemotelyCancelled = 'REMOTELY_CANCELLED' 
351  fileTransferFailureReasonFailedRead = 'FAILED_READ' 
352  fileTransferFailureReasonFailedRemoteRead = 'FAILED_REMOTE_READ' 
353  fileTransferFailureReasonFailedWrite = 'FAILED_WRITE' 
354  fileTransferFailureReasonFailedRemoteWrite = 'FAILED_REMOTE_WRITE' 
355  fileTransferFailureReasonRemoteDoesNotSupportFT = 'REMOTE_DOES_NOT_SUPPORT_FT' 
356  fileTransferFailureReasonRemoteOfflineTooLong = 'REMOTE_OFFLINE_TOO_LONG' 
357   
358   
359  #{ Chat member role 
360  chatMemberRoleUnknown = 'UNKNOWN' 
361  chatMemberRoleCreator = 'CREATOR' 
362  chatMemberRoleMaster = 'MASTER' 
363  chatMemberRoleHelper = 'HELPER' 
364  chatMemberRoleUser = 'USER' 
365  chatMemberRoleListener = 'LISTENER' 
366  chatMemberRoleApplicant = 'APPLICANT' 
367   
368   
369  #{ My chat status 
370  chatStatusUnknown = 'UNKNOWN' 
371  chatStatusConnecting = 'CONNECTING' 
372  chatStatusWaitingRemoteAccept = 'WAITING_REMOTE_ACCEPT' 
373  chatStatusAcceptRequired = 'ACCEPT_REQUIRED' 
374  chatStatusPasswordRequired = 'PASSWORD_REQUIRED' 
375  chatStatusSubscribed = 'SUBSCRIBED' 
376  chatStatusUnsubscribed = 'UNSUBSCRIBED' 
377  chatStatusDisbanded = 'CHAT_DISBANDED' 
378  chatStatusQueuedBecauseChatIsFull = 'QUEUED_BECAUSE_CHAT_IS_FULL' 
379  chatStatusApplicationDenied = 'APPLICATION_DENIED' 
380  chatStatusKicked = 'KICKED' 
381  chatStatusBanned = 'BANNED' 
382  chatStatusRetryConnecting = 'RETRY_CONNECTING' 
383   
384   
385  #{ Chat options 
386  chatOptionJoiningEnabled = 1 
387  chatOptionJoinersBecomeApplicants = 2 
388  chatOptionJoinersBecomeListeners = 4 
389  chatOptionHistoryDisclosed = 8 
390  chatOptionUsersAreListeners = 16 
391  chatOptionTopicAndPictureLockedForUsers = 32 
392   
393   
394  #{ Chat type 
395  chatTypeUnknown = 'UNKNOWN' 
396  chatTypeDialog = 'DIALOG' 
397  chatTypeLegacyDialog = 'LEGACY_DIALOG' 
398  chatTypeLegacyUnsubscribed = 'LEGACY_UNSUBSCRIBED' 
399  chatTypeMultiChat = 'MULTICHAT' 
400  chatTypeSharedGroup = 'SHAREDGROUP' 
401   
402  #{ Window state 
403  wndUnknown = 'UNKNOWN' 
404  wndNormal = 'NORMAL' 
405  wndMinimized = 'MINIMIZED' 
406  wndMaximized = 'MAXIMIZED' 
407  wndHidden = 'HIDDEN' 
408