Skip to content

Commit 264bab6

Browse files
diachenko-mischamykhailo-kuchma
authored andcommitted
Fix Doxygen example for VolatileLayerClient
Resolves: OLPEDGE-854 Signed-off-by: Diachenko Mykahilo <[email protected]>
1 parent b854f45 commit 264bab6

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/VolatileLayerClient.h

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,31 +42,28 @@ class VolatileLayerClientImpl;
4242
*
4343
* Example:
4444
* @code{.cpp}
45-
* const std::string kCatalog = "hrn:here:data:::hereos-internal-test-v2";
46-
* const std::string kLayerId = "hype-test";
47-
* const auto kHRN = olp::client::HRN::FromString(kCatalog);
48-
*
49-
* std::shared_ptr<olp::thread::TaskScheduler> task_scheduler =
45+
* auto task_scheduler =
5046
* olp::client::OlpClientSettingsFactory::CreateDefaultTaskScheduler(1u);
51-
* std::shared_ptr<olp::http::Network> http_client = olp::client::
47+
* auto http_client = olp::client::
5248
* OlpClientSettingsFactory::CreateDefaultNetworkRequestHandler();
5349
*
54-
* olp::authentication::Settings settings;
50+
* olp::authentication::Settings settings{"Your.Key.Id", "Your.Key.Secret"};
5551
* settings.task_scheduler = task_scheduler;
5652
* settings.network_request_handler = http_client;
5753
*
5854
* olp::client::AuthenticationSettings auth_settings;
59-
* auth_settings.provider = olp::authentication::TokenProviderDefault(
60-
* kKeyId, kKeySecret, std::move(settings));
55+
* auth_settings.provider =
56+
* olp::authentication::TokenProviderDefault(std::move(settings));
6157
*
6258
* auto client_settings = olp::client::OlpClientSettings();
6359
* client_settings.authentication_settings = auth_settings;
6460
* client_settings.task_scheduler = std::move(task_scheduler);
6561
* client_settings.network_request_handler = std::move(http_client);
6662
*
67-
* VolatileLayerClient client{kHRN, kLayerId, client_settings};
68-
* VolatileLayerClient::Callback<model::Data> callback = ... ;
69-
* auto token = client.GetData(request, cb);
63+
* VolatileLayerClient client{"hrn:here:data:::your-catalog-hrn" "your-layer-id", client_settings};
64+
* auto callback = [](olp::client::ApiResponse<olp::model::Data, olp::client::ApiError> response) {};
65+
* auto request = DataRequest().WithPartitionId("269");
66+
* auto token = client.GetData(request, callback);
7067
* @endcode
7168
*
7269
* @see

0 commit comments

Comments
 (0)