Linking Command Reference

The following are commands you can use when linking. The bolded word is what you would see in a dropdown for Linking. The command is what you would use if doing inline linking in labels or when doing linking in a Picker item. If the command ends in a colon then parameters are needed as well.

Goto
goto:
Description: Goto an item with an ID.

Goto Unchecked
gotoUnchecked:
Description: Goto the first unchecked item with an ID.

Goto (New Session)
newSessionAndGoto:
Description: This creates a new session for the checklist and then does a goto to the item.

Goto (Reset Items In Range)
resetRangeAndGoto:
Description: Goto an item and reset all the items in between the one you are currently on. The item you are jumping to should typically be before the item you are jumping from. An example of its usage would be to reset all the items from takeoff to landing after a touch-and-go.

Goto (Check Items In Range)
checkRangeAndGoto:
Description: Goto an item and check all the items in between the one you are currently on. The item you are jumping to should typically be after the item you are jumping from.

Goto and Return
gotoAndReturn:
Description: Goto an item with an ID. This also presents a Go Back button after navigation so that you can return to where you jumped from.

Goto Unchecked and Return
gotoUncheckedAndReturn:
Description: Goto the first unchecked item with an ID. This also presents a Go Back button after navigation so that you can return to where you jumped from.

Goto and Return (New Session)
newSessionAndGotoAndReturn:
Description: This creates a new session for the checklist and then does a goto to the item. This also presents a Go Back button after navigation so that you can return to where you jumped from.

Goto and Open Birdseye View
gotoAndOpenBirdseyeView:
Description: Goto an item with an ID and switch to Birdseye View.

Reset Current Checklist
resetCurrentChecklist
Description: Resets the current Checklist. This gives you a new session of the Checklist which effectively clears all items to their default state.

Reset Current List
resetCurrentList
Description: Resets the current List. This clears all items to their default state in the current List.

Reset Current Section
resetCurrentSection
Description: Resets the current Section. This clears all items to their default state in the current Section.

Open Comments
openComments
Description: Opens the Comments view. The Comments view allows detailed rich text content to be added for each item.

Open Notes
openNotes
Description: Opens the Notes view. Each item allows user notes to be added.

Open Sketchpad
openSketchpad
Description: Opens the Sketchpad view. Each item allows a sketchpad.

External
external:
Description: Opens and external URL. This allows you to launch content from any URL on the web. You can also utilize URL’s the mobile device supports.


The commands above that end with a colon have parameters. You are basically creating a Link URL. There are currently three different Link URL’s depending on if linking to an external checklist or linking within a checklist to an item.

Link to an internal item in the checklist
{command}:#{internalLinkId}

Example
goto:#takeoff

Link to an external checklist
{command}:{externalChecklistId}

Example
newSessionAndGotoAndReturn:preflight-checklist

Deep link to an external checklist and then an internal item in the checklist
{command}:{externalChecklistId};#{internalLinkId}

Example
newSessionAndGotoAndReturn:reference-checklist;#speeds

Is there a Return function, or is the Return alway a manual action?