io.appium.java_client.screenrecording

Class ScreenRecordingUploadOptions

java.lang.Object

io.appium.java_client.screenrecording.ScreenRecordingUploadOptions

public class ScreenRecordingUploadOptions
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScreenRecordingUploadOptions.RequestMethod

Constructor Summary

Constructors

Constructor and Description
ScreenRecordingUploadOptions()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	build() Builds a map, which is ready to be passed to the subordinated Appium API.
static ScreenRecordingUploadOptions	uploadOptions()
ScreenRecordingUploadOptions	withAuthCredentials(java.lang.String user, java.lang.String pass) Sets the credentials for remote ftp/http authentication (if needed).
ScreenRecordingUploadOptions	withHttpMethod(ScreenRecordingUploadOptions.RequestMethod method) Sets the method name for http(s) upload.
ScreenRecordingUploadOptions	withRemotePath(java.lang.String remotePath) The path to the remote location, where the resulting video should be uploaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenRecordingUploadOptions

public ScreenRecordingUploadOptions()

Method Detail

uploadOptions

public static ScreenRecordingUploadOptions uploadOptions()

withRemotePath

public ScreenRecordingUploadOptions withRemotePath(java.lang.String remotePath)

The path to the remote location, where the resulting video should be uploaded.

Parameters:

remotePath - The path to a writable remote location.

Returns:

self instance for chaining.

withAuthCredentials

public ScreenRecordingUploadOptions withAuthCredentials(java.lang.String user,
                                                        java.lang.String pass)

Sets the credentials for remote ftp/http authentication (if needed). This option only has an effect if remotePath is provided.

Parameters:

user - The name of the user for the remote authentication.

pass - The password for the remote authentication.

Returns:

self instance for chaining.

withHttpMethod

public ScreenRecordingUploadOptions withHttpMethod(ScreenRecordingUploadOptions.RequestMethod method)

Sets the method name for http(s) upload. PUT is used by default. This option only has an effect if remotePath is provided.

Parameters:

method - The HTTP method name.

Returns:

self instance for chaining.

build

public java.util.Map<java.lang.String,java.lang.Object> build()

Builds a map, which is ready to be passed to the subordinated Appium API.

Returns:

arguments mapping.