# EncryptedTopic

Artifact: [androidx.privacysandbox.ads:ads-adservices](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads) [View Source](https://cs.android.com/search?q=file:androidx/privacysandbox/ads/adservices/topics/EncryptedTopic.kt+class:androidx.privacysandbox.ads.adservices.topics.EncryptedTopic) Added in [1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

*** ** * ** ***


```
@ExperimentalFeatures.Ext11OptIn
public final class EncryptedTopic
```

<br />

*** ** * ** ***

This class will be used to return encrypted topic cipher text along with necessary fields required to decrypt it.

Decryption of {@link EncryptedTopic#getEncryptedTopic()} should give json string for {@link
Topic}. Example of decrypted json string: {@code { "taxonomy_version": 5, "model_version": 2,
"topic_id": 10010 }}

Decryption of cipher text is expected to happen on the server with the corresponding algorithm
and private key for the public key {@link EncryptedTopic#getKeyIdentifier()}}.

Detailed steps on decryption can be found on [Developer
Guide](https://developer.android.com/design-for-safety/privacy-sandbox/guides/topics).

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#EncryptedTopic(kotlin.ByteArray,kotlin.String,kotlin.ByteArray)( @https://developer.android.com/reference/androidx/annotation/NonNull byte[] encryptedTopic, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html keyIdentifier, @https://developer.android.com/reference/androidx/annotation/NonNull byte[] encapsulatedKey )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull byte[]` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#getEncapsulatedKey()()` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull byte[]` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#getEncryptedTopic()()` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#getKeyIdentifier()()` |
| `int` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/topics/EncryptedTopic#toString()()` |

## Public constructors

### EncryptedTopic

Added in [1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

```
public EncryptedTopic(
    @NonNull byte[] encryptedTopic,
    @NonNull String keyIdentifier,
    @NonNull byte[] encapsulatedKey
)
```

## Public methods

### equals

```
public boolean equals(Object other)
```

### getEncapsulatedKey

Added in [1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

```
public final @NonNull byte[] getEncapsulatedKey()
```

### getEncryptedTopic

Added in [1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

```
public final @NonNull byte[] getEncryptedTopic()
```

### getKeyIdentifier

Added in [1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

```
public final @NonNull String getKeyIdentifier()
```

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```