LimeREST Class Reference
Inherits from | NSObject |
Declared in | LimeREST.h LimeREST.m |
Overview
Copyright © 2015, Lime - HighTech Solutions s.r.o. (www.lime-company.eu).
All rights reserved. This source code can be used only for purposes specified by the given license contract signed by the rightful deputy of Lime - HighTech Solutions s.r.o. This source code can be used only by the owner of the license.
Any disputes arising in respect of this agreement (license) shall be brought before the Municipal Court of Prague.
Tasks
-
– fetchConfigurationForApplication:success:failure:
-
– fetchNearbyGeofencesForApplication:count:latitude:longitude:success:failure:
-
– fetchRulesListForApplication:beacons:success:failure:
-
– fetchRulesListForApplication:geofences:latitude:longitude:success:failure:
-
– sendAnalyticEvents:forApplication:
Instance Methods
fetchConfigurationForApplication:success:failure:
Fetch the SDK configuration information for an application with given APP_KEY.
- (AFHTTPRequestOperationManager *)fetchConfigurationForApplication:(NSString *)appKey success:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSArray *uuidList ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
Parameters
- appKey
An APP_KEY of an application.
- success
A callback in case data is successfully fetched.
- failure
A callback in case data fetching fails.
Return Value
AFHTTPRequestOperationManager instance.
Discussion
Fetch the SDK configuration information for an application with given APP_KEY.
Declared In
LimeREST.h
fetchNearbyGeofencesForApplication:count:latitude:longitude:success:failure:
Fetch the list of nearby geofences for given application and GPS coordinates.
- (AFHTTPRequestOperationManager *)fetchNearbyGeofencesForApplication:(NSString *)appKey count:(NSNumber *)count latitude:(NSNumber *)latitude longitude:(NSNumber *)longitude success:(void ( ^ ) ( AFHTTPRequestOperation *operation , LimeGeofenceList *geofenceList ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
Parameters
- appKey
An APP_KEY of an application.
- count
Maximum number of geofences that are expected in the response.
- latitude
GPS latitude.
- longitude
GPS longitude.
- success
A callback in case data is successfully fetched.
- failure
A callback in case data fetching fails.
Return Value
AFHTTPRequestOperationManager instance.
Discussion
Fetch the list of nearby geofences for given application and GPS coordinates.
Declared In
LimeREST.h
fetchRulesListForApplication:beacons:success:failure:
Fetch the content rules for given beacons and aplication.
- (AFHTTPRequestOperationManager *)fetchRulesListForApplication:(NSString *)appKey beacons:(NSArray *)beacons success:(void ( ^ ) ( AFHTTPRequestOperation *operation , LimeContentRulesList *contentRulesList ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
Parameters
- appKey
An APP_KEY of an application.
- beacons
A list of beacons to fetch the content for.
- success
A callback in case data is successfully fetched.
- failure
A callback in case data fetching fails.
Return Value
AFHTTPRequestOperationManager instance.
Discussion
Fetch the content rules for given beacons and aplication.
Declared In
LimeREST.h
fetchRulesListForApplication:geofences:latitude:longitude:success:failure:
Fetch the content rules for given geofences and aplication. The method takes the GPS coordinates as a parameter so that server can better protect to scraping data (geofences that are too far from the given location are not returned).
- (AFHTTPRequestOperationManager *)fetchRulesListForApplication:(NSString *)appKey geofences:(NSArray *)geofences latitude:(NSNumber *)latitude longitude:(NSNumber *)longitude success:(void ( ^ ) ( AFHTTPRequestOperation *operation , LimeContentRulesList *contentRulesList ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
Parameters
- appKey
An APP_KEY of an application.
- geofences
A list of geofences to fetch the content for.
- latitude
GPS latitude.
- longitude
GPS longitude.
- success
A callback in case data is successfully fetched.
- failure
A callback in case data fetching fails.
Return Value
AFHTTPRequestOperationManager instance.
Discussion
Fetch the content rules for given geofences and aplication. The method takes the GPS coordinates as a parameter so that server can better protect to scraping data (geofences that are too far from the given location are not returned).
Declared In
LimeREST.h
sendAnalyticEvents:forApplication:
Send an analytics event list for given application.
- (AFHTTPRequestOperationManager *)sendAnalyticEvents:(LimeAnalyticsEventList *)eventList forApplication:(NSString *)appKey
Parameters
- eventList
List of analytics events to be sent to the server.
- appKey
An APP_KEY of an application.
Return Value
AFHTTPRequestOperationManager instance.
Discussion
Send an analytics event list for given application.
Declared In
LimeREST.h