| java.lang.Object | |||
| ↳ | com.pspdfkit.annotations.actions.Action | ||
| ↳ | com.pspdfkit.annotations.actions.AbstractMediaAction | ||
| ↳ | com.pspdfkit.annotations.actions.RichMediaExecuteAction | ||
Class Overview
Action for starting RichMediaAnnotations.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | RichMediaExecuteAction.RichMediaExecuteActionType | Types of rich media execute actions. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object o) | ||||||||||
| Maybe<RichMediaAnnotation> |
getRichMediaAnnotationAsync(PdfDocument pdfDocument)
Returns rich media annotation associated with this action, asynchronously.
| ||||||||||
| int |
getRichMediaAnnotationObjectNumber()
Returns the object number of the referenced rich media annotation (if any).
| ||||||||||
| 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.
| ||||||||||
| int | hashCode() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pspdfkit.annotations.actions.AbstractMediaAction
| |||||||||||
|
From class
com.pspdfkit.annotations.actions.Action
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public Maybe<RichMediaAnnotation> getRichMediaAnnotationAsync (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
Maybethat either emits the requested annotation in `onSuccess()` or terminates with `onCompleted()` or `onError()`.
public int getRichMediaAnnotationObjectNumber ()
Returns the object number of the referenced rich media annotation (if any).
Returns
- Referenced annotation object number.
public RichMediaExecuteAction.RichMediaExecuteActionType getRichMediaExecuteActionType ()
Type of action to be performed on the specified rich media annotation.
Returns
RichMediaExecuteAction.RichMediaExecuteActionTypedescribing the action, orUNKNOWNif not known.
public ActionType getType ()
Returns type of action to make down-casting easier.
Returns
- Type of this action.