RequestManager (glide API)

java.lang.Object
- com.bumptech.glide.RequestManager

All Implemented Interfaces:

LifecycleListener
```
public class RequestManager
extends Object
implements LifecycleListener
```
A class for managing and starting requests for Glide. Can use activity, fragment and connectivity lifecycle events to intelligently stop, start, and restart requests. Retrieve either by instantiating a new object, or to take advantage built in Activity and Fragment lifecycle handling, use the static Glide.load methods with your Fragment or Activity.

See Also:

Glide.with(android.app.Activity), Glide.with(android.support.v4.app.FragmentActivity), Glide.with(android.app.Fragment), Glide.with(android.support.v4.app.Fragment), Glide.with(Context)

Field Summary

Fields
Modifier and Type Field and Description

protected Glide glide

Fields
Modifier and Type	Field and Description
`protected Glide`	`glide`

Constructor Summary

Constructors
Constructor and Description

RequestManager(Glide glide, Lifecycle lifecycle, RequestManagerTreeNode treeNode)

Constructors
Constructor and Description
`RequestManager(Glide glide, Lifecycle lifecycle, RequestManagerTreeNode treeNode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestManager`	`applyDefaultRequestOptions(RequestOptions requestOptions)` Updates the default `RequestOptions` for all loads started with this request manager with the given `RequestOptions`.
`<ResourceType> RequestBuilder<ResourceType>`	`as(Class<ResourceType> resourceClass)` Attempts to load the resource using any registered `ResourceDecoder`s that can decode the given resource class or any subclass of the given resource class.
`RequestBuilder<Bitmap>`	`asBitmap()` Attempts to always load the resource as a `Bitmap`, even if it could actually be animated.
`RequestBuilder<Drawable>`	`asDrawable()` Attempts to always load the resource using any registered `ResourceDecoder`s that can decode any subclass of `Drawable`.
`RequestBuilder<File>`	`asFile()` Attempts to always load a `File` containing the resource, either using a file path obtained from the media store (for local images/videos), or using Glide's disk cache (for remote images/videos).
`RequestBuilder<GifDrawable>`	`asGif()` Attempts to always load the resource as a `GifDrawable`.
`void`	`clear(Target<?> target)` Cancel any pending loads Glide may have for the target and free any resources (such as `Bitmap`s) that may have been loaded for the target so they may be reused.
`void`	`clear(View view)` Cancel any pending loads Glide may have for the view and free any resources that may have been loaded for the view.
`RequestBuilder<File>`	`download(Object model)` A helper method equivalent to calling `downloadOnly()` ()} and then `RequestBuilder.load(Object)` with the given model.
`RequestBuilder<File>`	`downloadOnly()` Attempts always load the resource into the cache and return the `File` containing the cached source data.
`boolean`	`isPaused()` Returns true if loads for this `RequestManager` are currently paused.
`RequestBuilder<Drawable>`	`load(Object model)` A helper method equivalent to calling `asDrawable()` and then `RequestBuilder.load(Object)` with the given model.
`void`	`onDestroy()` Lifecycle callback that cancels all in progress requests and clears and recycles resources for all completed requests.
`void`	`onLowMemory()`
`void`	`onStart()` Lifecycle callback that registers for connectivity events (if the android.permission.ACCESS_NETWORK_STATE permission is present) and restarts failed or paused requests.
`void`	`onStop()` Lifecycle callback that unregisters for connectivity events (if the android.permission.ACCESS_NETWORK_STATE permission is present) and pauses in progress loads.
`void`	`onTrimMemory(int level)`
`void`	`pauseRequests()` Cancels any in progress loads, but does not clear resources of completed loads.
`void`	`pauseRequestsRecursive()` Performs `pauseRequests()` recursively for all managers that are contextually descendant to this manager based on the Activity/Fragment hierarchy: When pausing on an Activity all attached fragments will also get paused.
`void`	`resumeRequests()` Restarts any loads that have not yet completed.
`void`	`resumeRequestsRecursive()` Performs `resumeRequests()` recursively for all managers that are contextually descendant to this manager based on the Activity/Fragment hierarchy.
`RequestManager`	`setDefaultRequestOptions(RequestOptions requestOptions)` Replaces the default `RequestOptions` for all loads started with this request manager with the given `RequestOptions`.
`protected void`	`setRequestOptions(RequestOptions toSet)`
`String`	`toString()`

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

- Field Detail
  - glide
```
protected final Glide glide
```
- Constructor Detail
  - RequestManager
```
public RequestManager(Glide glide,
                      Lifecycle lifecycle,
                      RequestManagerTreeNode treeNode)
```
- Method Detail
  - setRequestOptions
```
protected void setRequestOptions(@NonNull
                                 RequestOptions toSet)
```
  - applyDefaultRequestOptions
```
public RequestManager applyDefaultRequestOptions(RequestOptions requestOptions)
```
    Updates the default RequestOptions for all loads started with this request manager with the given RequestOptions.
    The RequestOptions provided here are applied on top of those provided via GlideBuilder.setDefaultRequestOptions(RequestOptions). If there are conflicts, the options applied here will win. Note that this method does not mutate options provided to GlideBuilder.setDefaultRequestOptions(RequestOptions).
    Multiple sets of options can be applied. If there are conflicts the last RequestOptions applied will win.
    The modified options will only be applied to loads started after this method is called.
    
    Returns:
    
    This request manager.
    
    See Also:
    
    RequestBuilder.apply(RequestOptions)
  - setDefaultRequestOptions
```
public RequestManager setDefaultRequestOptions(RequestOptions requestOptions)
```
    Replaces the default RequestOptions for all loads started with this request manager with the given RequestOptions.
    The RequestOptions provided here replace those that have been previously provided via GlideBuilder.setDefaultRequestOptions(RequestOptions), setDefaultRequestOptions(RequestOptions) and applyDefaultRequestOptions(RequestOptions).
    Subsequent calls to applyDefaultRequestOptions(RequestOptions) will not mutate the RequestOptions provided here. Instead the manager will create a clone of these options and mutate the clone.
    
    Returns:
    
    This request manager.
    
    See Also:
    
    applyDefaultRequestOptions(RequestOptions)
  - onTrimMemory
```
public void onTrimMemory(int level)
```
    See Also:
    
    ComponentCallbacks2.onTrimMemory(int)
  - onLowMemory
```
public void onLowMemory()
```
    See Also:
    
    ComponentCallbacks.onLowMemory()
  - isPaused
```
public boolean isPaused()
```
    Returns true if loads for this RequestManager are currently paused.
    
    See Also:
    
    pauseRequests(), resumeRequests()
  - pauseRequests
```
public void pauseRequests()
```
    Cancels any in progress loads, but does not clear resources of completed loads.
    
    See Also:
    
    isPaused(), resumeRequests()
  - pauseRequestsRecursive
```
public void pauseRequestsRecursive()
```
    Performs pauseRequests() recursively for all managers that are contextually descendant to this manager based on the Activity/Fragment hierarchy:
    - When pausing on an Activity all attached fragments will also get paused.
    - When pausing on an attached Fragment all descendant fragments will also get paused.
    - When pausing on a detached Fragment or the application context only the current RequestManager is paused.
    Note, on pre-Jelly Bean MR1 calling pause on a Fragment will not cause child fragments to pause, in this case either call pause on the Activity or use a support Fragment.
  - resumeRequests
```
public void resumeRequests()
```
    Restarts any loads that have not yet completed.
    
    See Also:
    
    isPaused(), pauseRequests()
  - resumeRequestsRecursive
```
public void resumeRequestsRecursive()
```
    Performs resumeRequests() recursively for all managers that are contextually descendant to this manager based on the Activity/Fragment hierarchy. The hierarchical semantics are identical as for pauseRequestsRecursive().
  - onStart
```
public void onStart()
```
    Lifecycle callback that registers for connectivity events (if the android.permission.ACCESS_NETWORK_STATE permission is present) and restarts failed or paused requests.
    
    Specified by:
    
    onStart in interface LifecycleListener
  - onStop
```
public void onStop()
```
    Lifecycle callback that unregisters for connectivity events (if the android.permission.ACCESS_NETWORK_STATE permission is present) and pauses in progress loads.
    
    Specified by:
    
    onStop in interface LifecycleListener
  - onDestroy
```
public void onDestroy()
```
    Lifecycle callback that cancels all in progress requests and clears and recycles resources for all completed requests.
    
    Specified by:
    
    onDestroy in interface LifecycleListener
  - asBitmap
```
public RequestBuilder<Bitmap> asBitmap()
```
    Attempts to always load the resource as a Bitmap, even if it could actually be animated.
    
    Returns:
    
    A new request builder for loading a Bitmap
  - asGif
```
public RequestBuilder<GifDrawable> asGif()
```
    Attempts to always load the resource as a GifDrawable.
    If the underlying data is not a GIF, this will fail. As a result, this should only be used if the model represents an animated GIF and the caller wants to interact with the GifDrawable directly. Normally using just asDrawable() is sufficient because it will determine whether or not the given data represents an animated GIF and return the appropriate Drawable, animated or not, automatically.
    
    Returns:
    
    A new request builder for loading a GifDrawable.
  - asDrawable
```
public RequestBuilder<Drawable> asDrawable()
```
    Attempts to always load the resource using any registered ResourceDecoders that can decode any subclass of Drawable.
    By default, may return either a BitmapDrawable or GifDrawable, but if additional decoders are registered for other Drawable subclasses, any of those subclasses may also be returned.
    
    Returns:
    
    A new request builder for loading a Drawable.
  - load
```
public RequestBuilder<Drawable> load(@Nullable
                                     Object model)
```
    A helper method equivalent to calling asDrawable() and then RequestBuilder.load(Object) with the given model.
    
    Returns:
    
    A new request builder for loading a Drawable using the given model.
  - downloadOnly
```
public RequestBuilder<File> downloadOnly()
```
    Attempts always load the resource into the cache and return the File containing the cached source data.
    This method is designed to work for remote data that is or will be cached using DiskCacheStrategy.DATA. As a result, specifying a DiskCacheStrategy on this request is generally not recommended.
    
    Returns:
    
    A new request builder for downloading content to cache and returning the cache File.
  - download
```
public RequestBuilder<File> download(@Nullable
                                     Object model)
```
    A helper method equivalent to calling downloadOnly() ()} and then RequestBuilder.load(Object) with the given model.
    
    Returns:
    
    A new request builder for loading a Drawable using the given model.
  - asFile
```
public RequestBuilder<File> asFile()
```
    Attempts to always load a File containing the resource, either using a file path obtained from the media store (for local images/videos), or using Glide's disk cache (for remote images/videos).
    For remote content, prefer downloadOnly().
    
    Returns:
    
    A new request builder for obtaining File paths to content.
  - as
```
public <ResourceType> RequestBuilder<ResourceType> as(Class<ResourceType> resourceClass)
```
    Attempts to load the resource using any registered ResourceDecoders that can decode the given resource class or any subclass of the given resource class.
    
    Parameters:
    
    resourceClass - The resource to decode.
    
    Returns:
    
    A new request builder for loading the given resource class.
  - clear
```
public void clear(View view)
```
    Cancel any pending loads Glide may have for the view and free any resources that may have been loaded for the view.
    Note that this will only work if View.setTag(Object) is not called on this view outside of Glide.
    
    Parameters:
    
    view - The view to cancel loads and free resources for.
    
    Throws:
    
    IllegalArgumentException - if an object other than Glide's metadata is put as the view's tag.
    
    See Also:
    
    clear(Target)
  - clear
```
public void clear(@Nullable
                  Target<?> target)
```
    Cancel any pending loads Glide may have for the target and free any resources (such as Bitmaps) that may have been loaded for the target so they may be reused.
    
    Parameters:
    
    target - The Target to cancel loads for.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RequestManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

glide

Constructor Detail

RequestManager

Method Detail

setRequestOptions

applyDefaultRequestOptions

setDefaultRequestOptions

onTrimMemory

onLowMemory

isPaused

pauseRequests

pauseRequestsRecursive

resumeRequests

resumeRequestsRecursive

onStart

onStop

onDestroy

asBitmap

asGif

asDrawable

load

downloadOnly

download

asFile

as

clear

clear

toString