SYOnlineSession Class Reference

#import <SYOnlineSession.h>

Inheritance diagram for SYOnlineSession:
Collaboration diagram for SYOnlineSession:

Instance Methods

((unavailable("Use +[SYOnlineSession sharedSession] instead.") - __attribute__
 SYOnlineSession is singleton, use [SYOnlineSession sharedSession] to access singleton instance. More...
 
(nonnull SYTask *) - setOnlineMapsDisabledWithCompletion:
 
(nonnull SYTask *) - setOnlineMapsEnabledWithCompletion:
 
(void) - getActiveMapProviderWithCompletion:
 Fetch currently active Online Map Provider. More...
 
(void) - getAvailableMapProvidersWithCompletion:
 Fetch Online Map Providers currently available. More...
 
(void) - setActiveMapProvider:completion:
 Set active Map Provider. Does nothing if the currently active provider is the same as desired one. More...
 

Class Methods

(nonnull SYOnlineSession *) + sharedSession
 SYOnlineSession singleton object. More...
 
((unavailable("Use +[SYOnlineSession sharedSession] instead.") + __attribute__
 

Properties

BOOL onlineMapsEnabled
 Indicates whether Sygic SDK is allowed to access online maps services. More...
 

Method Documentation

◆ sharedSession

+ (nonnull SYOnlineSession*) sharedSession

SYOnlineSession singleton object.

◆ __attribute__ [1/2]

- ((unavailable("Use +[SYOnlineSession sharedSession] instead.") __attribute__

SYOnlineSession is singleton, use [SYOnlineSession sharedSession] to access singleton instance.

◆ __attribute__ [2/2]

+ ((unavailable("Use +[SYOnlineSession sharedSession] instead.") __attribute__

◆ setOnlineMapsDisabledWithCompletion:

- (nonnull SYTask*) setOnlineMapsDisabledWithCompletion: (nonnull void(^)(SYMapStreamingError *_Nullable error))  completion

◆ setOnlineMapsEnabledWithCompletion:

- (nonnull SYTask*) setOnlineMapsEnabledWithCompletion: (nonnull void(^)(SYMapStreamingError *_Nullable error))  completion

◆ getActiveMapProviderWithCompletion:

- (void) getActiveMapProviderWithCompletion: (nonnull SYOnlineGetActiveProviderCompletionBlock)  completion

Fetch currently active Online Map Provider.

Parameters
completionCompletion block called after the fetch operation is complete. Called with a provider on success, with error code on error.

◆ getAvailableMapProvidersWithCompletion:

- (void) getAvailableMapProvidersWithCompletion: (nonnull SYOnlineGetAvailableProvidersCompletionBlock)  completion

Fetch Online Map Providers currently available.

Parameters
completionCompletion block called after the fetch operation is complete. Called with list of providers on success, with error code on error.

◆ setActiveMapProvider:completion:

- (void) setActiveMapProvider: (nonnull SYMapProvider *)  provider
completion: (nonnull SYOnlineSetProviderCompletionBlock)  completion 

Set active Map Provider. Does nothing if the currently active provider is the same as desired one.

Parameters
providerDesired Map Provider, to which the SDK shall switch. Must be one of the providers returned by [getAvailableProviders].
completionCompletion block called after the set operation is complete.

Property Documentation

◆ onlineMapsEnabled

- (BOOL) onlineMapsEnabled
readnonatomicassign

Indicates whether Sygic SDK is allowed to access online maps services.


The documentation for this class was generated from the following file: