# ReceivingSession

# ReceivingSession

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/com/google/ambient/crossdevice/sessions/ReceivingSession "View this page in Java")

<br />

```
@RequiresApi(value = 26) interface ReceivingSession : TransferrableSession
```

<br />

*** ** * ** ***

Describes a Session that is in the process of being transferred to another device. The receiver of the Session will use this class to initialize the application.

## Summary

|                                                                                                                                                                                                                                                                    ### Public functions                                                                                                                                                                                                                                                                    ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `suspend `[SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId)                                                                                                                  | [onComplete](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/ReceivingSession#onComplete())`()` Called when the receiving device is initialized and ready to run the Session.                                                                                             |
| [ListenableFuture](https://developer.android.com/reference/kotlin/com/google/common/util/concurrent/ListenableFuture)`<`[SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId)`>` | [onCompleteFuture](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/ReceivingSession#onCompleteFuture())`()` Java-compatible version of[onComplete](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/ReceivingSession#onComplete()). |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           ### Inherited functions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| From class[com.google.ambient.crossdevice.sessions.TransferrableSession](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession) |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `suspend `[Unit](https://developer.android.com/reference/kotlin/kotlin/Unit)                                                                                                                  | [cancelTransfer](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession#cancelTransfer())`()` Cancels the transfer.                                                                                                                                                                 | | [ListenableFuture](https://developer.android.com/reference/kotlin/com/google/common/util/concurrent/ListenableFuture)`<`[Unit](https://developer.android.com/reference/kotlin/kotlin/Unit)`>` | [cancelTransferFuture](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession#cancelTransferFuture())`()` Java-compatible version of[cancelTransfer](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession#cancelTransfer()). | | [SessionRemoteConnection](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionRemoteConnection)                                                     | [getStartupRemoteConnection](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession#getStartupRemoteConnection())`()` Gets communication channel to send initialization messages back and forth between the originating and receiving device.                                       | |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ### Inherited properties                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| From class[com.google.ambient.crossdevice.sessions.TransferrableSession](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession) |---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId) | [sessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession#sessionId()) [SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId)this[TransferrableSession](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/TransferrableSession)belongs to. | |

## Public functions

### onComplete

```
suspend fun onComplete(): SessionId
```

Called when the receiving device is initialized and ready to run the Session. After this call, all methods will throw[SessionException](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionException)with[HANDLE_INVALIDATED](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionException.Companion#HANDLE_INVALIDATED()).  

|                                                                                                                      Returns                                                                                                                      ||
|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| [SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId) | The[SessionId](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionId)that was received. |

|                                                                                                                                                                                                      Throws                                                                                                                                                                                                       ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `com.google.ambient.crossdevice.sessions.SessionException: `[com.google.ambient.crossdevice.sessions.SessionException](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/SessionException) | if the transfer cannot be completed for any reason: - Session transfer is cancelled already (by either originating or receiving device) - Handle is invalidated - Internal error |

### onCompleteFuture

```
fun onCompleteFuture(): ListenableFuture<SessionId>
```

Java-compatible version of[onComplete](https://developer.android.com/reference/kotlin/com/google/ambient/crossdevice/sessions/ReceivingSession#onComplete()).