com.skype
Class SkypeClient

java.lang.Object
  com.skype.SkypeClient

public final class SkypeClient
extends Object

Main view (not model) class of the Skype Java API. Use this class staticly to do view actions (show option dialogs or switch tabs, etc).

Author:

Koji Hisano

See Also:

Skype

Nested Class Summary

static class	SkypeClient.Button Enumeration of keypad keys.
static class	SkypeClient.OptionsPage Enumeration of the OPTIONS page.
static class	SkypeClient.WindowState

Method Summary

static EventMessage	addEventMessage(String caption)
static EventMessage	addEventMessage(String caption, String hint)
static MenuItem	addMenuItem(MenuItem.Context context, String caption, String hint, File iconFile, boolean enabled, String targetSkypeId, boolean multipleContactsEnabled)
static SkypeClient.WindowState	getMainWindowState()
static String	getUILanguageByISOCode()
static File	getWallPaper()
static void	hideSkypeWindow() Remove focus on Skype client window, not any Java window.
static void	openVideoOptionsWindow() Open the Video options window of the Skype client.
static void	openVideoTestWindow() Open the Test video dialog of the Skype client.
static void	pressButton(SkypeClient.Button button) Press a button in the Skype client window.
static void	releaseButton(SkypeClient.Button button) Release a pressed button in the Skype client window.
static void	removeEventMessage(EventMessage eventMessage)
static void	removeMenuItem(MenuItem menuItem)
static void	setMainWindowState(SkypeClient.WindowState newValue)
static boolean	setSilentMode(boolean on) Sets the Skype silent mode.
static void	setUILanguageByISOCode(String newValue)
static void	setWallPaper(File newValue)
static void	showAddFriendWindow() Open the "Add friend" window of Skype client.
static void	showAddFriendWindow(String skypeId) Open the "Add friend" window if skypeId exist.
static void	showBlockedUsersWindow() Show blacked users window of the Skype client.
static void	showCallHistoryTab() Focus the Call history tab of the Skype client.
static void	showChatWindow(String skypeId) Open a chatwindow to another Skype user.
static void	showChatWindow(String skypeId, String message) Open a chatwindow to another skype user and send a message.
static void	showConferenceWindow() Open the conference window of the Skype client.
static void	showContactsTab() Focus the Contacts tab of the Skype client window.
static void	showDialPadTab() Focus dialpad tab on the Skype client window.
static void	showFileTransferWindow(String skypeId) Open File transfer window ten send a file to another Skype user.
static void	showFileTransferWindow(String[] skypeIds) Show the file transfer window to send a file to several other Skype users.
static void	showFileTransferWindow(String[] skypeIds, File folder) Show file transfer window with a specific Folder to send a file to multiple Skype users.
static void	showFileTransferWindow(String skypeId, File folder) Show file transfer windows with a specific folder to send a file to another Skype user.
static void	showGettingStartedWindow() Show the getting started window of the Skype client.
static void	showImportContactsWindow() Show import contacts window of Skype client.
static void	showOptionsWindow(SkypeClient.OptionsPage page) Open the Options window of the Skype Client.
static void	showProfileWindow() Open the Skype client profile window.
static void	showRequestAuthorizationWindow(String skypeId) Show the request authorisation window for a Skype user ID.
static void	showSearchWindow() Open the search window of the Skype Client.
static void	showSendContactsWindow() Open send contacts window.
static void	showSkypeWindow() Put focus on the Skype client window, not any Java window.
static void	showUserInformationWindow(String skypeId) Open the User Information window with the info on a Skype user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

showSkypeWindow

public static void showSkypeWindow()
                            throws SkypeException

Put focus on the Skype client window, not any Java window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

hideSkypeWindow

public static void hideSkypeWindow()
                            throws SkypeException

Remove focus on Skype client window, not any Java window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showAddFriendWindow

public static void showAddFriendWindow()
                                throws SkypeException

Open the "Add friend" window of Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showAddFriendWindow

public static void showAddFriendWindow(String skypeId)
                                throws SkypeException

Open the "Add friend" window if skypeId exist.

Parameters:

skypeId - the Skype ID to check before opening the window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showChatWindow

public static void showChatWindow(String skypeId)
                           throws SkypeException

Open a chatwindow to another Skype user.

Parameters:

skypeId - The user to open a chat with.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showChatWindow

public static void showChatWindow(String skypeId,
                                  String message)
                           throws SkypeException

Open a chatwindow to another skype user and send a message.

Parameters:

skypeId - The other user to chat with.

message - The message to send.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showFileTransferWindow

public static void showFileTransferWindow(String skypeId)
                                   throws SkypeException

Open File transfer window ten send a file to another Skype user.

Parameters:

skypeId - The user to send the file to.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showFileTransferWindow

public static void showFileTransferWindow(String skypeId,
                                          File folder)
                                   throws SkypeException

Show file transfer windows with a specific folder to send a file to another Skype user.

Parameters:

skypeId - the user to send the file to.

folder - the folder to show in the window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showFileTransferWindow

public static void showFileTransferWindow(String[] skypeIds)
                                   throws SkypeException

Show the file transfer window to send a file to several other Skype users.

Parameters:

skypeIds - multiple Skype users to send file to.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showFileTransferWindow

public static void showFileTransferWindow(String[] skypeIds,
                                          File folder)
                                   throws SkypeException

Show file transfer window with a specific Folder to send a file to multiple Skype users.

Parameters:

skypeIds - multiple Skype users to send file to.

folder - the folder to open with the dialog.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showProfileWindow

public static void showProfileWindow()
                              throws SkypeException

Open the Skype client profile window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showUserInformationWindow

public static void showUserInformationWindow(String skypeId)
                                      throws SkypeException

Open the User Information window with the info on a Skype user.

Parameters:

skypeId - The skype user to show.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showConferenceWindow

public static void showConferenceWindow()
                                 throws SkypeException

Open the conference window of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showSearchWindow

public static void showSearchWindow()
                             throws SkypeException

Open the search window of the Skype Client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showOptionsWindow

public static void showOptionsWindow(SkypeClient.OptionsPage page)
                              throws SkypeException

Open the Options window of the Skype Client.

Parameters:

page - the page to ope in front.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

See Also:

SkypeClient.OptionsPage

showCallHistoryTab

public static void showCallHistoryTab()
                               throws SkypeException

Focus the Call history tab of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showContactsTab

public static void showContactsTab()
                            throws SkypeException

Focus the Contacts tab of the Skype client window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showDialPadTab

public static void showDialPadTab()
                           throws SkypeException

Focus dialpad tab on the Skype client window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showSendContactsWindow

public static void showSendContactsWindow()
                                   throws SkypeException

Open send contacts window.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showBlockedUsersWindow

public static void showBlockedUsersWindow()
                                   throws SkypeException

Show blacked users window of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showImportContactsWindow

public static void showImportContactsWindow()
                                     throws SkypeException

Show import contacts window of Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showGettingStartedWindow

public static void showGettingStartedWindow()
                                     throws SkypeException

Show the getting started window of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

showRequestAuthorizationWindow

public static void showRequestAuthorizationWindow(String skypeId)
                                           throws SkypeException

Show the request authorisation window for a Skype user ID.

Parameters:

skypeId - the User to ask authorisation for.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

pressButton

public static void pressButton(SkypeClient.Button button)
                        throws SkypeException

Press a button in the Skype client window.

Parameters:

button - The button to press.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

See Also:

SkypeClient.Button

releaseButton

public static void releaseButton(SkypeClient.Button button)
                          throws SkypeException

Release a pressed button in the Skype client window.

Parameters:

button - the button to release.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

See Also:

SkypeClient.Button

openVideoTestWindow

public static void openVideoTestWindow()
                                throws SkypeException

Open the Test video dialog of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

openVideoOptionsWindow

public static void openVideoOptionsWindow()
                                   throws SkypeException

Open the Video options window of the Skype client.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

getUILanguageByISOCode

public static String getUILanguageByISOCode()
                                     throws SkypeException

Throws:

SkypeException

setUILanguageByISOCode

public static void setUILanguageByISOCode(String newValue)
                                   throws SkypeException

Throws:

SkypeException

getWallPaper

public static File getWallPaper()
                         throws SkypeException

Throws:

SkypeException

setWallPaper

public static void setWallPaper(File newValue)
                         throws SkypeException

Throws:

SkypeException

setSilentMode

public static boolean setSilentMode(boolean on)
                             throws SkypeException

Sets the Skype silent mode.

Parameters:

on - if true turn on the silent mode.

Returns:

true if the user responds ok.

Throws:

SkypeException - when connection has gone bad or ERROR reply.

Since:

2.6.0.84

addEventMessage

public static EventMessage addEventMessage(String caption)
                                    throws SkypeException

Throws:

SkypeException

addEventMessage

public static EventMessage addEventMessage(String caption,
                                           String hint)
                                    throws SkypeException

Throws:

SkypeException

removeEventMessage

public static void removeEventMessage(EventMessage eventMessage)
                               throws SkypeException

Throws:

SkypeException

addMenuItem

public static MenuItem addMenuItem(MenuItem.Context context,
                                   String caption,
                                   String hint,
                                   File iconFile,
                                   boolean enabled,
                                   String targetSkypeId,
                                   boolean multipleContactsEnabled)
                            throws SkypeException

Throws:

SkypeException

removeMenuItem

public static void removeMenuItem(MenuItem menuItem)
                           throws SkypeException

Throws:

SkypeException

setMainWindowState

public static void setMainWindowState(SkypeClient.WindowState newValue)
                               throws SkypeException

Throws:

SkypeException

getMainWindowState

public static SkypeClient.WindowState getMainWindowState()
                                                  throws SkypeException

Throws:

SkypeException