Inherits from NSObject
Declared in BeaconPlus.h

Overview

BeaconPlus class is the centre point to all the activities in BeaconPlus SDK. The SDK communicates with the BeaconPlus cloud on a timely basis in accordance with the sync interval set from the BeaconPlus admin and retrieves all the information relevant to the application. It uses iBeacon protocol to identify beacons. The SDK will send messages on delegates whenever a new spot has been detected or when the user has gone out of a particular spot.

Properties

delegate

A reference of the BeaconPlusDelegate protocol.

@property (nonatomic, assign) id<BeaconPlusDelegate> delegate

Discussion

The delegate object to receive spot entry, exit events. It also receives the success or failure responses from the SDK.

Declared In

BeaconPlus.h

Class Methods

sharedBeaconPlus

Returns the singleton class instance

+ (id)sharedBeaconPlus

Return Value

The class instance as created in the BeaconPlus class

Discussion

The class instance is used for all methods in the SDK

[[BeaconPlus sharedBeaconPlus];

Declared In

BeaconPlus.h

Instance Methods

clearCache:

Clears all the files cached yet

- (BOOL)clearCache:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

YES if cache is cleared successfully else NO and appropriate error messages will be returned

Discussion

The application may opt to save as much content as it likes in cache. It can also opt to clear the cache whenever it would like to do so. The clearCache call from application deletes all the files that were cached yet. Be careful with this method as the files once lost couldn’t be recovered unless downloaded again.

BOOL status = [[BeaconPlus sharedBeaconPlus] clearCache: &error];

Declared In

BeaconPlus.h

getAutoCacheStatus:

Gets the status for autocaching as set from the app

- (BOOL)getAutoCacheStatus:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

YES if autocahing is enabled else NO. Returns NO and appropriate error messages if the request failed.

Discussion

Sends the receiver the status of autocaching as set by app or the default status which is NO.

BOOL autoCachingStatus = [[BeaconPlus sharedBeaconPlus] getAutoCacheStatus: &error];

Declared In

BeaconPlus.h

getCacheLimit:

Gets the total space allotted for caching

- (double)getCacheLimit:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

The total cache limit if set initially else default value 500 MB (500 * 1024 * 1024 bytes). Returns cache limit as 0 and appropriate error messages if the request failed.

Discussion

The method returns the total space allotted for caching from the app. The application can save as much contents as required. Though the application may opt any value above 5 MB, it is recommended that the cache limit be controlled to some extent as huge area occupied for caching of files will reduce the total disk space.

float cacheLimit = [[BeaconPlus sharedBeaconPlus] getCacheLimit: &error];

Declared In

BeaconPlus.h

getCacheStatus:

Gets the status for caching as set from the app.

- (BOOL)getCacheStatus:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

YES if caching is enabled else NO. Returns NO and appropriate error messages if the request failed.

Discussion

Sends the receiver the status of caching as set by app or the default status which is YES.

BOOL cachingStatus = [[BeaconPlus sharedBeaconPlus] getCacheStatus: &error];

Declared In

BeaconPlus.h

getContentsForContentWithId:error:

Gets the entire Content information related to the content id specified

- (Content *)getContentsForContentWithId:(NSString *)contentId error:(NSError **)error

Parameters

contentId

The identifier of the Content whose data the application would like to access (eg 25)

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

The Content object if content exists for the specified identifier and if the content is valid at the time of request else nil and appropriate error messages will be returned

Discussion

The application may opt to retrieve the entire information related to a content using this method. The receiver should send a valid content id else the SDK will return invalid parameter error.

Content *content = [[BeaconPlus sharedBeaconPlus] getContentsForContentWithId: < content_id >
                                                                        error: &error];

Declared In

BeaconPlus.h

getCurrentCachedSize:

Gets the total space used for caching files

- (double)getCurrentCachedSize:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

The total space occupied for caching yet else 0 and appropriate error messages will be returned if the request failed

Discussion

Sends to the receiver the total space that has been occupied for caching files.

float cachedSize = [[BeaconPlus sharedBeaconPlus] getCurrentCachedSize: &error];

Declared In

BeaconPlus.h

getDeviceTypes:

Gets the device types set for scanning

- (NSArray *)getDeviceTypes:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

The device types if set initially from app else device types set from server. Returns nil for device types and error if SDK is not initialized.

Discussion

Sends the receiver the device types set from app if set initially else the device types for scanning as got from server.

NSArray *deviceTypes = [[BeaconPlus sharedBeaconPlus] getDeviceTypes: &error];

Declared In

BeaconPlus.h

getDeviceUUID:

This method could be used to get the device unique identifier used by the SDK to communicate with the server

- (NSString *)getDeviceUUID:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

The device UDID generated within the SDK on each installation of the app if the request succeeded else nil for udid and appropriate error messages.

Discussion

The application could request for the unique identifier used within the SDK for communicating with the BeaconPlus server. The unique identifier varies across each installation of the same app as well as between different apps. It helps in identifying each user device.

NSString *deviceUDID = [[BeaconPlus sharedBeaconPlus] getDeviceUDID: &error];

Declared In

BeaconPlus.h

getFileForContentWithId:forSpot:andTagName:completion:

Get file for the specified content and tag

- (void)getFileForContentWithId:(NSString *)contentId forSpot:(NSString *)spotId andTagName:(NSString *)tagName completion:(CacheCompletion)completion

Parameters

contentId

The identifier of the content whose file the receiver would like to access (eg 25)

spotId

The identifier of the spot to which the content is assigned (eg 5)

tagName

The tag name or the property relative to the file. The SDK would send back Image files only. For Audio and Video, it will return temporary uri for accessing the files from the server and for other types it will return appropriate error messages in the cacheError param in the CacheCompletion block.

completion

The CacheCompletion (NSString filePath, BOOL isCached, NSError cacheError) block will hold the filePath to access the file from the file system if the file has been cached successfully and the isCached status will be YES with nil error. If caching can’t be done as in under the circumstances that the individual cache limit for caching has exceeded or if the file type is Video or Audio, then the filePath string will carry temporary url for accessing the file from server and the isCached status will be NO with nil error. If caching is not required for the types mentioned in the request, or if any param is invalid, or if the SDK is not yet initialized, the filePath string will be nil with isCached status set to NO and appropriate error messages in the cacheError param.

Return Value

No return value

Discussion

The information regarding files cached in memory won’t be send directly to the receiver via any other methods. The application may get access to the file by requesting for the same by specifying the content id and the tag name. The same content could be used in different spots and hence spot id is not mandatory in the request. The SDK would send back the url to access the file from the file system if the file is cached in memory or else if the file can’t be cached, then it would send a temporary url to the receiver using which the application may view the contents.

[[BeaconPlus sharedBeaconPlus] getFileForContentWithId: < content_id >
                                               forSpot: < spot_id >
                                            andTagName: < tag_name >
                                            completion: ^(NSString *filePath, BOOL isCached, NSError *cacheError) {
    if (filePath != nil) {
        NSLog(@"filepath : %@", filePath);
    }
    else if (cacheError != nil) {
        NSLog(@"error occurred : %@", cacheError.description);
    }
}];

Declared In

BeaconPlus.h

getIndividualCacheLimit:

Gets the limit set for caching individual files

- (double)getIndividualCacheLimit:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

The individual cache limit as set from server else 0 and appropriate error messages will be returned if the request failed

Discussion

Sends to the receiver the individual cache limit as set from the server. The user may put a limit to the size of the files that should be cached. Any files above this limit won’t be cached.

float individualCacheLimit = [[BeaconPlus sharedBeaconPlus] getIndividualCacheLimit: &error];

Declared In

BeaconPlus.h

getLanguage:

Gets the language set for viewing contents

- (NSString *)getLanguage:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

The language if set initially from app else language of the OS. Returns nil and error if SDK is not initialized.

Discussion

Sends the receiver the language that was set earlier by the app. If the app hasn’t set any language yet, then the SDK would return the language of the OS. Since the initialization of the SDK requires a language param, the SDK would most likely return the language set from the app.

NSString *language = [[BeaconPlus sharedBeaconPlus] getLanguage: &error];

Declared In

BeaconPlus.h

getSpotForId:error:

Gets the entire Spot information related to the spot id specified

- (Spot *)getSpotForId:(NSString *)spotId error:(NSError **)error

Parameters

spotId

The identifier of the Spot whose data the application would like to access (eg 5)

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

The Spot object if spot exists for the specified identifier else nil and appropriate error messages will be returned. Only those contents that are valid at the time of request will be delivered. Contents will be delivered in order of their proximity to the beacon and as per the priority set by the user.

Discussion

The application may opt to retrieve the entire information related to a Spot using this method. The receiver should send a valid spot id else the SDK will return invalid parameter error

Spot *spot = [[BeaconPlus sharedBeaconPlus] getSpotForId: < spot_id >
                                                   error: &error];

Declared In

BeaconPlus.h

getSpotInfoForArray:error:

Gets the spot information for the entire list of spots mentioned in the array

- (NSDictionary *)getSpotInfoForArray:(NSArray *)spotIdArray error:(NSError **)error

Parameters

spotIdArray

The list of spot id whose information the receiver would like to access (eg 5,7,etc)

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

A dictionary consisting of two key value pairs will be returned if the request succeeded. The array corresponding to the key ‘Spot info’ will contain information on all the valid spot id specified and that corresponding to the key ‘Invalid spot id’ will contain the list of invalid spot id provided. The dictionary will be nil and appropriate error messages will be send if the request failed. Only those contents that are valid at the time of request will be delivered. The order of delivery of the contents is in accordance with the proximity of the user to the device and as per the priority set.

Discussion

The application can retrieve information on any number of spots registered with the system and available to the application. The SDK handles the list of invalid spot id and those are valid differently

NSDictionary *spotInfoDict = [[BeaconPlus sharedBeaconPlus] getSpotInfoForArray: < array of spot_id >
                                                                          error: &error];

Declared In

BeaconPlus.h

initializeWithAccessToken:language:serverUrl:rangingMode:

Initializing the SDK

- (void)initializeWithAccessToken:(NSString *)accessToken language:(NSString *)language serverUrl:(NSString *)serverUrl rangingMode:(int)mode

Parameters

accessToken

The access token obtained from the BeaconPlus cloud on registering. If the application is trying to initialize the SDK with an invalid access token, error messages will be send to the receiver

language

The application can retrieve information and view contents in the language that it would like to see it by specifying the required language. Generally used syntax is en for English, ja for Japanese, etc. If the language specified by the app is not in use in the server, then it would communicate in the default language which is en. It is an optional parameter. The SDK would communicate with the server using the language set on the OS if this param is nil.

serverUrl

The application should provide the url of the server that it would like to connect to. Appropriate error messages will be send if the url mentioned is not valid or not in use in the system

mode

The mode of ranging to be used by the SDK. If mode is 0, the SDK will return onlythose beacons that meets the criteria as set by the user in admin. If mode is 1, the SDK will return all the beacons obtained on scanning output without any filtering. By default, the SDK works on mode 0.

Return Value

No return value

Discussion

The initializeWithAccessToken method should be called each time the app has been launched. This method is required for all server related operations.

[[BeaconPlus sharedBeaconPlus] initializeWithAccessToken: < your access_token >
                                                language: < preferred language >
                                               serverUrl: < server_url >];

Declared In

BeaconPlus.h

isScanningEnabled:

Gets the current status of scanning

- (BOOL)isScanningEnabled:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

YES if scanning is on progress else NO. NO and appropriate error messages will be send if the request failed

Discussion

Sends the receiver the current status of scanning

BOOL scanningStatus = [[BeaconPlus sharedBeaconPlus] isScanningEnabled:&error];

Declared In

BeaconPlus.h

postLogForContent:onSpot:error:

The method that could be used by the app if it would like to express its interest in the content (optional)

- (BOOL)postLogForContent:(NSString *)contentId onSpot:(NSString *)spotId error:(NSError **)error

Parameters

contentId

The identifier of the Content for which the application would like to write logs (eg 25)

spotId

The identifier of the Spot for which the application would like to write logs (eg 5)

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

YES if writing the log to the system succeeded else NO and appropriate error messages will be returned

Discussion

The application may opt to write logs to the system via the SDK each time it taps on a content provided from the SDK which has got tap contents registered under its tag. Such a system for writing logs will be used by the cloud to get the popular content list

BOOL postStatus = [[BeaconPlus sharedBeaconPlus] postLogForContent: < content_id >
                                                            onSpot: < spot _id >
                                                             error: &error];

Declared In

BeaconPlus.h

searchForContent:isContentName:matchExactly:shouldReturnContent:page:completion:

Get contents for the given keyword (content name or tag value)

- (void)searchForContent:(NSString *)name isContentName:(BOOL)isContentName matchExactly:(BOOL)isMatching shouldReturnContent:(BOOL)isContent page:(int)page completion:(SearchCompletion)completion

Parameters

name

The name of the content or the tag value (eg Reebok). If name is nil, then search will return the entire list of contents/spots

isContentName

The application can search for a Content using either the name of the content or the tag value. If isContentName is YES, then the search will be filtered for content names and for all tag values otherwise

isMatching

The application can opt to filter its search in such a way that either the result exactly matches the keywords provided or not. If isMatching is YES, then the Content or Spot that exactly matches the keywords will only be returned.

isContent

The receiver can request the return type as per its need. If isContent is YES, then the list of Content id matching the keywords will be returned else the list of Spot id will be returned

page

The SDK returns only 20 entries per request for search. The application can request for additional results if there are any by sending the required page number via this parameter. Minimum value is 1

completion

The SearchCompletion (NSArray result, BOOL isContent, NSError searchError) block will hold the results after the search query has executed completely. If the execution has completed successfully, then the result param in the block will contain the list of contents or spots corresponding to the search results with the isContent flag denoting the return type as specified in the search param and nil for searchError. Else if search hasn’t executed successfully, or if the SDK hasn’t initialized yet or if network is not available or if any of the params are invalid it will return the appropriate error messages.

Return Value

No return values

Discussion

The application can search for a Content using either the name of the content or the tag value. The receiver can opt to filter the search as per its needs. It can opt to receive the Content list or the Spot list

[[BeaconPlus sharedBeaconPlus] searchForContent: < keyword >
                                  isContentName: < YES / NO >
                                   matchExactly: < YES / NO >
                            shouldReturnContent: < YES / NO >
                                           page: < number for pagination >
                                     completion: ^(NSArray *result, BOOL isContent, NSError *searchError) {
    if(result != nil) {
        NSLog(@"result : %@", result.description);
    }
    else if(searchError != nil) {
        NSLog(@"error occurred : %@", searchError.description);
    }

}];

Declared In

BeaconPlus.h

searchForContent:tagValue:matchExactly:shouldReturnContent:page:completion:

Get contents for the given tag name and value

- (void)searchForContent:(NSString *)name tagValue:(NSString *)value matchExactly:(BOOL)isMatching shouldReturnContent:(BOOL)isContent page:(int)page completion:(SearchCompletion)completion

Parameters

name

The name of the property or the tag name (eg content_title)

value

The value corresponding to the tag name mentioned (eg Apparels)

isMatching

The application can opt to filter its search in such a way that either the result exactly matches the keywords provided or not. If isMatching is YES, then the Content or Spot that exactly matches the keywords will only be returned.

isContent

The receiver can request the return type as per its need. If isContent is YES, then the list of Content id matching the keywords will be returned else the list of Spot id will be returned

page

The SDK returns only 20 entries per request for search. The application can request for additional results if there are any by sending the required page number via this parameter. Minimum value is 1

completion

The SearchCompletion (NSArray result, BOOL isContent, NSError searchError) block will hold the results after the search query has executed completely. If the execution has completed successfully, then the result param in the block will contain the list of contents or spots corresponding to the search results with the isContent flag denoting the return type as specified in the search param and nil for searchError. Else if search hasn’t executed successfully, or if the SDK hasn’t initialized yet or if network is not available or if any of the params are invalid it will return the appropriate error messages.

Return Value

No return values

Discussion

The application can search for a Content using the name and value of a particular property. The receiver can opt to filter the search as per its needs. It can opt to receive the Content list or the Spot list

[[BeaconPlus sharedBeaconPlus] searchForContent: < tag_name >
                                       tagValue: < tag_value >
                                   matchExactly: < YES / NO >
                            shouldReturnContent: < YES / NO >
                                           page: < number for pagination >
                                     completion: ^(NSArray *result, BOOL isContent, NSError *searchError) {
    if (result != nil) {
        NSLog(@"result : %@", result.description);
    }
    else if (searchError != nil) {
        NSLog(@"error occurred : %@", searchError.description);
    }

}];

Declared In

BeaconPlus.h

setAutoCacheEnabled:error:

Call to enable or disable autocaching of contents

- (BOOL)setAutoCacheEnabled:(BOOL)status error:(NSError **)error

Parameters

status

The user may opt to enable or disable normal caching.

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

YES if autocaching is enabled or disabled successfully else NO and appropriate error messages will be returned

Discussion

The application may opt to enable or disable autocaching of contents at any point in time. The autocaching of contents gets triggered when work offline status for a particular deployment has been set on from the BeaconPlus admin and the user is about to reach the spot. By default autocaching is disabled on initializing the SDK for the first time.

[[BeaconPlus sharedBeaconPlus] setAutoCacheEnabled: < YES / NO >
                                             error: &error];

Declared In

BeaconPlus.h

setCacheEnabled:error:

Call to enable or disable caching of contents

- (BOOL)setCacheEnabled:(BOOL)status error:(NSError **)error

Parameters

status

The user may opt to enable or disable normal caching.

error

An error object containing details if the request failed. Error messages will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

YES if caching is enabled or disabled successfully else NO and appropriate error messages will be returned

Discussion

The application may opt to enable or disable caching of contents at any point in time. The caching status set thus affects only the normal caching procedure as in when the application demands file from the SDK. It won’t affect the autocaching of files which gets initiated on location updates and the user will have to handle that differently. By default caching is enabled on initializing the SDK for the first time.

[[BeaconPlus sharedBeaconPlus] setCacheEnabled: < YES / NO >
                                         error: &error];

Declared In

BeaconPlus.h

setCacheLimit:error:

Sets the total space in the application directory to be used for caching

- (BOOL)setCacheLimit:(float)limit error:(NSError **)error

Parameters

limit

The application has control to some extent on setting the space to be used for caching. Though the application may opt any value above 5 MB, it is recommended that the cache limit be controlled to some extent as huge area occupied for caching of files will reduce the total disk space

error

An error object containing details if the request failed. Error messages will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

YES if cache limit is set successfully else NO and appropriate error messages will be returned

Discussion

The application may opt to set the maximum or the total space that the SDK should use for caching of contents. By default 500 MB (500 * 1024 * 1024 bytes) is set on initializing of the SDK, but the application could change it anytime. The minimum cache limit is 5 MB (5 * 1024 * 1024 bytes)

[[BeaconPlus sharedBeaconPlus] setCacheLimit: < cache_limit >
                                       error: &error];

Declared In

BeaconPlus.h

setDeviceTypes:error:

Sets the device types to be scanned

- (BOOL)setDeviceTypes:(NSArray *)types error:(NSError **)error

Parameters

types

The application can opt to scan for a particular device type or all. The device type set from the application should match with the device types set from BeaconPlus admin. The application could just send it as an array of string with values ranging from 1 to 5 as mentioned above.

error

An error object containing details if setting the device types for scanning failed. Error messages will be send if the SDK is not yet initialized or the device types mentioned by the application is not enabled in server.

Return Value

YES if device types are set successfully else NO and appropriate error messages will be returned

Discussion

The SDK initially sets out to scan for those device types as got from server. The application could override this default setting by setting device types manually.

  • 1 - Beacon
  • 2 - BLE
  • 3 - Wifi
  • 4 - Audio
  • 5 - Barcode

    [[BeaconPlus sharedBeaconPlus] setDeviceTypes: < array of device types > error: &error];

Declared In

BeaconPlus.h

setLanguage:error:

Sets the language for viewing contents

- (BOOL)setLanguage:(NSString *)language error:(NSError **)error

Parameters

language

Generally used syntax is en for English, ja for Japanese, etc. If the language specified by the app is not in use in the server, then it would communicate in the default language which is en.

error

An error object containing details if setting language to the SDK failed. Error messages will be send if the language set from the app is not supported by the iOS device or if the SDK is not yet initialized.

Return Value

YES if language is set successfully else NO and appropriate error messages will be returned

Discussion

The application can retrieve information and view contents in the language that it would like to see it by specifying the required language.

[[BeaconPlus sharedBeaconPlus] setLanguage: < preferred language >
                                     error: &error];

Declared In

BeaconPlus.h

setLogLevel:error:

This method could be used to set the level of logging in the SDK

- (BOOL)setLogLevel:(int)logLevel error:(NSError **)error

Parameters

logLevel

The level of logging that the app developer would like to implement in the SDK

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized or if the params are invalid.

Return Value

Success if log level is set else NO and appropriate errorparams will be sent.

Discussion

The application could override the level of logging that should be followed in the SDK. By default, this value would be 0, which means no logging.

The different level of logging supported by the SDK:

ProcessLogLevel - 0, ErrorLogLevel - 1, WarningLogLevel - 2, InfoLogLevel - 3, DebugLogLevel - 4

BOOL levelSet = [[BeaconPlus sharedBeaconPlus] setLogLevel: < preferred log level >
                                                     error: &error];

Declared In

BeaconPlus.h

startScanning:

A call to this method initiates the scanning process for the device types specified

- (BOOL)startScanning:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error messages will be send if the SDK is not yet initialized, if no spots are added for ranging, if no devices are registered for detection or if bluetooth is disabled.

Return Value

YES if scanning started successfully else NO and appropriate error messages will be returned

Discussion

Starts the process of scanning for devices with the device types specified. The application may select the device types that should be used for identifying the location or the SDK would use the device types set from server.

BOOL status = [[BeaconPlus sharedBeaconPlus] startScanning: &error];

Declared In

BeaconPlus.h

stopScanning:

A call to this method stops the scanning process for the device types specified

- (BOOL)stopScanning:(NSError **)error

Parameters

error

An error object containing details if the request failed. Error message will be send if the SDK is not yet initialized.

Return Value

YES if scanning has been stopped successfully else NO and appropriate error messages will be returned

Discussion

Stops scanning for devices with the device types specified. The application may opt to stop scanning for one or more of the services that it had started before.

BOOL status = [[BeaconPlus sharedBeaconPlus] stopScanning: &error];

Declared In

BeaconPlus.h

unregisterPushNotification:

Unregister push notifications if already enabled for the device.

- (void)unregisterPushNotification:(TokenCompletion)completion

Parameters

completion

The TokenCompletion block (BOOL isUpdated, NSError *error) will contain the information if unregistering from push notifications has successfully completed or not. It will contain appropriate error messages for failures.

Return Value

No return values

Discussion

The application may opt to stop receiving push notifications anytime.

[[BeaconPlus sharedBeaconPlus] unregisterPushNotification:< completion object >];

Declared In

BeaconPlus.h

updateDeviceTokenForPushServices:completion:

Uses the device token received from the app for enabling push services

- (void)updateDeviceTokenForPushServices:(NSString *)deviceToken completion:(TokenCompletion)completion

Parameters

deviceToken

The device token received by the app from APNS.

completion

The TokenCompletion block (BOOL isUpdated, NSError *error) will contain the information if the device token was successfully updated to server or not. It will contain appropriate error messages for failures.

Return Value

YES if device token is saved successfully else NO and appropriate error messages will be returned

Discussion

The application could receive push messages if appropriate pem files are updated to BeaconPlus cloud from the admin site.

[[BeaconPlus sharedBeaconPlus] updateDeviceTokenForPushServices: < device token >
                                                     completion: < completion object >];

Declared In

BeaconPlus.h