summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLNetworkConfiguration.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/darwin/src/MGLNetworkConfiguration.h')
-rw-r--r--platform/darwin/src/MGLNetworkConfiguration.h29
1 files changed, 24 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLNetworkConfiguration.h b/platform/darwin/src/MGLNetworkConfiguration.h
index aaac5a330c..6c56050aae 100644
--- a/platform/darwin/src/MGLNetworkConfiguration.h
+++ b/platform/darwin/src/MGLNetworkConfiguration.h
@@ -1,18 +1,37 @@
#import <Foundation/Foundation.h>
+#import "MGLFoundation.h"
+
NS_ASSUME_NONNULL_BEGIN
/**
- The MGLNetworkConfiguration object provides a global way to set a base API URL for
- retrieval of map data, styles, and other resources.
-
- Currently, MGLNetworkConfiguration is a private API.
+ The `MGLNetworkConfiguration` object provides a global way to set a base
+ `NSURLSessionConfiguration`, and other resources.
*/
+MGL_EXPORT
@interface MGLNetworkConfiguration : NSObject
-/// Returns the shared instance of the `MGLNetworkConfiguration` class.
+/**
+ Returns the shared instance of the `MGLNetworkConfiguration` class.
+ */
@property (class, nonatomic, readonly) MGLNetworkConfiguration *sharedManager;
+/**
+ The session configuration object that is used by the `NSURLSession` objects
+ in this SDK.
+
+ If this property is set to nil or if no session configuration is provided this property
+ is set to the default session configuration.
+
+ Assign this object before instantiating any `MGLMapView` object.
+
+ @note: `NSURLSession` objects store a copy of this configuration. Any further changes
+ to mutable properties on this configuration object passed to a session’s initializer
+ will not affect the behavior of that session.
+
+ */
+@property (atomic, strong, null_resettable) NSURLSessionConfiguration *sessionConfiguration;
+
@end
NS_ASSUME_NONNULL_END