OptionsFactoryCreateOauth(String, String, String, String, String, IAddressSettings, IDomElement, NullableBoolean, NullableBoolean) Method

Create the options object which used for initializing the API for use oAuth authorization

Definition

Namespace: StreetSmart.Common.Factories
Assemblies:  StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 25.7.0.0+8d57adf8e9b2f0e8b292285b4ebbbdc257654fdc
  StreetSmart.WPF (in StreetSmart.WPF.dll) Version: 25.7.0.0+8d57adf8e9b2f0e8b292285b4ebbbdc257654fdc
C#
public static IOptions CreateOauth(
	string userName,
	string clientId,
	string apiKey,
	string srs,
	string locale,
	IAddressSettings addressSettings,
	IDomElement element,
	bool? loginOauthSilentOnly = null,
	bool? doOAuthLogoutOnDestroy = null
)

Parameters

userName  String
Username of the user.
clientId  String
The clientId of the OAuth user.
apiKey  String
ApiKey given to the user.
srs  String
Coordinate system used in the API. E.g. "EPSG:29882".
locale  String
Language used as default in the API.
addressSettings  IAddressSettings
The address settings to use for address searches.
element  IDomElement
The Domelement where in the panoramic image is rendered.
loginOauthSilentOnly  NullableBoolean  (Optional)
Indicates to login with OAuth with silent authentication only. true means using silent authentication only. false means use silent authentication together with login popup authentication if silent authentication fails (for example when user session expired). This parameter is optional and false is default.
doOAuthLogoutOnDestroy  NullableBoolean  (Optional)
Indicates whether to log out via oauth on destroy

Return Value

IOptions
Object containing the options used for initializing the API

Version Information

Supported in: 18.7

See Also