signature
stringlengths
8
3.44k
body
stringlengths
0
1.41M
docstring
stringlengths
1
122k
id
stringlengths
5
17
def CreateChatUsingBlob(self, Blob):
return Chat(self, chop(self._DoCommand('<STR_LIT>' % Blob), <NUM_LIT:2>)[<NUM_LIT:1>])<EOL>
Returns existing or joins a new chat using given blob. :Parameters: Blob : str A blob identifying the chat. :return: A chat object :rtype: `chat.Chat`
f12817:c1:m21
def CreateChatWith(self, *Usernames):
return Chat(self, chop(self._DoCommand('<STR_LIT>' % '<STR_LIT:U+002CU+0020>'.join(Usernames)), <NUM_LIT:2>)[<NUM_LIT:1>])<EOL>
Creates a chat with one or more users. :Parameters: Usernames : str One or more Skypenames of the users. :return: A chat object :rtype: `Chat` :see: `Chat.AddMembers`
f12817:c1:m22
def CreateGroup(self, GroupName):
groups = self.CustomGroups<EOL>self._DoCommand('<STR_LIT>' % tounicode(GroupName))<EOL>for g in self.CustomGroups:<EOL><INDENT>if g not in groups and g.DisplayName == GroupName:<EOL><INDENT>return g<EOL><DEDENT><DEDENT>raise SkypeError(<NUM_LIT:0>, '<STR_LIT>')<EOL>
Creates a custom contact group. :Parameters: GroupName : unicode Group name. :return: A group object. :rtype: `Group` :see: `DeleteGroup`
f12817:c1:m23
def CreateSms(self, MessageType, *TargetNumbers):
return SmsMessage(self, chop(self._DoCommand('<STR_LIT>' % (MessageType, '<STR_LIT:U+002CU+0020>'.join(TargetNumbers))), <NUM_LIT:2>)[<NUM_LIT:1>])<EOL>
Creates an SMS message. :Parameters: MessageType : `enums`.smsMessageType* Message type. TargetNumbers : str One or more target SMS numbers. :return: An sms message object. :rtype: `SmsMessage`
f12817:c1:m24
def DeleteGroup(self, GroupId):
self._DoCommand('<STR_LIT>' % GroupId)<EOL>
Deletes a custom contact group. Users in the contact group are moved to the All Contacts (hardwired) contact group. :Parameters: GroupId : int Group identifier. Get it from `Group.Id`. :see: `CreateGroup`
f12817:c1:m25
def EnableApiSecurityContext(self, Context):
self._Api.enable_security_context(Context)<EOL>
Enables an API security context for Internet Explorer scripts. :Parameters: Context : unicode combination of API security context values. :warning: This functionality isn't supported by Skype4Py.
f12817:c1:m26
def FindChatUsingBlob(self, Blob):
return Chat(self, chop(self._DoCommand('<STR_LIT>' % Blob), <NUM_LIT:2>)[<NUM_LIT:1>])<EOL>
Returns existing chat using given blob. :Parameters: Blob : str A blob identifying the chat. :return: A chat object :rtype: `chat.Chat`
f12817:c1:m27
def Greeting(self, Username='<STR_LIT>'):
for v in self.Voicemails:<EOL><INDENT>if Username and v.PartnerHandle != Username:<EOL><INDENT>continue<EOL><DEDENT>if v.Type in (vmtDefaultGreeting, vmtCustomGreeting):<EOL><INDENT>return v<EOL><DEDENT><DEDENT>
Queries the greeting used as voicemail. :Parameters: Username : str Skypename of the user. :return: A voicemail object. :rtype: `Voicemail`
f12817:c1:m28
def Message(self, Id=<NUM_LIT:0>):
o = ChatMessage(self, Id)<EOL>o.Status <EOL>return o<EOL>
Queries a chat message object. :Parameters: Id : int Message Id. :return: A chat message object. :rtype: `ChatMessage`
f12817:c1:m29
def Messages(self, Target='<STR_LIT>'):
return ChatMessageCollection(self, self._Search('<STR_LIT>', Target))<EOL>
Queries chat messages which were sent/received by the user. :Parameters: Target : str Message sender. :return: Chat message objects. :rtype: `ChatMessageCollection`
f12817:c1:m30
def PlaceCall(self, *Targets):
calls = self.ActiveCalls<EOL>reply = self._DoCommand('<STR_LIT>' % '<STR_LIT:U+002CU+0020>'.join(Targets))<EOL>if reply.startswith('<STR_LIT>'):<EOL><INDENT>return Call(self, chop(reply, <NUM_LIT:2>)[<NUM_LIT:1>])<EOL><DEDENT>for c in self.ActiveCalls:<EOL><INDENT>if c not in calls:<EOL><INDENT>return c<EOL><DEDENT><DEDENT>raise SkypeError(<NUM_LIT:0>, '<STR_LIT>')<EOL>
Places a call to a single user or creates a conference call. :Parameters: Targets : str One or more call targets. If multiple targets are specified, a conference call is created. The call target can be a Skypename, phone number, or speed dial code. :return: A call object. :rtype: `call.Call`
f12817:c1:m31
def Privilege(self, Name):
return (self._Property('<STR_LIT>', '<STR_LIT>', Name.upper()) == '<STR_LIT>')<EOL>
Queries the Skype services (privileges) enabled for the Skype client. :Parameters: Name : str Privilege name, currently one of 'SKYPEOUT', 'SKYPEIN', 'VOICEMAIL'. :return: True if the privilege is available, False otherwise. :rtype: bool
f12817:c1:m32
def Profile(self, Property, Set=None):
return self._Property('<STR_LIT>', '<STR_LIT>', Property, Set)<EOL>
Queries/sets user profile properties. :Parameters: Property : str Property name, currently one of 'PSTN_BALANCE', 'PSTN_BALANCE_CURRENCY', 'FULLNAME', 'BIRTHDAY', 'SEX', 'LANGUAGES', 'COUNTRY', 'PROVINCE', 'CITY', 'PHONE_HOME', 'PHONE_OFFICE', 'PHONE_MOBILE', 'HOMEPAGE', 'ABOUT'. Set : unicode or None Value the property should be set to or None if the value should be queried. :return: Property value if Set=None, None otherwise. :rtype: unicode or None
f12817:c1:m33
def Property(self, ObjectType, ObjectId, PropName, Set=None):
return self._Property(ObjectType, ObjectId, PropName, Set)<EOL>
Queries/sets the properties of an object. :Parameters: ObjectType : str Object type ('USER', 'CALL', 'CHAT', 'CHATMESSAGE', ...). ObjectId : str Object Id, depends on the object type. PropName : str Name of the property to access. Set : unicode or None Value the property should be set to or None if the value should be queried. :return: Property value if Set=None, None otherwise. :rtype: unicode or None
f12817:c1:m34
def ResetCache(self):
self._CacheDict = {}<EOL>
Deletes all command cache entries. This method clears the Skype4Py's internal command cache which means that all objects will forget their property values and querying them will trigger a code to get them from Skype client (and cache them again).
f12817:c1:m35
def SearchForUsers(self, Target):
return UserCollection(self, self._Search('<STR_LIT>', tounicode(Target)))<EOL>
Searches for users. :Parameters: Target : unicode Search target (name or email address). :return: Found users. :rtype: `UserCollection`
f12817:c1:m36
def SendCommand(self, Command):
try:<EOL><INDENT>self._Api.send_command(Command)<EOL><DEDENT>except SkypeAPIError:<EOL><INDENT>self.ResetCache()<EOL>raise<EOL><DEDENT>
Sends an API command. :Parameters: Command : `Command` Command to send. Use `Command` method to create a command.
f12817:c1:m37
def SendMessage(self, Username, Text):
return self.CreateChatWith(Username).SendMessage(Text)<EOL>
Sends a chat message. :Parameters: Username : str Skypename of the user. Text : unicode Body of the message. :return: A chat message object. :rtype: `ChatMessage`
f12817:c1:m38
def SendSms(self, *TargetNumbers, **Properties):
sms = self.CreateSms(smsMessageTypeOutgoing, *TargetNumbers)<EOL>for name, value in Properties.items():<EOL><INDENT>if isinstance(getattr(sms.__class__, name, None), property):<EOL><INDENT>setattr(sms, name, value)<EOL><DEDENT>else:<EOL><INDENT>raise TypeError('<STR_LIT>' % prop)<EOL><DEDENT><DEDENT>sms.Send()<EOL>return sms<EOL>
Creates and sends an SMS message. :Parameters: TargetNumbers : str One or more target SMS numbers. Properties Message properties. Properties available are same as `SmsMessage` object properties. :return: An sms message object. The message is already sent at this point. :rtype: `SmsMessage`
f12817:c1:m39
def SendVoicemail(self, Username):
if self._Api.protocol >= <NUM_LIT:6>:<EOL><INDENT>self._DoCommand('<STR_LIT>' % Username)<EOL><DEDENT>else:<EOL><INDENT>self._DoCommand('<STR_LIT>' % Username)<EOL><DEDENT>
Sends a voicemail to a specified user. :Parameters: Username : str Skypename of the user. :note: Should return a `Voicemail` object. This is not implemented yet.
f12817:c1:m40
def User(self, Username='<STR_LIT>'):
if not Username:<EOL><INDENT>Username = self.CurrentUserHandle<EOL><DEDENT>o = User(self, Username)<EOL>o.OnlineStatus <EOL>return o<EOL>
Queries a user object. :Parameters: Username : str Skypename of the user. :return: A user object. :rtype: `user.User`
f12817:c1:m41
def Variable(self, Name, Set=None):
return self._Property(Name, '<STR_LIT>', '<STR_LIT>', Set)<EOL>
Queries/sets Skype general parameters. :Parameters: Name : str Variable name. Set : unicode or None Value the variable should be set to or None if the value should be queried. :return: Variable value if Set=None, None otherwise. :rtype: unicode or None
f12817:c1:m42
def Voicemail(self, Id):
o = Voicemail(self, Id)<EOL>o.Type <EOL>return o<EOL>
Queries the voicemail object. :Parameters: Id : int Voicemail Id. :return: A voicemail object. :rtype: `Voicemail`
f12817:c1:m43
def ApplicationConnecting(self, App, Users):
This event is triggered when list of users connecting to an application changes. :Parameters: App : `Application` Application object. Users : `UserCollection` Connecting users.
f12817:c2:m0
def ApplicationDatagram(self, App, Stream, Text):
This event is caused by the arrival of an application datagram. :Parameters: App : `Application` Application object. Stream : `ApplicationStream` Application stream that received the datagram. Text : unicode The datagram text.
f12817:c2:m1
def ApplicationReceiving(self, App, Streams):
This event is triggered when list of application receiving streams changes. :Parameters: App : `Application` Application object. Streams : `ApplicationStreamCollection` Application receiving streams.
f12817:c2:m2
def ApplicationSending(self, App, Streams):
This event is triggered when list of application sending streams changes. :Parameters: App : `Application` Application object. Streams : `ApplicationStreamCollection` Application sending streams.
f12817:c2:m3
def ApplicationStreams(self, App, Streams):
This event is triggered when list of application streams changes. :Parameters: App : `Application` Application object. Streams : `ApplicationStreamCollection` Application streams.
f12817:c2:m4
def AsyncSearchUsersFinished(self, Cookie, Users):
This event occurs when an asynchronous search is completed. :Parameters: Cookie : int Search identifier as returned by `Skype.AsyncSearchUsers`. Users : `UserCollection` Found users. :see: `Skype.AsyncSearchUsers`
f12817:c2:m5
def AttachmentStatus(self, Status):
This event is caused by a change in the status of an attachment to the Skype API. :Parameters: Status : `enums`.apiAttach* New attachment status.
f12817:c2:m6
def AutoAway(self, Automatic):
This event is caused by a change of auto away status. :Parameters: Automatic : bool New auto away status.
f12817:c2:m7
def CallDtmfReceived(self, Call, Code):
This event is caused by a call DTMF event. :Parameters: Call : `Call` Call object. Code : str Received DTMF code.
f12817:c2:m8
def CallHistory(self):
This event is caused by a change in call history.
f12817:c2:m9
def CallInputStatusChanged(self, Call, Active):
This event is caused by a change in the Call voice input status change. :Parameters: Call : `Call` Call object. Active : bool New voice input status (active when True).
f12817:c2:m10
def CallSeenStatusChanged(self, Call, Seen):
This event occurs when the seen status of a call changes. :Parameters: Call : `Call` Call object. Seen : bool True if call was seen. :see: `Call.Seen`
f12817:c2:m11
def CallStatus(self, Call, Status):
This event is caused by a change in call status. :Parameters: Call : `Call` Call object. Status : `enums`.cls* New status of the call.
f12817:c2:m12
def CallTransferStatusChanged(self, Call, Status):
This event occurs when a call transfer status changes. :Parameters: Call : `Call` Call object. Status : `enums`.cls* New status of the call transfer.
f12817:c2:m13
def CallVideoReceiveStatusChanged(self, Call, Status):
This event occurs when a call video receive status changes. :Parameters: Call : `Call` Call object. Status : `enums`.vss* New video receive status of the call.
f12817:c2:m14
def CallVideoSendStatusChanged(self, Call, Status):
This event occurs when a call video send status changes. :Parameters: Call : `Call` Call object. Status : `enums`.vss* New video send status of the call.
f12817:c2:m15
def CallVideoStatusChanged(self, Call, Status):
This event occurs when a call video status changes. :Parameters: Call : `Call` Call object. Status : `enums`.cvs* New video status of the call.
f12817:c2:m16
def ChatMemberRoleChanged(self, Member, Role):
This event occurs when a chat member role changes. :Parameters: Member : `ChatMember` Chat member object. Role : `enums`.chatMemberRole* New member role.
f12817:c2:m17
def ChatMembersChanged(self, Chat, Members):
This event occurs when a list of chat members change. :Parameters: Chat : `Chat` Chat object. Members : `UserCollection` Chat members.
f12817:c2:m18
def ChatWindowState(self, Chat, State):
This event occurs when chat window is opened or closed. :Parameters: Chat : `Chat` Chat object. State : bool True if the window was opened or False if closed.
f12817:c2:m19
def ClientWindowState(self, State):
This event occurs when the state of the client window changes. :Parameters: State : `enums`.wnd* New window state.
f12817:c2:m20
def Command(self, command):
This event is triggered when a command is sent to the Skype API. :Parameters: command : `Command` Command object.
f12817:c2:m21
def ConnectionStatus(self, Status):
This event is caused by a connection status change. :Parameters: Status : `enums`.con* New connection status.
f12817:c2:m22
def ContactsFocused(self, Username):
This event is caused by a change in contacts focus. :Parameters: Username : str Name of the user that was focused or empty string if focus was lost.
f12817:c2:m23
def Error(self, command, Number, Description):
This event is triggered when an error occurs during execution of an API command. :Parameters: command : `Command` Command object that caused the error. Number : int Error number returned by the Skype API. Description : unicode Description of the error.
f12817:c2:m24
def FileTransferStatusChanged(self, Transfer, Status):
This event occurs when a file transfer status changes. :Parameters: Transfer : `FileTransfer` File transfer object. Status : `enums`.fileTransferStatus* New status of the file transfer.
f12817:c2:m25
def GroupDeleted(self, GroupId):
This event is caused by a user deleting a custom contact group. :Parameters: GroupId : int Id of the deleted group.
f12817:c2:m26
def GroupExpanded(self, Group, Expanded):
This event is caused by a user expanding or collapsing a group in the contacts tab. :Parameters: Group : `Group` Group object. Expanded : bool Tells if the group is expanded (True) or collapsed (False).
f12817:c2:m27
def GroupUsers(self, Group, Count):
This event is caused by a change in a contact group members. :Parameters: Group : `Group` Group object. Count : int Number of group members. :note: This event is different from its Skype4COM equivalent in that the second parameter is number of users instead of `UserCollection` object. This object may be obtained using ``Group.Users`` property.
f12817:c2:m28
def GroupVisible(self, Group, Visible):
This event is caused by a user hiding/showing a group in the contacts tab. :Parameters: Group : `Group` Group object. Visible : bool Tells if the group is visible or not.
f12817:c2:m29
def MessageHistory(self, Username):
This event is caused by a change in message history. :Parameters: Username : str Name of the user whose message history changed.
f12817:c2:m30
def MessageStatus(self, Message, Status):
This event is caused by a change in chat message status. :Parameters: Message : `ChatMessage` Chat message object. Status : `enums`.cms* New status of the chat message.
f12817:c2:m31
def Mute(self, Mute):
This event is caused by a change in mute status. :Parameters: Mute : bool New mute status.
f12817:c2:m32
def Notify(self, Notification):
This event is triggered whenever Skype client sends a notification. :Parameters: Notification : unicode Notification string. :note: Use this event only if there is no dedicated one.
f12817:c2:m33
def OnlineStatus(self, User, Status):
This event is caused by a change in the online status of a user. :Parameters: User : `User` User object. Status : `enums`.ols* New online status of the user.
f12817:c2:m34
def PluginEventClicked(self, Event):
This event occurs when a user clicks on a plug-in event. :Parameters: Event : `PluginEvent` Plugin event object.
f12817:c2:m35
def PluginMenuItemClicked(self, MenuItem, Users, PluginContext, ContextId):
This event occurs when a user clicks on a plug-in menu item. :Parameters: MenuItem : `PluginMenuItem` Menu item object. Users : `UserCollection` Users this item refers to. PluginContext : unicode Plug-in context. ContextId : str or int Context Id. Chat name for chat context or Call ID for call context. :see: `PluginMenuItem`
f12817:c2:m36
def Reply(self, command):
This event is triggered when the API replies to a command object. :Parameters: command : `Command` Command object.
f12817:c2:m37
def SilentModeStatusChanged(self, Silent):
This event occurs when a silent mode is switched off. :Parameters: Silent : bool Skype client silent status.
f12817:c2:m38
def SmsMessageStatusChanged(self, Message, Status):
This event is caused by a change in the SMS message status. :Parameters: Message : `SmsMessage` SMS message object. Status : `enums`.smsMessageStatus* New status of the SMS message.
f12817:c2:m39
def SmsTargetStatusChanged(self, Target, Status):
This event is caused by a change in the SMS target status. :Parameters: Target : `SmsTarget` SMS target object. Status : `enums`.smsTargetStatus* New status of the SMS target.
f12817:c2:m40
def UserAuthorizationRequestReceived(self, User):
This event occurs when user sends you an authorization request. :Parameters: User : `User` User object.
f12817:c2:m41
def UserMood(self, User, MoodText):
This event is caused by a change in the mood text of the user. :Parameters: User : `User` User object. MoodText : unicode New mood text.
f12817:c2:m42
def UserStatus(self, Status):
This event is caused by a user status change. :Parameters: Status : `enums`.cus* New user status.
f12817:c2:m43
def VoicemailStatus(self, Mail, Status):
This event is caused by a change in voicemail status. :Parameters: Mail : `Voicemail` Voicemail object. Status : `enums`.vms* New status of the voicemail.
f12817:c2:m44
def WallpaperChanged(self, Path):
This event occurs when client wallpaper changes. :Parameters: Path : str Path to new wallpaper bitmap.
f12817:c2:m45
def SaveAvatarToFile(self, Filename, AvatarId=<NUM_LIT:1>):
s = '<STR_LIT>' % (self.Handle, AvatarId, path2unicode(Filename))<EOL>self._Owner._DoCommand('<STR_LIT>' % s, s)<EOL>
Saves user avatar to a file. :Parameters: Filename : str Destination path. AvatarId : int Avatar Id.
f12818:c0:m2
def SetBuddyStatusPendingAuthorization(self, Text=u'<STR_LIT>'):
self._Property('<STR_LIT>', '<STR_LIT>' % (budPendingAuthorization, tounicode(Text)), Cache=False)<EOL>
Sets the BuddyStaus property to `enums.budPendingAuthorization` additionally specifying the authorization text. :Parameters: Text : unicode The authorization text. :see: `BuddyStatus`
f12818:c0:m3
def Accept(self):
self._Alter('<STR_LIT>')<EOL>
Accepts an invitation to join a shared contact group.
f12818:c2:m3
def AddUser(self, Username):
self._Alter('<STR_LIT>', Username)<EOL>
Adds new a user to the group. :Parameters: Username : str Skypename of the new user.
f12818:c2:m4
def Decline(self):
self._Alter('<STR_LIT>')<EOL>
Declines an invitation to join a shared contact group.
f12818:c2:m5
def RemoveUser(self, Username):
self._Alter('<STR_LIT>', Username)<EOL>
Removes a user from the group. :Parameters: Username : str Skypename of the user.
f12818:c2:m6
def Share(self, MessageText='<STR_LIT>'):
self._Alter('<STR_LIT>', MessageText)<EOL>
Shares a contact group. :Parameters: MessageText : unicode Message text for group members.
f12818:c2:m7
def __init__(self, Skype):
self._SkypeRef = weakref.ref(Skype)<EOL>
__init__. :Parameters: Skype : `Skype` Skype
f12819:c0:m0
def Avatar(self, Id=<NUM_LIT:1>, Set=None):
from warnings import warn<EOL>warn('<STR_LIT>', DeprecationWarning, stacklevel=<NUM_LIT:2>)<EOL>if Set is None:<EOL><INDENT>raise TypeError('<STR_LIT>')<EOL><DEDENT>self.LoadAvatarFromFile(Set, Id)<EOL>
Sets user avatar picture from file. :Parameters: Id : int Optional avatar Id. Set : str New avatar file name. :deprecated: Use `LoadAvatarFromFile` instead.
f12819:c0:m1
def LoadAvatarFromFile(self, Filename, AvatarId=<NUM_LIT:1>):
s = '<STR_LIT>' % (AvatarId, path2unicode(Filename))<EOL>self._Skype._DoCommand('<STR_LIT>' % s, s)<EOL>
Loads user avatar picture from file. :Parameters: Filename : str Name of the avatar file. AvatarId : int Optional avatar Id.
f12819:c0:m2
def ResetIdleTimer(self):
self._Skype._DoCommand('<STR_LIT>')<EOL>
Reset Skype idle timer.
f12819:c0:m3
def RingTone(self, Id=<NUM_LIT:1>, Set=None):
if Set is None:<EOL><INDENT>return unicode2path(self._Skype._Property('<STR_LIT>', Id, '<STR_LIT>'))<EOL><DEDENT>self._Skype._Property('<STR_LIT>', Id, '<STR_LIT>', path2unicode(Set))<EOL>
Returns/sets a ringtone. :Parameters: Id : int Ringtone Id Set : str Path to new ringtone or None if the current path should be queried. :return: Current path if Set=None, None otherwise. :rtype: str or None
f12819:c0:m4
def RingToneStatus(self, Id=<NUM_LIT:1>, Set=None):
if Set is None:<EOL><INDENT>return (self._Skype._Property('<STR_LIT>', Id, '<STR_LIT>') == '<STR_LIT>')<EOL><DEDENT>self._Skype._Property('<STR_LIT>', Id, '<STR_LIT>', cndexp(Set, '<STR_LIT>', '<STR_LIT>'))<EOL>
Enables/disables a ringtone. :Parameters: Id : int Ringtone Id Set : bool True/False if the ringtone should be enabled/disabled or None if the current status should be queried. :return: Current status if Set=None, None otherwise. :rtype: bool
f12819:c0:m5
def SaveAvatarToFile(self, Filename, AvatarId=<NUM_LIT:1>):
s = '<STR_LIT>' % (AvatarId, path2unicode(Filename))<EOL>self._Skype._DoCommand('<STR_LIT>' % s, s)<EOL>
Saves user avatar picture to file. :Parameters: Filename : str Destination path. AvatarId : int Avatar Id
f12819:c0:m6
def __init__(self, Skype):
self._Language = '<STR_LIT>'<EOL>self._Module = None<EOL>self._SetLanguage('<STR_LIT>')<EOL>
__init__. :Parameters: Skype : `Skype` Skype object.
f12820:c0:m0
def AttachmentStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns attachment status as text. :Parameters: Status : `enums`.apiAttach* Attachment status. :return: Text describing the attachment status. :rtype: unicode
f12820:c0:m3
def BuddyStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns buddy status as text. :Parameters: Status : `enums`.bud* Buddy status. :return: Text describing the buddy status. :rtype: unicode
f12820:c0:m4
def CallFailureReasonToText(self, Reason):
return self._ToText('<STR_LIT>', Reason)<EOL>
Returns failure reason as text. :Parameters: Reason : `enums`.cfr* Call failure reason. :return: Text describing the call failure reason. :rtype: unicode
f12820:c0:m5
def CallStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns call status as text. :Parameters: Status : `enums`.cls* Call status. :return: Text describing the call status. :rtype: unicode
f12820:c0:m6
def CallTypeToText(self, Type):
return self._ToText('<STR_LIT>', Type)<EOL>
Returns call type as text. :Parameters: Type : `enums`.clt* Call type. :return: Text describing the call type. :rtype: unicode
f12820:c0:m7
def CallVideoSendStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns call video send status as text. :Parameters: Status : `enums`.vss* Call video send status. :return: Text describing the call video send status. :rtype: unicode
f12820:c0:m8
def CallVideoStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns call video status as text. :Parameters: Status : `enums`.cvs* Call video status. :return: Text describing the call video status. :rtype: unicode
f12820:c0:m9
def ChatLeaveReasonToText(self, Reason):
return self._ToText('<STR_LIT>', Reason)<EOL>
Returns leave reason as text. :Parameters: Reason : `enums`.lea* Chat leave reason. :return: Text describing the chat leave reason. :rtype: unicode
f12820:c0:m10
def ChatMessageStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns message status as text. :Parameters: Status : `enums`.cms* Chat message status. :return: Text describing the chat message status. :rtype: unicode
f12820:c0:m11
def ChatMessageTypeToText(self, Type):
return self._ToText('<STR_LIT>', Type)<EOL>
Returns message type as text. :Parameters: Type : `enums`.cme* Chat message type. :return: Text describing the chat message type. :rtype: unicode
f12820:c0:m12
def ChatStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns chatr status as text. :Parameters: Status : `enums`.chs* Chat status. :return: Text describing the chat status. :rtype: unicode
f12820:c0:m13
def ConnectionStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns connection status as text. :Parameters: Status : `enums`.con* Connection status. :return: Text describing the connection status. :rtype: unicode
f12820:c0:m14
def GroupTypeToText(self, Type):
return self._ToText('<STR_LIT>', Type)<EOL>
Returns group type as text. :Parameters: Type : `enums`.grp* Group type. :return: Text describing the group type. :rtype: unicode
f12820:c0:m15
def OnlineStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns online status as text. :Parameters: Status : `enums`.ols* Online status. :return: Text describing the online status. :rtype: unicode
f12820:c0:m16
def SmsMessageStatusToText(self, Status):
return self._ToText('<STR_LIT>', Status)<EOL>
Returns SMS message status as text. :Parameters: Status : `enums`.smsMessageStatus* SMS message status. :return: Text describing the SMS message status. :rtype: unicode
f12820:c0:m17
def SmsMessageTypeToText(self, Type):
return self._ToText('<STR_LIT>', Type)<EOL>
Returns SMS message type as text. :Parameters: Type : `enums`.smsMessageType* SMS message type. :return: Text describing the SMS message type. :rtype: unicode
f12820:c0:m18