Skip to content

Commit 4d5b243

Browse files
author
Mykola Mokhnach
committed
Add javadoc
1 parent 991fdd1 commit 4d5b243

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

src/main/java/io/appium/java_client/screenrecording/BaseScreenRecordingOptions.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ public T withUploadOptions(ScreenRecordingUploadOptions uploadOptions) {
3939
return (T) this;
4040
}
4141

42+
/**
43+
* Builds a map, which is ready to be passed to the subordinated
44+
* Appium API.
45+
*
46+
* @return arguments mapping.
47+
*/
4248
public Map<String, Object> build() {
4349
final ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();
4450
//noinspection unchecked

src/main/java/io/appium/java_client/screenrecording/CanRecordScreen.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ default <T extends BaseStartScreenRecordingOptions> String startRecordingScreen(
3939
return CommandExecutionHelper.execute(this, startRecordingScreenCommand(options));
4040
}
4141

42+
/**
43+
* Start asynchronous screen recording process with default options.
44+
*
45+
* @return Base-64 encoded content of the recorded media file.
46+
*/
4247
default String startRecordingScreen() {
4348
return this.execute(START_RECORDING_SCREEN).getValue().toString();
4449
}
@@ -55,6 +60,12 @@ default <T extends BaseStopScreenRecordingOptions> String stopRecordingScreen(T
5560
return CommandExecutionHelper.execute(this, stopRecordingScreenCommand(options));
5661
}
5762

63+
/**
64+
* Gather the output from the previously started screen recording to a media file
65+
* with default options.
66+
*
67+
* @return Base-64 encoded content of the recorded media file.
68+
*/
5869
default String stopRecordingScreen() {
5970
return this.execute(STOP_RECORDING_SCREEN).getValue().toString();
6071
}

src/main/java/io/appium/java_client/screenrecording/ScreenRecordingUploadOptions.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ public ScreenRecordingUploadOptions withHttpMethod(RequestMethod method) {
7474
return this;
7575
}
7676

77+
/**
78+
* Builds a map, which is ready to be passed to the subordinated
79+
* Appium API.
80+
*
81+
* @return arguments mapping.
82+
*/
7783
public Map<String, Object> build() {
7884
final ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();
7985
ofNullable(remotePath).map(x -> builder.put("remotePath", x));

0 commit comments

Comments
 (0)