com.browserstack.appautomate

Class AppAutomateClient

java.lang.Object

com.browserstack.client.BrowserStackClient

com.browserstack.appautomate.AppAutomateClient

All Implemented Interfaces:

AppAutomate, BrowserStackClientInterface

public class AppAutomateClient
extends BrowserStackClient
implements AppAutomate

Nested Class Summary

Nested classes/interfaces inherited from class com.browserstack.client.BrowserStackClient

BrowserStackClient.Method, BrowserStackClient.Product

Field Summary

Fields inherited from class com.browserstack.client.BrowserStackClient

cacheMap

Constructor Summary

Constructors

Constructor and Description
AppAutomateClient(String username, String accessKey)

Method Summary

Modifier and Type	Method and Description
boolean	deleteBuild(String buildId) Delete the build identified by the build identifier.
Build	getBuild(String buildId) Gets the build identified by the build identifier.
Build	getBuildByName(String buildName) Gets the build identified by the build name.
List<Build>	getBuilds() Gets the list of builds.
List<Build>	getBuilds(Automate.BuildStatus status) Gets the list of builds.
List<Build>	getBuilds(Automate.BuildStatus status, int limit) Gets the list of builds.
List<Build>	getBuilds(int limit) Gets the list of builds.
Session	getSession(String sessionId) Gets the session associated with the specified identifier.
List<Session>	getSessions(String buildId) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, Automate.BuildStatus status) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, Automate.BuildStatus status, int limit) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, int limit) Retrieves the list of sessions existing under a specific build.
AppUploadResponse	uploadApp(String filePath) Gets the filePath of app to be uploaded.

Methods inherited from class com.browserstack.client.BrowserStackClient

getAccessKey, getBrowsersForProduct, getBrowsersForProduct, getBuilds, newRequest, newRequest, newRequest, newRequest, setAccessKey, setProxy, signRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

AppAutomateClient

public AppAutomateClient(String username,
                         String accessKey)

Parameters:

username - Browserstack username

accessKey - Browserstack accessKey

Method Detail

getSession

public Session getSession(String sessionId)
                   throws SessionNotFound,
                          AppAutomateException

Gets the session associated with the specified identifier.

Specified by:

getSession in interface BrowserStackClientInterface

Overrides:

getSession in class BrowserStackClient

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

Session objects containing test session information.

Throws:

SessionNotFound - session not found error

AppAutomateException - exception for AppAutomate sessions.

uploadApp

public AppUploadResponse uploadApp(String filePath)
                            throws AppAutomateException,
                                   FileNotFoundException,
                                   InvalidFileExtensionException

Gets the filePath of app to be uploaded.

Specified by:

uploadApp in interface AppAutomate

Parameters:

filePath - absolute path of app to be uploaded.

Returns:

AppUploadResponse object containing app upload response details.

Throws:

AppAutomateException - exception for AppAutomate sessions.

FileNotFoundException - file not found at given path

InvalidFileExtensionException - unsupported file extension for app

getBuilds

public List<Build> getBuilds(Automate.BuildStatus status,
                             int limit)
                      throws AppAutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

status - Return only builds that match the specified build status.

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

AppAutomateException - exception for AppAutomate sessions.

getBuilds

public List<Build> getBuilds()
                      throws AppAutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Returns:

List of Build objects.

Throws:

AppAutomateException - exception for AppAutomate sessions.

getBuilds

public List<Build> getBuilds(int limit)
                      throws AppAutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

AppAutomateException - exception for AppAutomate sessions.

getBuilds

public List<Build> getBuilds(Automate.BuildStatus status)
                      throws AppAutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

status - Include only builds that match the specified build status.

Returns:

List of Build objects.

Throws:

AppAutomateException - exception for AppAutomate sessions.

getBuild

public Build getBuild(String buildId)
               throws BuildNotFound,
                      AppAutomateException

Gets the build identified by the build identifier.

Specified by:

getBuild in interface BrowserStackClientInterface

Overrides:

getBuild in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

List of Build objects.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.

getBuildByName

public final Build getBuildByName(@Nonnull
                                  String buildName)
                           throws BuildNotFound,
                                  AppAutomateException

Gets the build identified by the build name.

Specified by:

getBuildByName in interface BrowserStackClientInterface

Overrides:

getBuildByName in class BrowserStackClient

Parameters:

buildName - - Name of the build to search with

Returns:

Build object.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.

deleteBuild

public boolean deleteBuild(String buildId)
                    throws AppAutomateException

Delete the build identified by the build identifier.

Specified by:

deleteBuild in interface BrowserStackClientInterface

Overrides:

deleteBuild in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

true or false based on successful deletion of the build.

Throws:

AppAutomateException - exception for AppAutomate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 Automate.BuildStatus status,
                                 int limit)
                          throws BuildNotFound,
                                 AppAutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

status - Include only builds that match the specified build status.

limit - Limit results to the specified count.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.

getSessions

public List<Session> getSessions(String buildId)
                          throws BuildNotFound,
                                 AppAutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 int limit)
                          throws BuildNotFound,
                                 AppAutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

limit - Limit results to the specified count.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 Automate.BuildStatus status)
                          throws BuildNotFound,
                                 AppAutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

status - Include only builds that match the specified build status.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id

AppAutomateException - exception for AppAutomate sessions.