Function used to transform a IQueueItem into a different item before it is loaded into a viewer card instance
This function is allowed to be synchronous or asynchronous, but because this function is in the document load pipeline, extensions should strive to make it
as performant as possible and should apply memoization if possible.
param
Public Review Interface API
param
Viewer card the transform is executing for
param
Queue item that would be passed to the viewer card instance's cardLoadItem() method
param
Load options that would be passed to the viewer card instance's cardLoadItem() method. This includes the cancellationToken that can be used
wherever it is appropriate.
returns
A transform result defining the new parameters to be passed to the viewer card instance
Function used to transform a IQueueItem into a different item before it is loaded into a viewer card instance
This function is allowed to be synchronous or asynchronous, but because this function is in the document load pipeline, extensions should strive to make it as performant as possible and should apply memoization if possible.
Public Review Interface API
Viewer card the transform is executing for
Queue item that would be passed to the viewer card instance's
cardLoadItem()
methodLoad options that would be passed to the viewer card instance's
cardLoadItem()
method. This includes the cancellationToken that can be used wherever it is appropriate.A transform result defining the new parameters to be passed to the viewer card instance