Document driverActionNecessary callback parameters#15
Open
pnc wants to merge 1 commit intoGeotab:drive-api-extensionsfrom
Open
Document driverActionNecessary callback parameters#15pnc wants to merge 1 commit intoGeotab:drive-api-extensionsfrom
pnc wants to merge 1 commit intoGeotab:drive-api-extensionsfrom
Conversation
This is a partial change, since it's not clear to me what the `boolean` parameter indicates. For instance, if you change your vehicle, the function is called with `false, "Workflow"`. What does the boolean parameter mean?
Contributor
|
@pnc still in dev. first parameter represents whether driver action is necessary (true for action started, false for action complete). might switch it to two different event functions with a single 'action type' parameter that is being started / completed. |
Author
|
@colonelchlorine This shipped in 1804 and we're now relying on it in production code, based on Vik Sridhar's guidance, so this needs to stay stable. What's the second parameter? |
Contributor
|
This is not in full release. You're doing a PR on a branch. Proceed with caution in production. A string which represents the area of the application (e.g. "workflow" or "login") |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a partial change, since it's not clear to me what the
booleanparameter indicates.For instance, if you change your vehicle, the function is called with
false, "Workflow". What does the boolean parameter mean?