Developer Documentation

iOS URL Schemas

Using URL schemas to control TMM

TMM supports several iOS URL 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 URL schemas can be invoked with:

schemaname://trimble.tmm.iOS

iOS URL Schemas

tmmlogin

Summary

Client application login

Remarks

Trimble Mobile Manager provides an URL interface so third party applications can log-in to Trimble ID (TID) via TMM. This allows an easy integration without going into implementation details of OAuth which is used in TID.

Input

  • application_id (string): The application ID.
  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • UserTID (String): The user’s TID.
  • DeviceID (String): The device ID.
  • TPSDKVersion (String): The TPSDK version.

tmmconnect

Summary

Client application login

Remarks

Trimble Mobile Manager provides an URL interface so third party applications can log-in to Trimble ID (TID) via TMM. This allows an easy integration without going into implementation details of OAuth which is used in TID.

Input

  • application_id (string): The application ID.
  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • UserTID (String): The user’s TID.
  • DeviceID (String): The device ID.
  • TPSDKVersion (String): The TPSDK version.

tmmcorrectionsettings

Summary

Open the Configuration page.

Remarks

This method is triggered by the tmmcorrectionsettings URL scheme. Navigates TMM to the configuration page to edit the correction settings.

Returns

None

tmmrefreshusertoken

Summary

Refresh the user token.

Remarks

This method is triggered by the tmmrefreshusertoken URL scheme. It initiates the process of refreshing the user token in the TMM application.

Input

  • application_id (string): The ID of the application requesting the user token refresh.
  • returl (string): The URL to which the application will return after the user token refresh process is complete.

Output

A json object as a string. Where result is: 4 - “Refresh succeeded.”: Indicates that the user token refresh was successful. 2 - “Refresh not needed now.”: Indicates that the user token is already up-to-date and no refresh is necessary at this time. 0 - “Refresh failed.”: Indicates that the user token refresh failed due to an unspecified error. 3 - “Refresh failed.”: Indicates that the user token refresh failed due to an expired refresh token. 1 - “No RefreshToken.”: Indicates that the user is not logged in and therefore no refresh token is available.

  • result (int): The result of the user token refresh operation.
  • message (String): Additional information or details about the result of the user token refresh operation.

tmmsocketserverport

Summary

Query the list of TMM server ports

Remarks

This method is triggered by the tmmsocketserverport URL scheme. It 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

  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • port (Int): The port number for the location.
  • apiPort (Int): The port number for the API.
  • locationPort (Int): The port number for the location.
  • locationSecurePort (Int): The secure port number for the location.
  • locationV2Port (Int): The V2 port number for the location.

tmmpseudosecuresocketserver

Summary

Request to start the pseudo-secure socket server.

Remarks

This method is triggered by the tmmpseudosecuresocketserver URL scheme. It initiates the process of starting the pseudo-secure socket server in the TMM application.

Input

  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • port (Int): The secure port number for the location.
  • apiPort (Int): The port number for the API.
  • locationPort (Int): The port number for the location.
  • locationSecurePort (Int): The secure port number for the location.
  • locationV2Port (Int): The V2 port number for the location.

tmmondemand

Summary

Open to the On Demand page

Remarks

This method is triggered by the tmmondemand URL scheme. It retrieves the current claim and the remaining session time from the licensing container.

Input

  • application_id (string): The ID of the application.
  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • currentClaim (String): The current claim in the process.
  • claimCountdown (String): The countdown for the claim.

tmm

Summary

Ping the application

Remarks

This method is triggered by the tmm URL scheme. It initiates a ping to the TMM application to check its availability.

Returns

This method returns a boolean indicating whether the ping was successful.

tmmfilelocations

Summary

Query file locations

Remarks

This method is triggered by the tmmfilelocations URL scheme. It retrieves the base location, correction settings path, and license report path from the platform details.

Input

  • returl (string): The return URL TMM will open after completion of this operation.

Output

A json object as a string.

  • baseLocation (String): The base location for the operation.
  • correctionSettings (String): The settings for the correction process.
  • licenseReport (String): The report of the license status.

TmmOpenToSkyplot

Summary

Open the Skyplot page.

Remarks

This method is triggered by the TmmOpenToSkyplot URL scheme. Navigates TMM to the Skyplot page.

Returns

None

tmmopentoconfiguration

Summary

Open the Configuration page.

Remarks

This method is triggered by the tmmopentoconfiguration URL scheme. Navigates TMM to the Configuration page.

Returns

None

TmmOpenToAntennaHeight

Summary

Open the Antenna Height page.

Remarks

This method is triggered by the TmmOpenToAntennaHeight URL scheme. Navigates TMM to the Antenna Height page.

Returns

None

tmmopentologinpage

Summary

Open the login page

Remarks

This method is triggered by the tmmopentologinpage URL scheme. It initiates the process of navigating to the login page in the TMM application.

Input

  • application_id (string): The ID of the application.
  • returl (string): The return URL TMM will open after completion of this operation.

Returns

None

tmmopentoreceiverselection

Summary

Open the receiver selection page

Remarks

This method is triggered by the tmmopentoreceiverselection URL scheme. Opens TMM to the receiver selection popup.

Returns

None

tmmregister

Summary

Register client application

Remarks

This method is triggered by the tmmregister URL scheme. It 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

  • application_id (string): The ID of the application requesting the socket server port information.
  • returl (string): The URL to which the application will return after the socket server port information is retrieved.

Output

A json object as a string.

  • registrationResult (String): Indicates the result of the registration check. This can be “OK”, “NoNetwork”, or “Unauthorized”
  • apiPort (Int): The port number for the API.
  • locationPort (Int): The port number for the location.
  • locationSecurePort (Int): The secure port number for the location.
  • locationV2Port (Int): The V2 port number for the location.

Copyright © 2024, Trimble Inc.