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 Description static class
ScreenRecordingUploadOptions.RequestMethod
-
Constructor Summary
Constructors Constructor Description ScreenRecordingUploadOptions()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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
withFileFieldName(java.lang.String fileFieldName)
Sets the form field name containing the binary payload in multipart/form-data requests.ScreenRecordingUploadOptions
withFormFields(java.util.Map<java.lang.String,java.lang.Object> formFields)
Sets additional form fields in multipart/form-data requests.ScreenRecordingUploadOptions
withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
Sets additional headers in multipart/form-data requests.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.
-
-
-
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.
-
withFileFieldName
public ScreenRecordingUploadOptions withFileFieldName(java.lang.String fileFieldName)
Sets the form field name containing the binary payload in multipart/form-data requests.- Parameters:
fileFieldName
- The name of the form field containing the binary payload. "file" by default.- Returns:
- self instance for chaining.
- Since:
- Appium 1.18.0
-
withFormFields
public ScreenRecordingUploadOptions withFormFields(java.util.Map<java.lang.String,java.lang.Object> formFields)
Sets additional form fields in multipart/form-data requests.- Parameters:
formFields
- form fields mapping. If any entry has the same key as `fileFieldName` then it is going to be ignored.- Returns:
- self instance for chaining.
- Since:
- Appium 1.18.0
-
withHeaders
public ScreenRecordingUploadOptions withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
Sets additional headers in multipart/form-data requests.- Parameters:
headers
- headers mapping.- Returns:
- self instance for chaining.
- Since:
- Appium 1.18.0
-
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.
-
-