Netmera Class Reference
| Inherits from | NSObject |
| Declared in | Netmera.h Netmera.m |
Overview
Netmera class is the base class for Netmera SDK. You can configure how Netmera should behave using this class.
Also, you can get InstallationId of your application using [Netmera getInstallationId] class method.
Tasks
-
+ apiKeyReturns application-specific key received from Netmera and set in the application.
-
+ setApiKey:Sets the application-specific key received from Netmera for the application requests.
-
+ getInstallationIdReturns a UUID string that could be used to uniquely identify the device for the application.
-
+ setGlobalRequestTimeout:Sets a timeout value for all sending requests from Netmera SDK throughout the application. The default value is 60 seconds.
-
+ pushInboxEnabledReturns the boolean value that shows whether the push inbox is enabled or not. The default value is YES.
-
+ setPushInboxEnabled:Sets the boolean value whether the push inbox controller is available for your application or not when a rich push message is received. The default value is YES.
-
+ richPushShouldBeShownImmediatelyReturns the boolean value for receiving rich pushes to be displayed immediately or be asked whether rich pushes are displayed or not with an alert box. The default value is YES.
-
+ setRichPushShouldBeShownImmediately:Sets the boolean value for receiving rich pushes to be displayed immediately or not. If shouldBeShown value is YES, receiving rich push is displayed on the screen directly without any alert. If it is NO, then an alert box, which waits a confirmation about if rich push should be shown or not from the user is shown on the screen. The default value is YES.
-
+ richPushShouldShowProgressHUDReturns the boolean value which indicates whether a loading indicator is displayed or not when showing rich push notifications. The default value is YES.
-
+ setRichPushShouldShowProgressHUD:Sets the boolean value whether a progress HUD should be displayed or not while setting up a receiving rich push notification. The default value is YES.
-
+ exceptionReportingEnabledReturns the boolean value which indicates whether throwing exceptions should be reported or not. The default value is YES.
-
+ setExceptionReportingEnabled:Sets the boolean value that shows whether exceptionReporting should be enabled or disabled. Default value is YES.
-
+ significantLocationChangeTrackingEnabledReturns the boolean value which indicates whether locationTracking is enabled or disabled. Default value is YES.
-
+ setSignificantLocationChangeTrackingEnabled:Sets the boolean value that shows whether locationTracking should be enabled or disabled. Default value is YES.
Class Methods
apiKey
Returns application-specific key received from Netmera and set in the application.
+ (NSString *)apiKeyReturn Value
The string value which refers to api key.
Discussion
Returns application-specific key received from Netmera and set in the application.
Declared In
Netmera.hexceptionReportingEnabled
Returns the boolean value which indicates whether throwing exceptions should be reported or not. The default value is YES.
+ (BOOL)exceptionReportingEnabledReturn Value
The boolean value that enables or disables sending exception reports to Netmera throughout the application.
Discussion
Returns the boolean value which indicates whether throwing exceptions should be reported or not. The default value is YES.
Declared In
Netmera.hgetInstallationId
Returns a UUID string that could be used to uniquely identify the device for the application.
+ (NSString *)getInstallationIdReturn Value
The string value generating exclusively for the application.
Discussion
Returns a UUID string that could be used to uniquely identify the device for the application.
Declared In
Netmera.hpushInboxEnabled
Returns the boolean value that shows whether the push inbox is enabled or not. The default value is YES.
+ (BOOL)pushInboxEnabledReturn Value
The enabled or disabled boolean value.
Discussion
Returns the boolean value that shows whether the push inbox is enabled or not. The default value is YES.
Declared In
Netmera.hrichPushShouldBeShownImmediately
Returns the boolean value for receiving rich pushes to be displayed immediately or be asked whether rich pushes are displayed or not with an alert box. The default value is YES.
+ (BOOL)richPushShouldBeShownImmediatelyReturn Value
The boolean value that shows whether the rich push is shown immediately or not.
Discussion
Returns the boolean value for receiving rich pushes to be displayed immediately or be asked whether rich pushes are displayed or not with an alert box. The default value is YES.
Declared In
Netmera.hrichPushShouldShowProgressHUD
Returns the boolean value which indicates whether a loading indicator is displayed or not when showing rich push notifications. The default value is YES.
+ (BOOL)richPushShouldShowProgressHUDReturn Value
The boolean value showing that a progress HUD should be displayed or not.
Discussion
Returns the boolean value which indicates whether a loading indicator is displayed or not when showing rich push notifications. The default value is YES.
Declared In
Netmera.hsetApiKey:
Sets the application-specific key received from Netmera for the application requests.
+ (void)setApiKey:(NSString *)keyParameters
- key
The unique value received from “Overview” section of your application in Netmera website.
Discussion
Sets the application-specific key received from Netmera for the application requests.
This value is unique for every application, therefore Netmera determines which app sends whichever requests. This is the required value that must be set for every application before making any interaction with Netmera.
You can set the api key by either calling this method with the relevant parameter or adding manually it into NetmeraSettings.plist.
Declared In
Netmera.hsetExceptionReportingEnabled:
Sets the boolean value that shows whether exceptionReporting should be enabled or disabled. Default value is YES.
+ (void)setExceptionReportingEnabled:(BOOL)enabledParameters
- enabled
The boolean value that enables exceptionReporting or not.
Discussion
Sets the boolean value that shows whether exceptionReporting should be enabled or disabled. Default value is YES.
If you enable exceptionReporting, the exceptions that are handled by you or crashes your application are catched by Netmera SDK and send their reports to Netmera automatically. Then you can see your detailed reports in Netmera website.
You can send your custom exception reports to Netmera, too. Just call sendExceptionReport: method of NMExceptionReporter class. This method sends the report for the exception given as parameter independent from the value of this flag.
Declared In
Netmera.hsetGlobalRequestTimeout:
Sets a timeout value for all sending requests from Netmera SDK throughout the application. The default value is 60 seconds.
+ (void)setGlobalRequestTimeout:(NSTimeInterval)secondsParameters
- seconds
Value used as the timeout interval for requests.
Discussion
Sets a timeout value for all sending requests from Netmera SDK throughout the application. The default value is 60 seconds.
You should not set a short timeout interval, because this may prevents Netmera SDK to send requests in weak internet connections.
Declared In
Netmera.hsetPushInboxEnabled:
Sets the boolean value whether the push inbox controller is available for your application or not when a rich push message is received. The default value is YES.
+ (void)setPushInboxEnabled:(BOOL)enabledParameters
- enabled
The boolean value that enables push inbox or not.
Discussion
Sets the boolean value whether the push inbox controller is available for your application or not when a rich push message is received. The default value is YES.
Declared In
Netmera.hsetRichPushShouldBeShownImmediately:
Sets the boolean value for receiving rich pushes to be displayed immediately or not. If shouldBeShown value is YES, receiving rich push is displayed on the screen directly without any alert. If it is NO, then an alert box, which waits a confirmation about if rich push should be shown or not from the user is shown on the screen. The default value is YES.
+ (void)setRichPushShouldBeShownImmediately:(BOOL)shouldBeShownParameters
- shouldBeShown
The boolean value that controls the display of the rich pushes.
Discussion
Sets the boolean value for receiving rich pushes to be displayed immediately or not. If shouldBeShown value is YES, receiving rich push is displayed on the screen directly without any alert. If it is NO, then an alert box, which waits a confirmation about if rich push should be shown or not from the user is shown on the screen. The default value is YES.
Declared In
Netmera.hsetRichPushShouldShowProgressHUD:
Sets the boolean value whether a progress HUD should be displayed or not while setting up a receiving rich push notification. The default value is YES.
+ (void)setRichPushShouldShowProgressHUD:(BOOL)shouldShowParameters
- shouldShow
The boolean value that activates or deactivates a loading indicator.
Discussion
Sets the boolean value whether a progress HUD should be displayed or not while setting up a receiving rich push notification. The default value is YES.
Declared In
Netmera.hsetSignificantLocationChangeTrackingEnabled:
Sets the boolean value that shows whether locationTracking should be enabled or disabled. Default value is YES.
+ (void)setSignificantLocationChangeTrackingEnabled:(BOOL)enabledParameters
- enable
The boolean value that enables locationTracking or not.
Discussion
Sets the boolean value that shows whether locationTracking should be enabled or disabled. Default value is YES.
Users' locations are tracked by default (using startMonitoringSignificantLocationChanges method of CLLocationManager class). If you want to disable tracking user’s location, you should call [NetmeraClient setLocationTrackingEnabled:NO] in application:didFinishLaunchingWithOptions: method in your app delegate.
This flag does NOT affect operation of Geofence Service. You can start or stop a geofence service regardless of this flag.
Declared In
Netmera.hsignificantLocationChangeTrackingEnabled
Returns the boolean value which indicates whether locationTracking is enabled or disabled. Default value is YES.
+ (BOOL)significantLocationChangeTrackingEnabledReturn Value
The boolean value that enables or disables locationTracking.
Discussion
Returns the boolean value which indicates whether locationTracking is enabled or disabled. Default value is YES.
Users' locations are tracked by default (using startMonitoringSignificantLocationChanges method of CLLocationManager class). If you want to disable tracking user’s location, you should call [NetmeraClient setLocationTrackingEnabled:NO] in application:didFinishLaunchingWithOptions: method in your app delegate.
This flag does NOT affect operation of Geofence Service. You can start or stop a geofence service regardless of this flag.
Declared In
Netmera.h