Inherits from NSObject
Declared in ARService.h

Tasks

Accessing Shared Instance

Setuping the Service

PushNotification Methods

API Methods

Tracker Methods

MessageCenter Methods

Properties

campaignsEnabled

@property (nonatomic, assign) BOOL campaignsEnabled

Declared In

ARService.h

completionBlock

By overriding this block, you can redirect the http request calls to your own system. You’ll have to asynchronously call the completionBlock by passing your result, error and HTTP URL Response at the end of the request.

@property (nonatomic, copy) void ( ^ ) ( NSURLRequest *urlRequest , void ( ^ ) ( id result , NSHTTPURLResponse *response , NSError *error ) ) completionBlock

Declared In

ARService+API.h

crashReportsEnabled

@property (nonatomic, assign) BOOL crashReportsEnabled

Declared In

ARService.h

errorBlock

@property (nonatomic, copy) void ( ^ ) ( NSString *category , NSError *error ) errorBlock

Declared In

ARService.h

numberOfTopics

@property (nonatomic, assign, readonly) NSInteger numberOfTopics

Declared In

ARService+MessageCenter.h

numberOfUnreadTopics

Observes this property to update your unread topics badge number.

@property (nonatomic, assign, readonly) NSInteger numberOfUnreadTopics

Declared In

ARService+MessageCenter.h

numberOfUnreadTopicsChangedBlock

By implementing this block, you can manage your application badge for example.

@property (nonatomic, copy) void ( ^ ) ( NSInteger numberOfUnreadTopics ) numberOfUnreadTopicsChangedBlock

Declared In

ARService+MessageCenter.h

pushNotificationEnvironment

@property (nonatomic, retain, readonly) NSString *pushNotificationEnvironment

Declared In

ARService.h

remoteNotificationReceivedBlock

@property (nonatomic, copy) void ( ^ ) ( BOOL openingApplication , NSString *topicUUID , NSString *messageUUID ) remoteNotificationReceivedBlock

Declared In

ARService+PushNotification.h

userId

@property (nonatomic, assign, readonly) NSString *userId

Declared In

ARService.h

Class Methods

AppRelaySDKVersion

Return the current version formatted as follow : “MajorVersion (MinorVersion)”

+ (NSString *)AppRelaySDKVersion

Declared In

ARService.h

sharedService

+ (ARService *)sharedService

Declared In

ARService.h

Instance Methods

fetchNewMessagesWithCompletionBlock:

- (void)fetchNewMessagesWithCompletionBlock:(void ( ^ ) ( NSError *error ))completionBlock

Declared In

ARService+API.h

handleApplication:didFinishLaunchingWithOptions:

- (void)handleApplication:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

Declared In

ARService+PushNotification.h

handleApplication:didReceiveRemoteNotification:openingApplication:

- (void)handleApplication:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo openingApplication:(BOOL)openingApplication

Declared In

ARService+PushNotification.h

handleApplication:didRegisterForRemoteNotificationsWithDeviceToken:

- (void)handleApplication:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)apnsToken

Declared In

ARService+PushNotification.h

handleApplicationDidBecomeActive:

- (void)handleApplicationDidBecomeActive:(UIApplication *)application

Declared In

ARService+PushNotification.h

registerPushDeviceToken:

- (void)registerPushDeviceToken:(NSData *)token

Declared In

ARService+Tracker.h

startServiceWithAPIKey:bundleId:

Call This method to start the whole service containing metrics and message center.

- (void)startServiceWithAPIKey:(NSString *)apiKey bundleId:(NSString *)bundleId

Declared In

ARService.h

startTrackerWithAPIKey:bundleId:

Call This method to start the metrics tracker only.

- (void)startTrackerWithAPIKey:(NSString *)apiKey bundleId:(NSString *)bundleId

Declared In

ARService.h

stopTimedEvent:

returns -1 if the event is no more registered

- (NSTimeInterval)stopTimedEvent:(NSString *)name

Declared In

ARService+Tracker.h

stopTimedEvent:properties:

returns -1 if the event is no more registered

- (NSTimeInterval)stopTimedEvent:(NSString *)name properties:(NSDictionary *)properties

Declared In

ARService+Tracker.h

trackEvent:properties:

- (void)trackEvent:(NSString *)name properties:(NSDictionary *)properties

Declared In

ARService+Tracker.h

trackPaymentTransaction:product:

- (void)trackPaymentTransaction:(SKPaymentTransaction *)paymentTransaction product:(SKProduct *)product

Declared In

ARService+Tracker.h

trackTimedEvent:options:properties:

returns NO if an event with the specified type has previously been registered

- (BOOL)trackTimedEvent:(NSString *)name options:(ARTimedEventOptions)options properties:(NSDictionary *)properties

Declared In

ARService+Tracker.h

trackTimedEvent:options:propertiesBlock:

returns NO if an event with the specified type has previously been registered. propertiesBlock allows to customize the properties when the tracker will stop/restart the event automatically depending on the options you specify.

- (BOOL)trackTimedEvent:(NSString *)name options:(ARTimedEventOptions)options propertiesBlock:(NSDictionary *( ^ ) ( ARTimedEventState state , NSDictionary *previousProperties ))propertiesBlock

Declared In

ARService+Tracker.h

trackTimedEvent:properties:

returns NO if an event with the specified type has previously been registered

- (BOOL)trackTimedEvent:(NSString *)name properties:(NSDictionary *)properties

Declared In

ARService+Tracker.h

trackTimedEvent:propertiesBlock:

returns NO if an event with the specified type has previously been registered. propertiesBlock allows to customize the properties when the tracker will stop/restart the event automatically depending on the options you specify.

- (BOOL)trackTimedEvent:(NSString *)name propertiesBlock:(NSDictionary *( ^ ) ( ARTimedEventState state , NSDictionary *previousProperties ))propertiesBlock

Declared In

ARService+Tracker.h

viewControllerForMessageCenterWithSelectionBlock:

- (UIViewController *)viewControllerForMessageCenterWithSelectionBlock:(void ( ^ ) ( UIViewController *messageCenter , id topic ))selectionBlock

Declared In

ARService+MessageCenter.h

viewControllerForMessageCenterWithSelectionBlock:customizationBlock:

- (UIViewController *)viewControllerForMessageCenterWithSelectionBlock:(void ( ^ ) ( UIViewController *messageCenter , id topic ))selectionBlock customizationBlock:(void ( ^ ) ( UIViewController *messageCenter , UITableView *tableView ))customizationBlock

Declared In

ARService+MessageCenter.h

viewControllerForTopic:source:

- (UIViewController *)viewControllerForTopic:(id)topic source:(ARTopicPresentationSource)source

Declared In

ARService+MessageCenter.h

viewControllerForTopicWithUUID:source:

- (UIViewController *)viewControllerForTopicWithUUID:(NSString *)topicUUID source:(ARTopicPresentationSource)source

Declared In

ARService+MessageCenter.h