Skip to content

Commit 035c6fd

Browse files
committed
update documentation
1 parent 5eb151f commit 035c6fd

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

tools/json_generator/output/PowerManager/PowerManager.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,42 @@
135135
}
136136
},
137137
"methods": {
138+
"addPowerModePreChangeClient": {
139+
"summary": "Register a client to engage in power mode state changes.\nAdded client should call either\n - `PowerModePreChangeComplete` API to inform power manager that this client has completed its pre-change operation.\n - Or `DelayPowerModeChangeBy` API to delay the power mode change.\nIf the client does not call `PowerModePreChangeComplete` API, the power mode change will complete\nafter the maximum delay `stateChangeAfter` seconds (as received in `OnPowerModePreChange` event).\n\nIMPORTANT: ** IT'S A BUG IF CLIENT `Unregister` FROM `IModePreChangeNotification` BEFORE DISENGAGING ITSELF **\n always make sure to call `RemovePowerModePreChangeClient` before calling `Unregister` from `IModePreChangeNotification`.",
140+
"params": {
141+
"type": "object",
142+
"properties": {
143+
"clientName": {
144+
"summary": "Name of the client",
145+
"type": "string"
146+
}
147+
},
148+
"required": ["clientName"]
149+
},
150+
"result": {
151+
"type": "object",
152+
"properties": {
153+
"clientId": {
154+
"summary": "Unique identifier for the client to be used while acknowledging the pre-change operation (`PowerModePreChangeComplete`) or to delay the power mode change (`DelayPowerModeChangeBy`)",
155+
"type": "integer"
156+
}
157+
},
158+
"required": ["clientId"]
159+
}
160+
},
161+
"removePowerModePreChangeClient": {
162+
"summary": "Removes a registered client from participating in power mode pre-change operations.\nNOTE client will still continue to receive pre-change notifications.",
163+
"params": {
164+
"type": "object",
165+
"properties": {
166+
"clientId": {
167+
"summary": "Unique identifier for the client. See `AddPowerModePreChangeClient`",
168+
"type": "integer"
169+
}
170+
},
171+
"required": ["clientId"]
172+
}
173+
},
138174
"getOvertempGraceInterval": {
139175
"summary": "Returns the over-temperature grace interval value. Not supported on all devices.",
140176
"result": {

0 commit comments

Comments
 (0)