Settings to use when obtaining templates.
More...
#include <get_template_settings.h>
|
virtual void | SetDelegatedUserEmail (const std::string &delegatedUserEmail)=0 |
| Sets the delegated user.
|
|
virtual const std::string & | GetDelegatedUserEmail () const =0 |
| Gets the delegated user.
|
|
virtual void | ForceRefresh (bool enabled)=0 |
| Can enable force refresh of templates, ignoring former cached response.
|
|
virtual bool | ShouldRefreshTemplates () const =0 |
| Can enable force refresh of templates, ignoring former cached response.
|
|
virtual void | EnableCaching (bool cachingAllowed)=0 |
| Can disable caching of template response. Will cache by default.
|
|
virtual bool | ShouldCacheResponse () const =0 |
| Can cache templates or not.
|
|
| ProtectionCommonSettings (std::string applicationScenarioId=std::string()) |
|
std::string | GetApplicationScenarioId () const |
| Gets the scenario Id provided by the application which is used to correlation with the server.
|
|
void | SetApplicationScenarioId (std::string applicationScenarioId) |
| Sets the scenario Id provided by the application.
|
|
bool | GetIsOfflineOnly () const |
| Gets whether or not ProtectionEngine operation allows for online HTTP operations.
|
|
virtual void | SetIsOfflineOnly (bool isOfflineOnly) |
| Sets whether or not ProtectionEngine operation allows for online HTTP operations.
|
|
void | SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings) |
| Set the custom settings, used for feature gating and testing.
|
|
const std::vector< std::pair< std::string, std::string > > & | GetCustomSettings () const |
| Get the custom settings, used for feature gating and testing.
|
|
Settings to use when obtaining templates.
◆ CreateGetTemplatesSettings()
static MIP_API std::shared_ptr< GetTemplatesSettings > __CDECL GetTemplatesSettings::CreateGetTemplatesSettings |
( |
| ) |
|
|
static |
◆ EnableCaching()
virtual void GetTemplatesSettings::EnableCaching |
( |
bool | cachingAllowed | ) |
|
|
pure virtual |
Can disable caching of template response. Will cache by default.
- Parameters
-
cachingAllowed | False to disallow template caching. |
◆ ForceRefresh()
virtual void GetTemplatesSettings::ForceRefresh |
( |
bool | enabled | ) |
|
|
pure virtual |
Can enable force refresh of templates, ignoring former cached response.
- Parameters
-
enabled | True to force the refresh. False to use the cached templates if available. |
◆ GetDelegatedUserEmail()
virtual const std::string & GetTemplatesSettings::GetDelegatedUserEmail |
( |
| ) |
const |
|
pure virtual |
Gets the delegated user.
- Returns
- Delegated user
- Note
- A delegated user is specified when the authenticating user/application is acting on behalf of another user
◆ SetDelegatedUserEmail()
virtual void GetTemplatesSettings::SetDelegatedUserEmail |
( |
const std::string & | delegatedUserEmail | ) |
|
|
pure virtual |
Sets the delegated user.
- Parameters
-
delegatedUserEmail | the delegation email. |
- Note
- A delegated user is specified when the authenticating user/application is acting on behalf of another user
◆ ShouldCacheResponse()
virtual bool GetTemplatesSettings::ShouldCacheResponse |
( |
| ) |
const |
|
pure virtual |
Can cache templates or not.
- Returns
- True to cache templates. False to not.
◆ ShouldRefreshTemplates()
virtual bool GetTemplatesSettings::ShouldRefreshTemplates |
( |
| ) |
const |
|
pure virtual |
Can enable force refresh of templates, ignoring former cached response.
- Returns
- True to ignore cached templates. False to use if available.
The documentation for this class was generated from the following file: