Search Results for

    Show / Hide Table of Contents

    Class LanguageCloudIdentityApi

    Singleton implementation that provides LanguageCloud Identity access.

    Inheritance
    object
    LanguageCloudIdentityApi
    Implements
    ILanguageCloudIdentityApi
    Inherited Members
    object.GetType()
    object.MemberwiseClone()
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    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
    string

    ActiveAccountId

    Declaration
    [Obsolete("No longer available")]
    public string ActiveAccountId { get; }
    Property Value
    Type Description
    string

    ActiveTenantId

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

    ActiveUserId

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

    BaseUrl

    Declaration
    public string BaseUrl { get; }
    Property Value
    Type Description
    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
    string

    StudioClientId

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

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

    Methods

    EnsureValidConnection()

    Declaration
    public void EnsureValidConnection()

    LoginWithToken(LoginData)

    Declaration
    public bool LoginWithToken(LoginData loginData)
    Parameters
    Type Name Description
    LoginData loginData
    Returns
    Type Description
    bool

    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
    bool

    True if logout succeeded. False if logout failed

    TryLogin(out string, bool)

    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
    string errorMessage

    A string containing an error message if the login failed.

    bool showLoginDialog

    Optional parameter that specifies if the Studio dialog for Login should be displayed.

    Returns
    Type Description
    bool

    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
    EventHandler

    Implements

    ILanguageCloudIdentityApi

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(object, Action<Window>)
    In this article
    • Properties
      • AccessToken
      • ActiveAccountId
      • ActiveTenantId
      • ActiveUserId
      • BaseUrl
      • Instance
      • LanguageCloudCredential
      • StudioApplicationKey
      • StudioClientId
    • Methods
      • EnsureValidConnection()
      • LoginWithToken(LoginData)
      • Logout()
      • TryLogin(out string, bool)
    • Events
      • LoginStatusChanged
    • Implements
    • Extension Methods
    Back to top Generated by DocFX