Stay organized with collections
Save and categorize content based on your preferences.
WakeUpRequest
class
WakeUpRequest
:
AbstractSafeParcelable
Represents a wake up request. Not suitable for sending across the wire.
Summary
Represents a wake up request.
The intent action to use to perform the wakeup.
The extras to be passed through the intent to perform the wakeup.
A user-visible string describing the reason for this wake up request.
Ordered list of allowed remote app scopes for expanding the wakeup beyond a same package match.
Constants
ANALYTICS_INFO
const
val
ANALYTICS_INFO
:
String
Value: "com.google.android.gms.dtdi.extra.ANALYTICS_INFO"
const
val
APP_ICON_EXTRA_KEY
:
String
Value: "com.google.android.gms.dtdi.extra.APP_ICON"
ORIGIN_DEVICE
const
val
ORIGIN_DEVICE
:
String
Value: "com.google.android.gms.dtdi.extra.ORIGIN_DEVICE"
Public constructors
<init>
WakeUpRequest
(
action
:
String
,
extras
:
List
<
Extra
>
,
reason
:
String
,
scopes
:
List
<
RemoteAppScope
>
?
=
null )
Represents a wake up request. Not suitable for sending across the wire.
Public methods
writeToParcel
fun
writeToParcel
(
dest
:
Parcel
,
flags
:
Int
)
:
Unit
Properties
action
val
action
:
String
The intent action to use to perform the wakeup.
val
extras
:
List
<
Extra
>
The extras to be passed through the intent to perform the wakeup.
reason
val
reason
:
String
A user-visible string describing the reason for this wake up request.
scopes
val
scopes
:
List
<
RemoteAppScope
>
?
Ordered list of allowed remote app scopes for expanding the wakeup beyond a same package match.
Companion properties
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eWakeUpRequest\u003c/code\u003e is a class representing a wake up request that's not meant for network transmission.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties like \u003ccode\u003eaction\u003c/code\u003e, \u003ccode\u003eextras\u003c/code\u003e, \u003ccode\u003ereason\u003c/code\u003e, and \u003ccode\u003escopes\u003c/code\u003e to define the request's specifics.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eaction\u003c/code\u003e property defines the intent action, \u003ccode\u003eextras\u003c/code\u003e holds additional data, \u003ccode\u003ereason\u003c/code\u003e provides a user-readable description, and \u003ccode\u003escopes\u003c/code\u003e specify allowed remote app scopes.\u003c/p\u003e\n"],["\u003cp\u003eIt has a \u003ccode\u003ewriteToParcel\u003c/code\u003e method for persistence and a \u003ccode\u003eCREATOR\u003c/code\u003e for object creation.\u003c/p\u003e\n"],["\u003cp\u003eConstants like \u003ccode\u003eANALYTICS_INFO\u003c/code\u003e, \u003ccode\u003eAPP_ICON_EXTRA_KEY\u003c/code\u003e, and \u003ccode\u003eORIGIN_DEVICE\u003c/code\u003e provide predefined extra keys for the request.\u003c/p\u003e\n"]]],[],null,["# WakeUpRequest\n=============\n\n```\nclass WakeUpRequest : AbstractSafeParcelable\n```\n\n|-----------------------------------------------------|\n| [com.google.android.gms.dtdi.core.WakeUpRequest](#) |\n\nRepresents a wake up request. Not suitable for sending across the wire.\n\nSummary\n-------\n\n| ### Constants ||\n|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------|\n| const [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [ANALYTICS_INFO](#Companion.ANALYTICS_INFO:kotlin.String) \u003cbr /\u003e |\n| const [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [APP_ICON_EXTRA_KEY](#Companion.APP_ICON_EXTRA_KEY:kotlin.String) \u003cbr /\u003e |\n| const [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [ORIGIN_DEVICE](#Companion.ORIGIN_DEVICE:kotlin.String) \u003cbr /\u003e |\n\n| ### Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [\u003cinit\u003e](#%3Cinit%3E(kotlin.String,%20kotlin.collections.List,%20kotlin.String,%20kotlin.collections.List))`(`action:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `extras:` `[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)\u003c[Extra](/android/reference/com/google/android/gms/dtdi/core/Extra)\u003e`, `reason:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `scopes:` `[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)\u003c[RemoteAppScope](/android/reference/com/google/android/gms/dtdi/core/RemoteAppScope)\u003e?` `=` null)` Represents a wake up request. |\n\n| ### Public methods ||\n|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [writeToParcel](#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`dest:` `[Parcel](https://developer.android.com/reference/android/os/Parcel.html)`, `flags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` \u003cbr /\u003e |\n\n| ### Properties ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [action](#action:kotlin.String) The intent action to use to perform the wakeup. |\n| [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)\\\u003c[Extra](/android/reference/com/google/android/gms/dtdi/core/Extra)\\\u003e | [extras](#extras:kotlin.collections.List) The extras to be passed through the intent to perform the wakeup. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [reason](#reason:kotlin.String) A user-visible string describing the reason for this wake up request. |\n| [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)\\\u003c[RemoteAppScope](/android/reference/com/google/android/gms/dtdi/core/RemoteAppScope)\\\u003e? | [scopes](#scopes:kotlin.collections.List) Ordered list of allowed remote app scopes for expanding the wakeup beyond a same package match. |\n\n| ### Companion properties ||\n|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|\n| [Creator](https://developer.android.com/reference/android/os/Parcelable/Creator.html)\\\u003c[WakeUpRequest](#)\\\u003e | [CREATOR](#Companion.CREATOR:android.os.Parcelable.Creator) \u003cbr /\u003e |\n\nConstants\n---------\n\n### ANALYTICS_INFO\n\n```\nconst val ANALYTICS_INFO: String\n``` \n\n Value: \"com.google.android.gms.dtdi.extra.ANALYTICS_INFO\"\n\n### APP_ICON_EXTRA_KEY\n\n```\nconst val APP_ICON_EXTRA_KEY: String\n``` \n\n Value: \"com.google.android.gms.dtdi.extra.APP_ICON\"\n\n### ORIGIN_DEVICE\n\n```\nconst val ORIGIN_DEVICE: String\n``` \n\n Value: \"com.google.android.gms.dtdi.extra.ORIGIN_DEVICE\"\n\nPublic constructors\n-------------------\n\n### \\\u003cinit\\\u003e\n\n```\nWakeUpRequest(\n action: String, \n extras: List\u003cExtra\u003e, \n reason: String, \n scopes: List\u003cRemoteAppScope\u003e? = null)\n```\n\nRepresents a wake up request. Not suitable for sending across the wire.\n\nPublic methods\n--------------\n\n### writeToParcel\n\n```\nfun writeToParcel(\n dest: Parcel, \n flags: Int\n): Unit\n```\n\nProperties\n----------\n\n### action\n\n```\nval action: String\n```\n\nThe intent action to use to perform the wakeup. \n\n### extras\n\n```\nval extras: List\u003cExtra\u003e\n```\n\nThe extras to be passed through the intent to perform the wakeup. \n\n### reason\n\n```\nval reason: String\n```\n\nA user-visible string describing the reason for this wake up request. \n\n### scopes\n\n```\nval scopes: List\u003cRemoteAppScope\u003e?\n```\n\nOrdered list of allowed remote app scopes for expanding the wakeup beyond a same package match.\n\nCompanion properties\n--------------------\n\n### CREATOR\n\n```\nval CREATOR: Creator\u003cWakeUpRequest\u003e\n```"]]
