KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Static Public Member Functions | Public Attributes | List of all members
REMOTE_PROVIDER_METADATA Struct Reference

#include <remote_provider_metadata.h>

Static Public Member Functions

static wxFileName DefaultSchemaPath ()
 
static std::optional< REMOTE_PROVIDER_METADATA > FromJson (const nlohmann::json &aJson, wxString &aError)
 
static std::optional< REMOTE_PROVIDER_METADATA > FromJson (const nlohmann::json &aJson, const wxFileName &aSchemaFile, wxString &aError)
 

Public Attributes

wxString provider_name
 
wxString provider_version
 
wxString api_base_url
 
wxString panel_url
 
wxString session_bootstrap_url
 
REMOTE_PROVIDER_AUTH_METADATA auth
 
bool web_ui_v1 = false
 
bool parts_v1 = false
 
bool direct_downloads_v1 = false
 
bool inline_payloads_v1 = false
 
long long max_download_bytes = 0
 
std::vector< wxString > supported_asset_types
 
wxString parts_endpoint_template
 
wxString documentation_url
 
wxString terms_url
 
wxString privacy_url
 
bool allow_insecure_localhost = false
 

Detailed Description

Definition at line 47 of file remote_provider_metadata.h.

Member Function Documentation

◆ DefaultSchemaPath()

wxFileName REMOTE_PROVIDER_METADATA::DefaultSchemaPath ( )
static

Definition at line 31 of file remote_provider_metadata.cpp.

References FN_NORMALIZE_FLAGS, and PATHS::GetStockDataPath().

Referenced by FromJson().

◆ FromJson() [1/2]

std::optional< REMOTE_PROVIDER_METADATA > REMOTE_PROVIDER_METADATA::FromJson ( const nlohmann::json & aJson,
const wxFileName & aSchemaFile,
wxString & aError )
static

Definition at line 48 of file remote_provider_metadata.cpp.

References _, allow_insecure_localhost, api_base_url, auth, REMOTE_PROVIDER_AUTH_METADATA::client_id, direct_downloads_v1, documentation_url, COLLECTING_JSON_ERROR_HANDLER::FirstError(), COLLECTING_JSON_ERROR_HANDLER::HasErrors(), inline_payloads_v1, max_download_bytes, REMOTE_PROVIDER_AUTH_METADATA::metadata_url, name, NONE, NormalizedUrlOrigin(), OAUTH2, panel_url, parts_endpoint_template, parts_v1, privacy_url, provider_name, provider_version, RemoteProviderJsonString(), REMOTE_PROVIDER_AUTH_METADATA::scopes, session_bootstrap_url, supported_asset_types, terms_url, REMOTE_PROVIDER_AUTH_METADATA::type, JSON_SCHEMA_VALIDATOR::Validate(), ValidateRemoteUrlSecurity(), and web_ui_v1.

◆ FromJson() [2/2]

std::optional< REMOTE_PROVIDER_METADATA > REMOTE_PROVIDER_METADATA::FromJson ( const nlohmann::json & aJson,
wxString & aError )
static

Definition at line 41 of file remote_provider_metadata.cpp.

References DefaultSchemaPath(), and FromJson().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), REMOTE_PROVIDER_CLIENT::DiscoverProvider(), and FromJson().

Member Data Documentation

◆ allow_insecure_localhost

bool REMOTE_PROVIDER_METADATA::allow_insecure_localhost = false

Definition at line 65 of file remote_provider_metadata.h.

Referenced by REMOTE_PROVIDER_CLIENT::ExchangeBootstrapNonce(), REMOTE_PROVIDER_CLIENT::FetchManifest(), REMOTE_PROVIDER_CLIENT::FetchOAuthServerMetadata(), and FromJson().

◆ api_base_url

wxString REMOTE_PROVIDER_METADATA::api_base_url

Definition at line 51 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ auth

REMOTE_PROVIDER_AUTH_METADATA REMOTE_PROVIDER_METADATA::auth

Definition at line 54 of file remote_provider_metadata.h.

Referenced by BOOST_AUTO_TEST_CASE(), REMOTE_PROVIDER_CLIENT::FetchOAuthServerMetadata(), FromJson(), REMOTE_PROVIDER_CLIENT::GetSignInState(), and PANEL_REMOTE_SYMBOL::startInteractiveLogin().

◆ direct_downloads_v1

bool REMOTE_PROVIDER_METADATA::direct_downloads_v1 = false

Definition at line 57 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ documentation_url

wxString REMOTE_PROVIDER_METADATA::documentation_url

Definition at line 62 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ inline_payloads_v1

bool REMOTE_PROVIDER_METADATA::inline_payloads_v1 = false

Definition at line 58 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ max_download_bytes

long long REMOTE_PROVIDER_METADATA::max_download_bytes = 0

Definition at line 59 of file remote_provider_metadata.h.

Referenced by FromJson(), and REMOTE_SYMBOL_IMPORT_JOB::Import().

◆ panel_url

wxString REMOTE_PROVIDER_METADATA::panel_url

Definition at line 52 of file remote_provider_metadata.h.

Referenced by PANEL_REMOTE_SYMBOL::bootstrapAuthenticatedSession(), REMOTE_PROVIDER_CLIENT::ExchangeBootstrapNonce(), FromJson(), and PANEL_REMOTE_SYMBOL::loadProviderPage().

◆ parts_endpoint_template

wxString REMOTE_PROVIDER_METADATA::parts_endpoint_template

Definition at line 61 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ parts_v1

bool REMOTE_PROVIDER_METADATA::parts_v1 = false

Definition at line 56 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ privacy_url

wxString REMOTE_PROVIDER_METADATA::privacy_url

Definition at line 64 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ provider_name

wxString REMOTE_PROVIDER_METADATA::provider_name

Definition at line 49 of file remote_provider_metadata.h.

Referenced by FromJson(), and DIALOG_REMOTE_SYMBOL_CONFIG::onRefreshProvider().

◆ provider_version

wxString REMOTE_PROVIDER_METADATA::provider_version

Definition at line 50 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ session_bootstrap_url

wxString REMOTE_PROVIDER_METADATA::session_bootstrap_url

Definition at line 53 of file remote_provider_metadata.h.

Referenced by REMOTE_PROVIDER_CLIENT::ExchangeBootstrapNonce(), FromJson(), and PANEL_REMOTE_SYMBOL::loadProviderPage().

◆ supported_asset_types

std::vector<wxString> REMOTE_PROVIDER_METADATA::supported_asset_types

Definition at line 60 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ terms_url

wxString REMOTE_PROVIDER_METADATA::terms_url

Definition at line 63 of file remote_provider_metadata.h.

Referenced by FromJson().

◆ web_ui_v1

bool REMOTE_PROVIDER_METADATA::web_ui_v1 = false

Definition at line 55 of file remote_provider_metadata.h.

Referenced by FromJson().

The documentation for this struct was generated from the following files: