RichMediaExecuteAction

All Implemented Interfaces:


public class RichMediaExecuteAction
extends AbstractMediaAction

Action for starting com.pspdfkit.annotations.RichMediaAnnotations.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

public enum RichMediaExecuteAction.RichMediaExecuteActionType
Types of rich media execute actions.

Field Summary

Fields
Modifier and Type Field Description

Constructor Summary

Constructors

Constructor Description

Enum Constant Summary

Enum Constants
Enum Constant Description

Method Summary

Modifier and Type	Method	Description
`int`	`getRichMediaAnnotationObjectNumber()`	Returns the object number of the referenced rich media annotation (if any).
`Maybe<RichMediaAnnotation>`	`getRichMediaAnnotationAsync(@NonNull() PdfDocument pdfDocument)`	Returns rich media annotation associated with this action, asynchronously.
`RichMediaExecuteAction.RichMediaExecuteActionType`	`getRichMediaExecuteActionType()`	Type of action to be performed on the specified rich media annotation.
`ActionType`	`getType()`	Returns type of action to make down-casting easier.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getRichMediaAnnotationObjectNumber
```
 int getRichMediaAnnotationObjectNumber()
```
    Returns the object number of the referenced rich media annotation (if any).
    
    Returns:
    
    Referenced annotation object number.
  - getRichMediaAnnotationAsync
```
@NonNull() Maybe<RichMediaAnnotation> getRichMediaAnnotationAsync(@NonNull() PdfDocument pdfDocument)
```
    Returns rich media annotation associated with this action, asynchronously.
    
    Parameters:
    
    pdfDocument - PDF document in which to look for the associated rich media annotation.
    
    Returns:
    
    An instance of Maybe that either emits the requested annotation in `onSuccess()` or terminates with `onCompleted()` or `onError()`.
  - getRichMediaExecuteActionType
```
@NonNull() RichMediaExecuteAction.RichMediaExecuteActionType getRichMediaExecuteActionType()
```
    Type of action to be performed on the specified rich media annotation.
    
    Returns:
    
    RichMediaExecuteActionType describing the action, or UNKNOWN if not known.
  - getType
```
@NonNull() ActionType getType()
```
    Returns type of action to make down-casting easier.
    
    Returns:
    
    Type of this action.
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```