Source Code for Module Skype4Py.enums

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