classe PolicyEngine:: Settingsclass PolicyEngine::Settings

• 01/13/2021
• 5 minuti per la lettura
• • B
  • o

Definisce le impostazioni associate a un oggetto PolicyEngine.Defines the settings associated with a PolicyEngine.

RiepilogoSummary

MembriMembers

Funzione SettingsSettings function

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

ParametriParameters:

• engineId: imposta l'ID del motore univoco generato da AddEngineAsync o da un oggetto generato automaticamente.engineId: Set it to the unique engine ID generated by AddEngineAsync or one self-generated. Quando si carica un motore esistente, usare nuovamente l'ID. In caso contrario verrà creato un nuovo motore.When loading an existing engine, reuse the ID else a new engine will be created.

• 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, can be retrieved from a loaded engine.

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

• Facoltativo: il flag che indica quando il motore è caricato deve caricare anche tipi di riservatezza personalizzati, se il true OnPolicyChange Observer nel profilo verrà richiamato sugli aggiornamenti ai tipi di riservatezza personalizzati e sulle modifiche dei criteri.Optional: flag indicating when the engine is loaded should load also custom sensitivity types, if true OnPolicyChange Observer on the profile will be invoked on updates to custom sensitivity types as well as policy changes. Se la chiamata a false ListSensitivityTypes restituirà sempre un elenco vuoto.if false ListSensitivityTypes call will always return an empty list.

Funzione SettingsSettings function

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

ParametriParameters:

• identity: informazioni di identità relative all'utente associato al nuovo motore.identity: Identity info of the user associated with the new engine.

• 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, can be retrieved from a loaded engine.

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

• Facoltativo: il flag che indica quando il motore è caricato deve caricare anche tipi di riservatezza personalizzati, se il true OnPolicyChange Observer nel profilo verrà richiamato sugli aggiornamenti ai tipi di riservatezza personalizzati e sulle modifiche dei criteri.Optional: flag indicating when the engine is loaded should load also custom sensitivity types, if true OnPolicyChange Observer on the profile will be invoked on updates to custom sensitivity types as well as policy changes. Se la chiamata a false ListSensitivityTypes restituirà sempre un elenco vuoto.if false ListSensitivityTypes call will always return an empty list.

GetEngineId (funzione)GetEngineId function

Ottiene l'ID del motore.Get the engine ID.

Restituisce: stringa univoca che identifica il motore.Returns: A unique string identifying the engine.

SetEngineId (funzione)SetEngineId function

Imposta l'ID del motore.Set the engine ID.

ParametriParameters:

• ID: ID del motore.id: engine ID.

GetIdentity (funzione)GetIdentity function

Ottiene l'oggetto Identity.Get the Identity object.

Restituisce: riferimento all'identità nell'oggetto Settings.Returns: A reference to the identity in the settings object.

Vedere anche: mip::IdentitySee also: mip::Identity

Funzione seidentitySetIdentity function

Imposta l'oggetto Identity.Set the Identity object.

ParametriParameters:

• Identity: identità univoca di un utente.identity: the unique identity of a user.

Vedere anche: mip::IdentitySee also: mip::Identity

GetClientData (funzione)GetClientData function

Ottiene il set di dati client configurato nelle impostazioni.Get the Client Data set in the settings.

Restituisce: stringa di dati specificata dal client.Returns: A string of data specified by the client.

SetClientData (funzione)SetClientData function

Imposta la stringa di dati client.Set the Client Data string.

ParametriParameters:

• clientData: dati specificati dall'utente.clientData: user specified data.

GetLocale (funzione)GetLocale function

Ottiene le impostazioni locali configurate nelle impostazioni.Get the Locale set in the settings.

Restituisce: impostazioni locali.Returns: The locale.

SetCustomSettings (funzione)SetCustomSettings function

Imposta le impostazioni personalizzate, usate a scopi di controllo e test delle funzionalità.Set the custom settings, used for feature gating and testing.

ParametriParameters:

• customSettings: elenco di coppie nome/valore.customSettings: List of name/value pairs.

GetCustomSettings (funzione)GetCustomSettings function

Ottiene le impostazioni personalizzate, usate a scopi di controllo e test delle funzionalità.Get the custom settings, used for feature gating and testing.

Restituisce:: elenco di coppie nome/valore.Returns: List of name/value pairs.

Funzione SessionIdSetSessionId function

Imposta l'ID sessione, usato per la telemetria definita dal client.Set the session ID, used for client defined telemetry.

ParametriParameters:

• SessionID: stringa univoca che connette gli eventi di telemetria.sessionId: a unique string that connects telemetry events.

Funzione GetSessionIDGetSessionId function

Ottiene l'ID sessione, un identificatore univoco.Get the session ID, a unique identifier.

Restituisce: ID sessione.Returns: The session ID.

IsLoadSensitivityTypesEnabled (funzione)IsLoadSensitivityTypesEnabled function

Ottiene il flag che indica se sono abilitate le etichette di riservatezza di carico.Get the the flag indicating if load sensitivity labels is enabled.

Restituisce: true se Enabled else false.Returns: True if enabled else false.

Funzione secloudSetCloud function

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

ParametriParameters:

• cloud: cloudcloud: Cloud

Se il cloud non è specificato, l'impostazione predefinita sarà cloud commerciale.If cloud is not specified, then it will default to commercial 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://dataservice.protection.outlook.com")cloudEndpointBaseUrl: the base URL used by all service requests (for example, "https://dataservice.protection.outlook.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

SetDelegatedUserEmail (funzione)SetDelegatedUserEmail function

Imposta l'utente delegato.Sets the delegated user.

ParametriParameters:

• delegatedUserEmail: il messaggio di posta elettronica di delega.delegatedUserEmail: the delegation email.

Un utente delegato viene specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utenteA delegated user is specified when the authenticating user/application is acting on behalf of another user

GetDelegatedUserEmail (funzione)GetDelegatedUserEmail function

Ottiene l'utente delegato.Gets the delegated user.

Returns: utente delegato specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utenteReturns: Delegated user A delegated user is specified when the authenticating user/application is acting on behalf of another user

SetLabelFilter (funzione)SetLabelFilter function

Imposta il filtro delle etichette.Sets the label filter.

ParametriParameters:

• labelFilter: filtro etichette.labelFilter: the label filter.

Per impostazione predefinita, le etichette sono filtro per ambito. questa API consente di filtrare in base alle possibili azioni.Labels are by default filter to scope, this api is to allow filtering by possible actions. Se non è impostato, HyokProtection e DoubleKeyProtection vengono filtrati.If not set HyokProtection and DoubleKeyProtection are filtered.

GetLabelFilter (funzione)GetLabelFilter function

Ottiene i filtri delle etichette impostati tramite la funzione deprecata SetLabelFilter.Gets the label filters set through deprecated function SetLabelFilter.

Restituisce: filtro etichette.Returns: The label filter. Per impostazione predefinita, le etichette sono filtro per ambito. questa API consente di filtrare in base alle possibili azioni.Labels are by default filter to scope, this api is to allow filtering by possible actions.

ConfigureFunctionality (funzione)ConfigureFunctionality function

Abilita o Disabilita la funzionalità.Enables or disables functionality.

ParametriParameters:

• functionalityFilterType: il tipo di funzionalità.functionalityFilterType: the type of functionality.

• Enabled: true per abilitare, false per disabilitareenabled: True to enable, false to disable

HyokProtection, DoubleKeyProtection, DoubleKeyUserDefinedProtection sono disabilitati per impostazione predefinita e devono essere abilitatiHyokProtection, DoubleKeyProtection, DoubleKeyUserDefinedProtection are disabled by default and must be enabled

GetConfiguredFunctionality (funzione)GetConfiguredFunctionality function

Ottiene la funzionalità configurata.Gets the configured functionality.

Returns: mappa dei tipi a un valore booleano che indica se è abilitata o meno.Returns: A map of the types to a boolean value indicating whether or not it is enabled

SetVariableTextMarkingType (funzione)SetVariableTextMarkingType function

Imposta il tipo di contrassegno del testo della variabile.Sets the variable text marking type.

ParametriParameters:

• variableTextMarkingType: tipo di contrassegno del testo della variabile.variableTextMarkingType: the variable text marking type.

GetVariableTextMarkingType (funzione)GetVariableTextMarkingType function

Ottiene il tipo di contrassegno del testo della variabile.Gets the variable text marking type.

Returns: tipo di contrassegno del testo della variabile.Returns: The variable text marking type.

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.