ReferenceDoc.md

Trimble.ID.Desktop

Contents

• BrowserPreferences
  • Height
  • NewWindow
  • Width
  • X
  • Y
• CustomUrlAuthenticator
  • #ctor(tokenProvider,productName)
  • Login(silent,timeoutInMs)
  • WithBrowserPreferences(preferences)
• LocalhostAuthenticator
  • #ctor(endpointProvider,consumerKey,scopes,productName)
  • IsLoggedIn
  • LegacyTokenProvider
  • TokenProvider
  • Dispose()
  • Dispose(disposing)
  • GetUserInfo()
  • LoadCachedLogin()
  • Login(silent,timeoutInMs,cancellationToken)
  • Logout(singleSignOut,cancellationToken)
  • WithBrowserPreferences(preferences)
  • WithFixedPort(port)
  • WithLoopbackAddress(address)
  • WithPersistentStorage(persistentStorage)
• LocalhostListener
  • #ctor(address)
  • ANY_PORT
  • LOOPBACK_ADDRESS
  • Address
  • Port
  • Dispose()
  • Dispose(disposing)
  • Start(port)
• TokenProviderWrapper
  • RetrieveToken()
  • RetrieveTokenAsync(cancellationToken)

BrowserPreferences type

Namespace

Trimble.ID.Desktop

Height property

NewWindow property

Width property

X property

Y property

CustomUrlAuthenticator type

Namespace

Trimble.ID.Desktop

#ctor(tokenProvider,productName) constructor

Summary

Public constructor for CustomUrlAuthenticator class

Parameters

Name	Type	Description
tokenProvider	Trimble.ID.AuthorizationCodeGrantTokenProvider	An authorization Grant token provider object
productName	System.String	The product name of the consuming application (optional).

Login(silent,timeoutInMs) method

Summary

Log the user in

Returns

true if the user was successfully logged in

Parameters

Name	Type	Description
silent	System.Boolean	true if no UI should be shown i.e. prompt=none
timeoutInMs	System.Int32	Specify the length of time that client waits for a login response when making a login attempt. The default timeout value is 3 minutes.

Exceptions

Name	Description
System.TimeoutException	Login operation has timed out after waiting for specified time.

WithBrowserPreferences(preferences) method

Summary

Fluent method to specify browser preferences

Parameters

Name	Type	Description
preferences	Trimble.ID.Desktop.BrowserPreferences	The browser preferences

LocalhostAuthenticator type

Namespace

Trimble.ID.Desktop

Summary

An authenticator that utilizes a localhost callback

Example

const string CONFIGURATION_ENDPOINT = "https://id.trimble.com/.well-known/openid-configuration";
const string CONSUMER_KEY = "APPLICATION_CONSUMER_KEY";
var string SCOPES = new [] { "CSharpSDKTesting" };
IEndpointProvider endpointProvider = new OpenIdEndpointProvider(new Uri(CONFIGURATION_URL, UriKind.Absolute));
IAuthenticator authenticator = new LocalhostAuthenticator(endpointProvider, CONSUMER_KEY, SCOPES);
if (await authenticator.Login())
{
    var userInfo = await authenticator.GetUserInfo();
    var token = await authenticator.TokenProvider.RetrieveToken();
}
await authenticator.Logout(singleSignOut: true);
authenticator.Dispose();

Remarks

Implements IAuthenticator

#ctor(endpointProvider,consumerKey,scopes,productName) constructor

Summary

Public constructor for LocalhostAuthenticator class

Parameters

Name	Type	Description
endpointProvider	Trimble.ID.IEndpointProvider	An endpoint provider that provides the URL for the Trimble Identity authorization and token endpoints
consumerKey	System.String	The consumer key for the calling application
scopes	System.String[]	The scopes used in the authorization request, openid is specified by default
productName	System.String	The product name of the consuming application (optional).

IsLoggedIn property

Summary

Get the logged in state

LegacyTokenProvider property

Summary

Get the token provider for this authenticator

Remarks

This token provider can be used with other SDK components

TokenProvider property

Summary

Get the token provider for this authenticator

Remarks

This token provider can be used with other SDK components

Dispose() method

Summary

Dispose method for LocalhostAuthenticator class

Parameters

This method has no parameters.

Dispose(disposing) method

Summary

Dispose of instance

Parameters

Name	Type	Description
disposing	System.Boolean	True if disposing

GetUserInfo() method

Summary

Validates the ID token and returns user claims

Returns

User claims from the ID token

Parameters

This method has no parameters.

LoadCachedLogin() method

Summary

Initialize the authenticator with a stored refresh token

Returns

true if the authenticator was initialzed with an existing refresh token

Parameters

This method has no parameters.

Login(silent,timeoutInMs,cancellationToken) method

Summary

Log the user in

Returns

true if the user was successfully logged in

Parameters

Name	Type	Description
silent	System.Boolean	true if no UI should be shown i.e. prompt=none
timeoutInMs	System.Int32	Specify the length of time that client waits for a login response when making a login attempt. The default timeout value is 3 minutes.
cancellationToken	System.Threading.CancellationToken	The optional cancellation token.

Exceptions

Name	Description
System.TimeoutException	Login operation has timed out after waiting for specified time.
System.Threading.Tasks.TaskCanceledException	Task is canceled when cancellation token is requested and the operation might takes longer time to respond

Remarks

Only one login or logout operation is permitted at a time, all previously started operations will return false

Logout(singleSignOut,cancellationToken) method

Summary

Log the user out

Returns

true if the user was successfully logged out

Parameters

Name	Type	Description
singleSignOut	System.Boolean	true if the single sign in session should be terminated
cancellationToken	System.Threading.CancellationToken	The optional cancellation token.

Exceptions

Name	Description
System.Threading.Tasks.TaskCanceledException	Task is canceled when cancellation token is requested and the operation might takes longer time to respond

Remarks

Only one login or logout operation is permitted at a time, all previously started operations will return false

WithBrowserPreferences(preferences) method

Summary

Fluent method to specify browser preferences

Parameters

Name	Type	Description
preferences	Trimble.ID.Desktop.BrowserPreferences	The browser preferences

WithFixedPort(port) method

Summary

Fluent method to specify a fixed port

Parameters

Name	Type	Description
port	System.Int32	The fixed port to use for the localhost listener

WithLoopbackAddress(address) method

Summary

Fluent method to specify an alternative host

Parameters

Name	Type	Description
address	System.String	The alternative host to use for the localhost listener

WithPersistentStorage(persistentStorage) method

Summary

Fluent method to specify persistent storage option. This initializes to load cached login first if present

Parameters

Name	Type	Description
persistentStorage	Trimble.ID.IPersistantStorage	The persistent storage for refresh tokens

LocalhostListener type

Namespace

Trimble.ID.Desktop

#ctor(address) constructor

Summary

Constructor for localhost listener

Parameters

Name	Type	Description
address	System.String	The host address to listen on, default 127.0.0.1

ANY_PORT constants

LOOPBACK_ADDRESS constants

Address property

Port property

Dispose() method

Summary

Dispose method for LocalhostListener class

Parameters

This method has no parameters.

Dispose(disposing) method

Summary

Frees the resources used by the LocalhostListener object.

Parameters

Name	Type	Description
disposing	System.Boolean	A boolean value indicating whether the method is being called

Start(port) method

Summary

Start a listener on the specified port

Returns

true on success

Parameters

Name	Type	Description
port	System.Int32	The port to start the listener on, or ANY_PORT

TokenProviderWrapper type

Namespace

Trimble.ID.Desktop.LocalhostAuthenticator

RetrieveToken() method

Summary

Retrieves the access token.

Returns

The access token.

Parameters

This method has no parameters.

RetrieveTokenAsync(cancellationToken) method

Summary

Retrieves the access token.

Returns

An AccessToken which can be used to authenticate service client calls.

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A CancellationToken controlling the request lifetime.