Windows Request Schemas

TMM supports several windows request schemas you can use to configure and control the program.

A schema may trigger TMM to show user interface, or it may do a configuration action in the background.

A schema may return information to the calling program, or it may simply perform the requested action without any return.

TMM request schemas can be invoked with:

trimblemobilemanager://request/urlschemaname

Windows Requests

tmmRegister

Summary

Register client application

Remarks

Retrieves the port information for the API server, LocalHost server, and LocalHost server V2. The port information includes the API port, location port, location secure port, and location V2 port.

Input

• applicationId (string): The client application ID
• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmRegister&status={status}&message={message}&registrationResult={registrationResult}&apiPort={apiPort}&locationV2Port={locationV2Port}

• id (String): tmmRegister
• status (String): “success” or “error”
• message (String): Additionall information
• registrationResult (String): Indicates the result of the registration check. This can be “OK”, “NoNetwork”, or “Unauthorized”
• apiPort (Int): The port number for the API.
• locationV2Port (Int): The V2 port number for the location.

tmmOpenToSkyplot

Summary

Open the Skyplot page.

Remarks

Navigates TMM to the Skyplot page.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOpenToSkyplot&status={status}&message={message}

• id (String): tmmOpenToSkyplot
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToConfiguration

Summary

Open the Configuration page.

Remarks

Navigates TMM to the Configuration page.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOpenToConfiguration&status={status}&message={message}

• id (String): tmmOpenToConfiguration
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToAntennaHeight

Summary

Open the Antenna Height page.

Remarks

Navigates TMM to the Antenna Height page.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOpenToAntennaHeight&status={status}&message={message}

• id (String): tmmOpenToAntennaHeight
• status (String): “success” or “error”
• message (String): Additionall information

tmmCorrectionSettings

Summary

Open the Configuration page.

Remarks

Navigates TMM to the configuration page to edit the correction settings.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmCorrectionSettings&status={status}&message={message}

• id (String): tmmCorrectionSettings
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToReceiverSelection

Summary

Open the receiver selection page

Remarks

Opens TMM to the receiver selection popup.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOpenToReceiverSelection&status={status}&message={message}

• id (String): tmmOpenToReceiverSelection
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToLoginPage

Summary

Open the login page

Remarks

Initiates the process of navigating to the login page in the TMM application.

Input

• applicationId (string): The client application ID.
• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOpenToLoginPage&status={status}&message={message}&userTID={userTID}&tpsdkVersion={tpsdkVersion}

• id (String): tmmOpenToLoginPage
• status (String): “success” or “error”
• message (String): Additionall information
• userTID (String): The user’s TID.
• tpsdkVersion (String): The TPSDK version.

tmmOnDemand

Summary

Open to the On Demand page

Remarks

Opens TMM to the receiver selection popup.

Input

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Output

{callback}?id=tmmOnDemand&status={status}&message={message}&currentClaim={currentClaim}&claimCountdown={claimCountdown}

• id (String): tmmOnDemand
• status (String): “success” or “error”
• message (String): Additionall information
• currentClaim (String): The current claim in the process.
• claimCountdown (String): The countdown for the claim.