Getting started

Getting started

1. Contact 2GIS technical support to get an access key. Be sure to specify the appId of the application for which the key will be generated.

2. Add the received key file dgissdk.key to assets.

3. Call the initialize() method of a DGis object and specify the application context:

   import 'package:dgis_mobile_sdk_map/dgis.dart' as sdk;
   
   class SomeApp extends StatelessWidget {
       final sdkContext = sdk.DGis.initialize();
   }
   

   Important

   Context can be created in a single instance only.

4. Additionally, you can specify logging settings (LogOptions) and HTTP client settings (HttpOptions) such as request timeout:

   import 'package:dgis_mobile_sdk_map/dgis.dart' as sdk;
   
   class SomeApp extends StatelessWidget {
   
     final sdkContext = sdk.DGis.initialize(
       logOptions: const sdk.LogOptions(
         customLevel: sdk.LogLevel.verbose,
         systemLevel: sdk.LogLevel.verbose,
       ),
       httpOptions: const sdk.HttpOptions(
         timeout: Duration(seconds: 5),
       ),
     );
   }
   

Vendor Config

To override some SDK operation settings, use a file in the VendorConfig format. The file is passed during SDK initialization.

There are several ways to create an instance of the VendorConfig class:

• VendorConfigFromAsset - locate the file in the assets directory of the application source code and specify the file name in the constructor.
• VendorConfigFromFile - locate the file on the device file system and specify the absolute path to it.
• VendorConfigFromString - pass a string with the contents of the JSON file to the constructor.

The created VendorConfig instance is passed to the DGis.initialize() method with the vendorConfig parameter.

Working with offline data

Mobile SDK (the Full version) allows you to work with map, directory, and routing data offline from preloaded packages. This can be helpful when the network connection is low or missing.

To configure the offline mode:

1. Ensure that your access key contains proper rights for working with offline data. You can request access to offline data for all components (map, directory, routing) or select only the required ones.
2. Use TerritoryManager to download data files for territories where your application must work offline.

1. Configure SDK components for working with preloaded data:

   • Map: create a data source and specify the required working mode.
   • Directory: use the required method of creating an object directory.
   • Routing: a hybrid mode is used by default. For details, see the routing documentation.