# IntentSanitizer

# IntentSanitizer

Artifact:[androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core)  
[View Source](https://cs.android.com/search?q=file:androidx/core/content/IntentSanitizer.java+class:androidx.core.content.IntentSanitizer)  
Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/core#1.9.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/core/content/IntentSanitizer "View this page in Java")

<br />

```
class IntentSanitizer
```

<br />

*** ** * ** ***

This class is used to make a sanitized copy of an[Intent](https://developer.android.com/reference/android/content/Intent.html). This could be used when[UnsafeIntentLaunchViolation](https://developer.android.com/reference/android/os/strictmode/UnsafeIntentLaunchViolation.html)is detected. This class is thread safe and the object created is safe to be reused. Typical usage of the class:  

```kotlin
Intent intent = new  IntentSanitizer.Builder()
     .allowComponent("com.example.ActivityA")
     .allowData("com.example")
     .allowType("text/plain")
     .build()
     .sanitizeByThrowing(intent);
```
At least one of the allowPackage, allowComponent must be called unless implicit intent is allowed. In which case, allowAnyComponent must be called and caution has to be taken to protect your private data.

## Summary

|                                                                                                         ### Nested types                                                                                                          |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[IntentSanitizer.Builder](https://developer.android.com/reference/kotlin/androidx/core/content/IntentSanitizer.Builder) General strategy of building is to only offer additive "or" operations that are chained together. |

|                             ### Public functions                              |
|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | [sanitize](https://developer.android.com/reference/kotlin/androidx/core/content/IntentSanitizer#sanitize(android.content.Intent,androidx.core.util.Consumer<java.lang.String>))`(in: `[Intent](https://developer.android.com/reference/android/content/Intent.html)`, penalty: `[Consumer](https://developer.android.com/reference/kotlin/androidx/core/util/Consumer)`<`[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!>)` This method sanitizes the given intent. |
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | [sanitizeByFiltering](https://developer.android.com/reference/kotlin/androidx/core/content/IntentSanitizer#sanitizeByFiltering(android.content.Intent))`(in: `[Intent](https://developer.android.com/reference/android/content/Intent.html)`)` Convenient method for filtering unwanted members from the input intent and log it.                                                                                                                                                                       |
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | [sanitizeByThrowing](https://developer.android.com/reference/kotlin/androidx/core/content/IntentSanitizer#sanitizeByThrowing(android.content.Intent))`(in: `[Intent](https://developer.android.com/reference/android/content/Intent.html)`)` Convenient method for throwing a SecurityException when unwanted members of the input intent is encountered.                                                                                                                                               |

## Public functions

### sanitize

Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/core#1.9.0)  

```
fun sanitize(in: Intent, penalty: Consumer<String!>): Intent
```

This method sanitizes the given intent. If dirty members are found, the errors are consumed by the penalty object. The penalty action could be called multiple times if multiple issues exist.  

|                                                                                        Parameters                                                                                         |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
| `in: `[Intent](https://developer.android.com/reference/android/content/Intent.html)                                                                                                       | the given intent.                                         |
| `penalty: `[Consumer](https://developer.android.com/reference/kotlin/androidx/core/util/Consumer)`<`[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!>` | consumer of the error message if dirty members are found. |

|                                    Returns                                    |
|-------------------------------------------------------------------------------|---------------------------------------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | a sanitized copy of the given intent. |

### sanitizeByFiltering

Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/core#1.9.0)  

```
fun sanitizeByFiltering(in: Intent): Intent
```

Convenient method for filtering unwanted members from the input intent and log it.  

|                                     Parameters                                      |
|-------------------------------------------------------------------------------------|--------------|
| `in: `[Intent](https://developer.android.com/reference/android/content/Intent.html) | input intent |

|                                    Returns                                    |
|-------------------------------------------------------------------------------|------------------------------------------------------------------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | a copy of the input intent after filtering out unwanted members. |

### sanitizeByThrowing

Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/core#1.9.0)  

```
fun sanitizeByThrowing(in: Intent): Intent
```

Convenient method for throwing a SecurityException when unwanted members of the input intent is encountered.  

|                                     Parameters                                      |
|-------------------------------------------------------------------------------------|--------------|
| `in: `[Intent](https://developer.android.com/reference/android/content/Intent.html) | input intent |

|                                    Returns                                    |
|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | a copy of the input intent if the input intent does not contain any unwanted members. |

|                                                 Throws                                                  |
|---------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| [java.lang.SecurityException](https://developer.android.com/reference/java/lang/SecurityException.html) | if the input intent contains any unwanted members. |