Stay organized with collections
Save and categorize content based on your preferences.
ApiSurface
@Target([AnnotationTarget.TYPE]) annotation class ApiSurface
Specifies an API surface a call is being made from.
Summary
Public constructors
|
|
Specifies an API surface a call is being made from.
|
Constants
SESSIONS
const val SESSIONS: Int
The API surface associated with the higher level Sessions APIs.
Value: 3
UNKNOWN
const val UNKNOWN: Int
The API surface was not requested or cannot be determined.
Value: 0
WAKE_UP
const val WAKE_UP: Int
The API surface associated with waking up an application on the remote device.
Value: 4
Public constructors
<init>
ApiSurface()
Specifies an API surface a call is being made from.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003e@ApiSurface\u003c/code\u003e annotation specifies the API surface from which a call originates.\u003c/p\u003e\n"],["\u003cp\u003eIt includes constants like \u003ccode\u003eCONNECTIONS\u003c/code\u003e, \u003ccode\u003eDISCOVERY\u003c/code\u003e, \u003ccode\u003eSESSIONS\u003c/code\u003e, \u003ccode\u003eUNKNOWN\u003c/code\u003e, and \u003ccode\u003eWAKE_UP\u003c/code\u003e representing different API surfaces.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCONNECTIONS\u003c/code\u003e is used for \u003ccode\u003eDtdiClient.sendPayload\u003c/code\u003e and \u003ccode\u003eDtdiClient.registerPayloadReceiver\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDISCOVERY\u003c/code\u003e is used for \u003ccode\u003eDtdiClient.createDevicePickerIntent\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSESSIONS\u003c/code\u003e, \u003ccode\u003eUNKNOWN\u003c/code\u003e, and \u003ccode\u003eWAKE_UP\u003c/code\u003e represent sessions, unknown surfaces, and wake-up operations, respectively.\u003c/p\u003e\n"]]],["`ApiSurface` is an annotation specifying the origin of an API call. It defines five constant API surfaces: `CONNECTIONS` (for `sendPayload` and `registerPayloadReceiver`), `DISCOVERY` (for `createDevicePickerIntent`), `SESSIONS` (for higher-level session APIs), `UNKNOWN` (for undetermined surfaces), and `WAKE_UP` (for waking up remote apps). Each surface is represented by an integer value. A default constructor exists for `ApiSurface`.\n"],null,["# ApiSurface\n==========\n\n```\n@Target([AnnotationTarget.TYPE]) annotation class ApiSurface\n```\n\n|--------------------------------------------------|\n| [com.google.android.gms.dtdi.core.ApiSurface](#) |\n\nSpecifies an API surface a call is being made from.\n\nSummary\n-------\n\n| ### Constants ||\n|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| const [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONNECTIONS](#Companion.CONNECTIONS:kotlin.Int) The API surface associated with [DtdiClient.sendPayload](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#sendPayload(com.google.android.gms.dtdi.core.ChannelInfo,%20android.os.IBinder,%20kotlin.ByteArray)) and [DtdiClient.registerPayloadReceiver](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#registerPayloadReceiver(com.google.android.gms.dtdi.core.ChannelInfo,%20android.os.IBinder,%20com.google.android.gms.dtdi.core.OnPayloadReceivedCallback)). |\n| const [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [DISCOVERY](#Companion.DISCOVERY:kotlin.Int) The API surface associated with [DtdiClient.createDevicePickerIntent](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#createDevicePickerIntent(kotlin.collections.List,%20kotlin.Boolean,%20com.google.android.gms.dtdi.core.WakeUpRequest,%20com.google.android.gms.dtdi.analytics.CorrelationData,%20kotlin.Int)). |\n| const [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SESSIONS](#Companion.SESSIONS:kotlin.Int) The API surface associated with the higher level Sessions APIs. |\n| const [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [UNKNOWN](#Companion.UNKNOWN:kotlin.Int) The API surface was not requested or cannot be determined. |\n| const [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [WAKE_UP](#Companion.WAKE_UP:kotlin.Int) The API surface associated with waking up an application on the remote device. |\n\n| ### Public constructors ||\n|---------------------------------------------------------------------------------|---|\n| [\u003cinit\u003e](#%3Cinit%3E())`()` Specifies an API surface a call is being made from. |\n\nConstants\n---------\n\n### CONNECTIONS\n\n```\nconst val CONNECTIONS: Int\n```\n\nThe API surface associated with [DtdiClient.sendPayload](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#sendPayload(com.google.android.gms.dtdi.core.ChannelInfo,%20android.os.IBinder,%20kotlin.ByteArray)) and\n[DtdiClient.registerPayloadReceiver](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#registerPayloadReceiver(com.google.android.gms.dtdi.core.ChannelInfo,%20android.os.IBinder,%20com.google.android.gms.dtdi.core.OnPayloadReceivedCallback)). \n\n Value: 2\n\n### DISCOVERY\n\n```\nconst val DISCOVERY: Int\n```\n\nThe API surface associated with [DtdiClient.createDevicePickerIntent](/android/reference/com/google/android/gms/dtdi/core/DtdiClient#createDevicePickerIntent(kotlin.collections.List,%20kotlin.Boolean,%20com.google.android.gms.dtdi.core.WakeUpRequest,%20com.google.android.gms.dtdi.analytics.CorrelationData,%20kotlin.Int)). \n\n Value: 1\n\n### SESSIONS\n\n```\nconst val SESSIONS: Int\n```\n\nThe API surface associated with the higher level Sessions APIs. \n\n Value: 3\n\n### UNKNOWN\n\n```\nconst val UNKNOWN: Int\n```\n\nThe API surface was not requested or cannot be determined. \n\n Value: 0\n\n### WAKE_UP\n\n```\nconst val WAKE_UP: Int\n```\n\nThe API surface associated with waking up an application on the remote device. \n\n Value: 4\n\nPublic constructors\n-------------------\n\n### \\\u003cinit\\\u003e\n\n```\nApiSurface()\n```\n\nSpecifies an API surface a call is being made from."]]
