Skip to content

Documentation update #1703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrey-kashcheev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation update #1703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ HERE Data SDK for C++ is a C++ client for the <a href="https://platform.here.com

## Use the SDK

To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md" target="_blank">Getting Started Guide</a> and <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.
To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md" target="_blank">Getting Started Guide</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md" target="blank">Developer Guide</a>.
Comment thread
rustam-gamidov-here marked this conversation as resolved.

## Health check

Expand All @@ -30,13 +30,13 @@ To learn how to install and use the Data SDK, see the <a href="https://github.co

We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for C++ every half a year.

For more information on Data API, see its <a href="https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html" target="_blank">Developer Guide</a> and <a href="https://www.here.com/docs/category/data-api" target="_blank">API Reference</a>.
For more information on Data API, see its <a href="https://docs.here.com/data-api/docs/data-api-intro" target="_blank">Developer Guide</a> and <a href="https://docs.here.com/data-api/reference" target="_blank">API Reference</a>.

When new API is introduced in Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.

Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://heremaps.github.io/here-data-sdk-cpp/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.

For more information on Data SDK for C++, see our <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.
For more information on Data SDK for C++, see our <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md" target="blank">Developer Guide</a>.
Comment thread
rustam-gamidov-here marked this conversation as resolved.

## Supported platforms

Expand Down
4 changes: 2 additions & 2 deletions docs/OverallArchitecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Outline

This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#why-use).
This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#use-the-sdk).

## Component overview

Expand Down Expand Up @@ -56,7 +56,7 @@ The dataservice-read module wraps a subset of the Data REST API related to readi
* [Config API](https://www.here.com/docs/bundle/data-api-config-v1-api-reference/page/index.html)
* [Metadata API](https://www.here.com/docs/bundle/data-api-metadata-v1-api-reference/page/index.html)
* [Query API](https://www.here.com/docs/bundle/data-api-query-v1-api-reference/page/index.html)
* [Volatile API](https://www.here.com/docs/bundle/data-api-volatile-blob-v1-api-reference/page/index.html)
* [Volatile API](https://docs.here.com/data-api/reference/getvolatileblob)
* Index layer (not supported yet). Used Data APIs:
* [Index API](https://www.here.com/docs/bundle/data-api-index-v1-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)
Expand Down
16 changes: 8 additions & 8 deletions docs/authenticate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To authenticate to the HERE platform and start working with HERE Data SDK for C++, you need to get an access token. You can receive it using a [default token provider](#authenticate-using-a-default-token-provider), [project authentication](#authenticate-using-project-authentication), or [federated credentials](#authenticate-using-federated-credentials).

For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/dev-token.html) section in the Identity & Access Management Developer Guide.
For instructions, see the [OAuth tokens](https://docs.here.com/identity-and-access-management/docs/manage-api-oauth) section in the Identity & Access Management Developer Guide.

> #### Note
> Keep your credentials secure and do not disclose them. Make sure that your credentials are not stored in a way that enables others to access them.
Expand All @@ -11,14 +11,14 @@ For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identi

1. Get your platform credentials.

For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

You get the `credentials.properties` file.

2. Initialize the authentication settings using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.

> #### Note
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).

```cpp
olp::authentication::Settings settings({kKeyId, kKeySecret});
Expand All @@ -42,12 +42,12 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings

1. Get your platform credentials.

For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.

> #### Note
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).

```cpp
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
Expand Down Expand Up @@ -88,14 +88,14 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings

1. Get your platform credentials.

For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

You get the `credentials.properties` file.

2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.

> #### Note
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).

```cpp
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
Expand All @@ -111,7 +111,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings

4. Get your federated (Facebook or ArcGIS) properties.

You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://heremaps.github.io/here-data-sdk-cpp/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).

5. Initialize your federated properties.

Expand Down
2 changes: 1 addition & 1 deletion docs/create-platform-client-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You need to create the `OlpClientSettings` object to get catalog and partition m
olp::client::OlpClientSettingsFactory::CreateDefaultCache(cache_settings);
```
To learn how to get or change cache size, see [Work with a cache](https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/topics/work-with-cache.html).
To learn how to get or change cache size, see [Work with a cache](./dev_guide/topics/work-with-cache.md).
6. Set up the `OlpClientSettings` object, and if you want to add the expiration limit for the data that is stored in the cache, set the `default_cache_expiration` to the needed expiration time.
Expand Down
6 changes: 3 additions & 3 deletions docs/dataservice-cache-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the cache example projec

1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.

For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.

Expand Down Expand Up @@ -64,9 +64,9 @@ After building and running the example project, you see the following informatio

## How it works

### <a name="get-partition-data-mutable"></a>Get data from a versioned layer with a cache
### Get data from a versioned layer with a cache

You can get data from a [versioned layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#versioned-layers) with a mutable or protected cache.
You can get data from a [versioned layer](https://docs.here.com/data-api/docs/layers#versioned-layers) with a mutable or protected cache.

**To get data from the versioned layer with mutable cache:**

Expand Down
6 changes: 3 additions & 3 deletions docs/dataservice-read-catalog-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the read example project

1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.

For instructions on how to get the access key ID and access key secret, see [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions on how to get the access key ID and access key secret, see [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.

Expand Down Expand Up @@ -74,7 +74,7 @@ To integrate the Data SDK libraries in the Android example project:
2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/android/app/src/main/cpp/MainActivityNative.cpp.in" target="_blank">`examples/android/app/src/main/cpp/MainActivityNative.cpp.in`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.

> #### Note
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

### Build the Data SDK on Android

Expand Down Expand Up @@ -124,7 +124,7 @@ To integrate the Data SDK libraries in the iOS example project written in the Ob
3. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/ios/ViewController.mm" target="_blank">`examples/ios/ViewController.mm`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.

> #### Note
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

### Build the Data SDK on iOS

Expand Down
4 changes: 2 additions & 2 deletions docs/dataservice-read-from-stream-layer-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page, you can find instructions on how to build and run the cache exampl

1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.

For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.

2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">examples/main.cpp</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.

Expand Down Expand Up @@ -62,7 +62,7 @@ After building and running the example project, you see the following informatio

### Get data from a stream layer

You can read messages from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#stream-layers) if you subscribe to it.
You can read messages from a [stream layer](https://docs.here.com/data-api/docs/creating-stream-layer) if you subscribe to it.

**To get data from the stream layer:**

Expand Down
Loading
Loading