Skip to main content
Version: 8.5.x

bfgRaveAppDataKeyDelegate Protocol

To use Rave App Data Keys you must register to be a bfgRaveAppDataKeyDelegate. More...#import <bfgRave.h>

Instance Methods

(void) - bfgRaveAppDataKeyDidChange:previousKey:
 
(void) - bfgRaveAppDataKeyDidReturnUnresolvedKeys:currentAppDataKey:
 
(void) - bfgRaveSelectAppDataKeyDidSucceed
 
(void) - bfgRaveSelectAppDataKeyDidFailWithError:
 
(void) - bfgRaveFetchCurrentAppDataKeyDidSucceed:
 
(void) - bfgRaveFetchCurrentAppDataKeyDidFailWithError:
 

Detailed Description

To use Rave App Data Keys you must register to be a bfgRaveAppDataKeyDelegate.
Since
6.2.0
Note
There are some offline cases when the app data key will not be current. Going online will resolve this.

Method Documentation

◆ bfgRaveAppDataKeyDidChange:previousKey:

- (void) bfgRaveAppDataKeyDidChange: (NSString *_Nonnull) currentAppDataKey
previousKey:(NSString *_Nullable) previousKey 
required
Informs the delegate that the App Data Key changed.
Parameters
currentAppDataKeyThe current app data key selected for this application and user.
previousKeyThe previous app data key before the change.
Since
6.2.0

◆ bfgRaveAppDataKeyDidReturnUnresolvedKeys:currentAppDataKey:

- (void) bfgRaveAppDataKeyDidReturnUnresolvedKeys: (NSArray< NSString * > *_Nonnull) unresolvedKeys
currentAppDataKey:(NSString *_Nullable) currentAppDataKey 
required
Informs the delegate that there are unresolved keys.
Parameters
unresolvedKeysThe keys that need to be resolved. There will always be zero or two or more.
currentAppDataKeyThe last known selected app data key before conflict.
Since
6.2.0

◆ bfgRaveFetchCurrentAppDataKeyDidFailWithError:

- (void) bfgRaveFetchCurrentAppDataKeyDidFailWithError: (NSError *_Nullable) error
optional
Informs the delegate that fetchCurrentAppDataKey failed.
Note
In the case where you are offline and have unresolved keys or logged out while offline, calling fetchCurrentAppDataKey will call this method with nil as the error value.
Parameters
errorThe error that was encountered.
Since
6.2.0

◆ bfgRaveFetchCurrentAppDataKeyDidSucceed:

- (void) bfgRaveFetchCurrentAppDataKeyDidSucceed: (NSString *_Nonnull) currentAppDataKey
optional
Informs the delegate that fetchCurrentAppDataKey succeeded.
Parameters
currentAppDataKeyThe current app data key returned by Rave.
Since
6.2.0

◆ bfgRaveSelectAppDataKeyDidFailWithError:

- (void) bfgRaveSelectAppDataKeyDidFailWithError: (NSError *_Nonnull) error
required
Informs the delegate that selectRaveAppDataKey: failed.
Parameters
errorThe error that was encountered.
Since
6.2.0

◆ bfgRaveSelectAppDataKeyDidSucceed

- (void) bfgRaveSelectAppDataKeyDidSucceed
required
Informs the delegate that selectRaveAppDataKey: succeeded.
Since
6.2.0