-
- All Implemented Interfaces:
-
com.facebook.fresco.middleware.HasExtraData
public interface ProducerContext implements HasExtraDataUsed to pass context information to producers.
Object implementing this interface is passed to all producers participating in pipeline request {@see Producer#produceResults}. Its responsibility is to instruct producers which image should be fetched/decoded/resized/cached etc. This class also handles request cancellation.
In order to be notified when cancellation is requested, a producer should use the
runOnCancellationRequestedmethod which takes an instance of Runnable and executes it when the pipeline client cancels the image request.
-
-
Method Summary
Modifier and Type Method Description abstract UnitaddCallbacks(ProducerContextCallbacks callbacks)Adds callbacks to the set of callbacks that are executed at various points during the processing of a request. abstract UnitputOriginExtra(String origin, String subcategory)Helper to set HasExtraData.KEY_ORIGIN and HasExtraData.KEY_ORIGIN_SUBCATEGORY abstract UnitputOriginExtra(String origin)Helper to set HasExtraData.KEY_ORIGIN abstract ImageRequestgetImageRequest()abstract StringgetId()abstract StringgetUiComponentId()abstract ProducerListener2getProducerListener()abstract ObjectgetCallerContext()abstract ImageRequest.RequestLevelgetLowestPermittedRequestLevel()abstract BooleangetIsPrefetch()abstract PrioritygetPriority()abstract BooleangetIsIntermediateResultExpected()abstract ImagePipelineConfigInterfacegetImagePipelineConfig()-
-
Method Detail
-
addCallbacks
abstract Unit addCallbacks(ProducerContextCallbacks callbacks)
Adds callbacks to the set of callbacks that are executed at various points during the processing of a request.
- Parameters:
callbacks- callbacks to be executed
-
putOriginExtra
abstract Unit putOriginExtra(String origin, String subcategory)
Helper to set HasExtraData.KEY_ORIGIN and HasExtraData.KEY_ORIGIN_SUBCATEGORY
-
putOriginExtra
abstract Unit putOriginExtra(String origin)
Helper to set HasExtraData.KEY_ORIGIN
-
getImageRequest
abstract ImageRequest getImageRequest()
-
getUiComponentId
abstract String getUiComponentId()
-
getProducerListener
abstract ProducerListener2 getProducerListener()
-
getCallerContext
abstract Object getCallerContext()
-
getLowestPermittedRequestLevel
abstract ImageRequest.RequestLevel getLowestPermittedRequestLevel()
-
getIsPrefetch
abstract Boolean getIsPrefetch()
-
getPriority
abstract Priority getPriority()
-
getIsIntermediateResultExpected
abstract Boolean getIsIntermediateResultExpected()
-
getImagePipelineConfig
abstract ImagePipelineConfigInterface getImagePipelineConfig()
-
-
-
-