Classe ProtectionEngine:: Settingsclass ProtectionEngine::Settings

  • 3 minuti per la lettura

Oggetto Settings usato da ProtectionEngine durante la creazione e per tutta la sua durata.Settings used by ProtectionEngine during its creation and throughout its lifetime.

RiepilogoSummary

MembersMembers DescrizioniDescriptions
Impostazioni pubbliche (const Identity& Identity, const std:: shared_ptr <AuthDelegate>& authDelegate, const std:: string& clientData, const std:: string& locale)public Settings(const Identity& identity, const std::shared_ptr<AuthDelegate>& authDelegate, const std::string& clientData, const std::string& locale) Costruttore ProtectionEngine::Settings per la creazione di un nuovo motore.ProtectionEngine::Settings constructor for creating a new engine.
Impostazioni pubbliche (const std:: String& engineId, const std:: shared_ptr <AuthDelegate>& authDelegate, const std:: string& clientData, const std:: string& locale)public Settings(const std::string& engineId, const std::shared_ptr<AuthDelegate>& authDelegate, const std::string& clientData, const std::string& locale) Costruttore ProtectionEngine::Settings per il caricamento di un motore esistente.ProtectionEngine::Settings constructor for loading an existing engine.
public const std::string& GetEngineId() constpublic const std::string& GetEngineId() const Ottiene l'ID motore.Gets the engine ID.
public void SetEngineId(const std::string& engineId)public void SetEngineId(const std::string& engineId) Imposta l'ID motore.Sets the engine ID.
public const Identity& GetIdentity() constpublic const Identity& GetIdentity() const Ottiene l'identità utente associata al motore.Gets the user Identity associated with the engine.
public void SetIdentity(const Identity& identity)public void SetIdentity(const Identity& identity) Imposta l'identità utente associata al motore.Sets the user Identity associated with the engine.
public const std::string& GetClientData() constpublic const std::string& GetClientData() const Ottiene i dati personalizzati specificati dal client.Gets custom data specified by client.
public void SetClientData(const std::string& clientData)public void SetClientData(const std::string& clientData) Imposta i dati personalizzati specificati dal client.Sets custom data specified by client.
public const std::string& GetLocale() constpublic const std::string& GetLocale() const Ottiene le impostazioni locali in cui verranno scritti i dati del motore.Gets the locale in which engine data will be written.
public void SetCustomSettings (const std:: Vector <std::pair<std::string, std::string> >& valore)public void SetCustomSettings(const std::vector<std::pair<std::string, std::string>>& value) Imposta coppie nome-valore usate a scopi di test e sperimentazione.Sets name/value pairs used for testing and experimentation.
public const std:: Vector <std::pair<std::string, std::string> >& GetCustomSettings () constpublic const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const Ottiene coppie nome-valore usate a scopi di test e sperimentazione.Gets name/value pairs used for testing and experimentation.
public void SetSessionId(const std::string& sessionId)public void SetSessionId(const std::string& sessionId) Imposta l'ID sessione del motore, usato per la correlazione di registrazione/telemetria.Sets the engine session ID, used for correlation of logging/telemetry.
public const std::string& GetSessionId() constpublic const std::string& GetSessionId() const Ottiene l'ID sessione del motore.Gets the engine session ID.
void public void (Cloud Cloud)public void SetCloud(Cloud cloud) Imposta facoltativamente il cloud di destinazione.Optionally sets the target cloud.
Cloud pubblico getcloud () constpublic Cloud GetCloud() const Ottiene il cloud di destinazione utilizzato da tutte le richieste di servizio.Gets the target cloud used by all service requests.
public void SetCloudEndpointBaseUrl(const std::string& cloudEndpointBaseUrl)public void SetCloudEndpointBaseUrl(const std::string& cloudEndpointBaseUrl) Imposta l'URL di base dell'endpoint cloud per il cloud personalizzato.Sets the cloud endpoint base URL for custom cloud.
public const std::string& GetCloudEndpointBaseUrl() constpublic const std::string& GetCloudEndpointBaseUrl() const Ottiene l'URL di base del cloud usato da tutte le richieste di servizio, se specificato.Gets the cloud base URL used by all service requests, if specified.
public void SetAuthDelegate (const std:: shared_ptr <AuthDelegate>& authDelegate)public void SetAuthDelegate(const std::shared_ptr<AuthDelegate>& authDelegate) Impostare il delegato di autenticazione del motore.Set the Engine Auth Delegate.
public std::shared_ptr<AuthDelegate> GetAuthDelegate() constpublic std::shared_ptr<AuthDelegate> GetAuthDelegate() const Ottiene il delegato di autenticazione del motore.Get the Engine Auth Delegate.
public const std:: String& GetUnderlyingApplicationId () constpublic const std::string& GetUnderlyingApplicationId() const Ottiene l'ID applicazione sottostante.Gets the Underlying Application ID.
public void SetUnderlyingApplicationId (const std:: String& underlyingApplicationId)public void SetUnderlyingApplicationId(const std::string& underlyingApplicationId) Imposta l'ID applicazione sottostante.Sets the Underlying Application ID.

MembersMembers

Funzione SettingsSettings function

Costruttore ProtectionEngine::Settings per la creazione di un nuovo motore.ProtectionEngine::Settings constructor for creating a new engine.

ParametriParameters:

  • identity: identità che verrà associata a ProtectionEngineidentity: Identity that will be associated with ProtectionEngine

  • authDelegate: il delegato di autenticazione usato dall'SDK per acquisire i token di autenticazione, eseguirà l'override di PolicyProfile:: Settings:: authDelegate se entrambi specificatiauthDelegate: The authentication delegate used by the SDK to acquire authentication tokens, will override the PolicyProfile::Settings::authDelegate if both provided

  • clientData: dati client personalizzabili che è possibile archiviare con il motore quando lo si scarica e recuperare da un motore caricato.clientData: customizable client data that can be stored with the engine when unloaded and can be retrieved from a loaded engine.

  • locale: l'output del motore verrà fornito con queste impostazioni locali.locale: Engine output will be provided in this locale.

Funzione SettingsSettings function

Costruttore ProtectionEngine::Settings per il caricamento di un motore esistente.ProtectionEngine::Settings constructor for loading an existing engine.

ParametriParameters:

  • engineId: identificatore univoco del motore che verrà caricatoengineId: Unique identifier of engine that will be loaded

  • authDelegate: il delegato di autenticazione usato dall'SDK per acquisire i token di autenticazione, eseguirà l'override di PolicyProfile:: Settings:: authDelegate se entrambi specificatiauthDelegate: The authentication delegate used by the SDK to acquire authentication tokens, will override the PolicyProfile::Settings::authDelegate if both provided

  • clientData: dati client personalizzabili che è possibile archiviare con il motore quando lo si scarica e recuperare da un motore caricato.clientData: customizable client data that can be stored with the engine when unloaded and can be retrieved from a loaded engine.

  • locale: l'output del motore verrà fornito con queste impostazioni locali.locale: Engine output will be provided in this locale.

GetEngineId (funzione)GetEngineId function

Ottiene l'ID motore.Gets the engine ID.

Restituisce: ID motoreReturns: Engine ID

SetEngineId (funzione)SetEngineId function

Imposta l'ID motore.Sets the engine ID.

ParametriParameters:

  • engineId: ID del motore.engineId: engine ID.

GetIdentity (funzione)GetIdentity function

Ottiene l'identità utente associata al motore.Gets the user Identity associated with the engine.

Restituisce: identità utente associata al motoreReturns: User Identity associated with the engine

Funzione seidentitySetIdentity function

Imposta l'identità utente associata al motore.Sets the user Identity associated with the engine.

ParametriParameters:

  • identity: identità utente associata al motoreidentity: User Identity associated with the engine

GetClientData (funzione)GetClientData function

Ottiene i dati personalizzati specificati dal client.Gets custom data specified by client.

Restituisce: dati personalizzati specificati dal clientReturns: Custom data specified by client

SetClientData (funzione)SetClientData function

Imposta i dati personalizzati specificati dal client.Sets custom data specified by client.

ParametriParameters:

  • Custom: dati specificati dal clientCustom: data specified by client

GetLocale (funzione)GetLocale function

Ottiene le impostazioni locali in cui verranno scritti i dati del motore.Gets the locale in which engine data will be written.

Restituisce: impostazioni locali in cui verranno scritti i dati del motoreReturns: Locale in which engine data will be written

SetCustomSettings (funzione)SetCustomSettings function

Imposta coppie nome-valore usate a scopi di test e sperimentazione.Sets name/value pairs used for testing and experimentation.

ParametriParameters:

  • customSettings: coppie nome-valore usate a scopi di test e sperimentazionecustomSettings: Name/value pairs used for testing and experimentation

GetCustomSettings (funzione)GetCustomSettings function

Ottiene coppie nome-valore usate a scopi di test e sperimentazione.Gets name/value pairs used for testing and experimentation.

Restituisce: coppie nome-valore usate a scopi di test e sperimentazioneReturns: Name/value pairs used for testing and experimentation

Funzione SessionIdSetSessionId function

Imposta l'ID sessione del motore, usato per la correlazione di registrazione/telemetria.Sets the engine session ID, used for correlation of logging/telemetry.

ParametriParameters:

  • SessionID: ID sessione del motore, usato per la correlazione di registrazione/telemetriasessionId: Engine session ID, used for correlation of logging/telemetry

Funzione GetSessionIDGetSessionId function

Ottiene l'ID sessione del motore.Gets the engine session ID.

Restituisce: ID sessione motoreReturns: Engine session ID

Funzione secloudSetCloud function

Imposta facoltativamente il cloud di destinazione.Optionally sets the target cloud.

ParametriParameters:

  • Cloud: cloudCloud: Cloud

Se il cloud non è specificato, sarà determinato dalla ricerca DNS del dominio di identità del motore, se possibile, in caso contrario, il fallback al cloud globale.If cloud is not specified, then it will be determined by DNS lookup of the engine's identity domain if possible, else fall back to global cloud.

Funzione getcloudGetCloud function

Ottiene il cloud di destinazione utilizzato da tutte le richieste di servizio.Gets the target cloud used by all service requests.

Restituisce: cloudReturns: Cloud

SetCloudEndpointBaseUrl (funzione)SetCloudEndpointBaseUrl function

Imposta l'URL di base dell'endpoint cloud per il cloud personalizzato.Sets the cloud endpoint base URL for custom cloud.

ParametriParameters:

  • cloudEndpointBaseUrl: URL di base usato da tutte le richieste di servizio (ad esempio, "https://api.aadrm.com")cloudEndpointBaseUrl: the base URL used by all service requests (for example, "https://api.aadrm.com")

Questo valore verrà letto e deve essere impostato solo per cloud = CustomThis value will only be read and must be set for Cloud = Custom

GetCloudEndpointBaseUrl (funzione)GetCloudEndpointBaseUrl function

Ottiene l'URL di base del cloud usato da tutte le richieste di servizio, se specificato.Gets the cloud base URL used by all service requests, if specified.

Restituisce: URL di baseReturns: Base URL

SetAuthDelegate (funzione)SetAuthDelegate function

Impostare il delegato di autenticazione del motore.Set the Engine Auth Delegate.

ParametriParameters:

  • authDelegate: delegato di autenticazioneauthDelegate: the Auth delegate

GetAuthDelegate (funzione)GetAuthDelegate function

Ottiene il delegato di autenticazione del motore.Get the Engine Auth Delegate.

Restituisce: delegato di autenticazione del motore.Returns: The Engine Auth Delegate.

GetUnderlyingApplicationId (funzione)GetUnderlyingApplicationId function

Ottiene l'ID applicazione sottostante.Gets the Underlying Application ID.

Restituisce: ID applicazione sottostanteReturns: Underlying Application ID

SetUnderlyingApplicationId (funzione)SetUnderlyingApplicationId function

Imposta l'ID applicazione sottostante.Sets the Underlying Application ID.

ParametriParameters:

  • UnderlyingApplicationId: ID applicazione sottostante.UnderlyingApplicationId: Underlying Application ID.