Class LanguageCloudIdentityApi

Singleton implementation that provides LanguageCloud Identity access.

Inheritance
System.Object
LanguageCloudIdentityApi
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.LanguageCloud.IdentityApi
Assembly: Sdl.LanguageCloud.IdentityApi.dll
Syntax
public class LanguageCloudIdentityApi : ILanguageCloudIdentityApi

Properties

AccessToken

Declaration
public string AccessToken { get; }
Property Value
Type Description
System.String

ActiveAccountId

Declaration
public string ActiveAccountId { get; }
Property Value
Type Description
System.String

ActiveTenantId

Declaration
public string ActiveTenantId { get; }
Property Value
Type Description
System.String

ActiveUserId

Declaration
public string ActiveUserId { get; }
Property Value
Type Description
System.String

ApiKey

The ApiKey stored for LanguageCloud authentication. Returns an empty string if no ApiKey is present.

Declaration
public string ApiKey { get; }
Property Value
Type Description
System.String

BaseUrl

Declaration
public string BaseUrl { get; }
Property Value
Type Description
System.String

Instance

Singleton instance

Declaration
public static ILanguageCloudIdentityApi Instance { get; }
Property Value
Type Description
ILanguageCloudIdentityApi

LanguageCloudCredential

Access to information about the LanguageCloud credential in use.

Declaration
public LanguageCloudCredentialInfo LanguageCloudCredential { get; }
Property Value
Type Description
LanguageCloudCredentialInfo

StudioApplicationKey

The key used for identifying calls made from Trados Studio.

Declaration
public string StudioApplicationKey { get; }
Property Value
Type Description
System.String

StudioClientId

The key used for identifying login calls made from Trados Studio.

Declaration
public string StudioClientId { get; }
Property Value
Type Description
System.String

Methods

EnsureValidConnection()

Declaration
public void EnsureValidConnection()

Logout()

Logout from LanguageCloud and clear any credentials stored in memory. Returns a bool value representing the success or failure of the logout operation.

Declaration
public bool Logout()
Returns
Type Description
System.Boolean

True if logout succeeded. False if logout failed

TryLogin(out String, Boolean)

Login to LanguageCloud using the credentials stored in memory or provided through the Login dialog. Returns a bool value representing the success or failure of the login operation.

Declaration
public bool TryLogin(out string errorMessage, bool showLoginDialog = true)
Parameters
Type Name Description
System.String errorMessage

A string containing an error message if the login failed.

System.Boolean showLoginDialog

Optional parameter that specifies if the Studio dialog for Login should be displayed.
Returns
Type Description
System.Boolean

True if login succeeded. False if login failed

Events

LoginStatusChanged

Raised when login, logout or switch account actions occur.

Declaration
public event EventHandler LoginStatusChanged
Event Type
Type Description
System.EventHandler

Implements

Extension Methods