An alias is a unique, user-specific identifier, set by the application owner (for example, the user's email or an internal system ID number) and is limited to 254 characters.
Aliases have the following uses:
- The app owner and Appoxee both use the same alias to identify the user.
- All devices owned by a specific user (an iPhone, an iPad etc.) are identified by the same alias.
- Aliases are used to create segments of application users, based on user-specific properties (as opposed to application-specific properties).
Note the difference between aliases and tags:
- Aliases are user-specific, and each user can only have one alias (shared by all the user's devices).
- Tags are app-specific, and you can assign multiple tags to the same device.
The alias API enables you to perform actions on a device's alias.
#pragma mark - Alias
/**
Set an alias to be identifies with a device.
@brief Method sets an alias to identify a device.
@code
[[Appoxee shared] setDeviceAlias:@"Alias" withCompletionHandler:^(NSError *appoxeeError, id data) {
if (!appoxeeError) {
// Alias was set.
}
}];
@endcode
@param alias An NSString object representing an alias.
@param handler Code Block to be executed when method completes with an NSError object and data as arguments.
*/
- (void)setDeviceAlias:(nullable NSString *)alias withCompletionHandler:(nullable AppoxeeCompletionHandler)handler;
/**
Remove an alias from a device.
@brief Method removes an alias from a device.
@code
[[Appoxee shared] removeDeviceAliasWithCompletionHandler:^(NSError *appoxeeError, id data) {
if (!appoxeeError) {
// Alias was removed.
}
}];
@endcode
An NSString object representing an alias.
@param handler Code Block to be executed when method completes with an NSError object and data as arguments.
*/
- (void)removeDeviceAliasWithCompletionHandler:(nullable AppoxeeCompletionHandler)handler;
/**
Get an alias for a device.
@brief Method gets the alias for a device.
@code
[[Appoxee shared] getDeviceAliasWithCompletionHandler:^(NSError *appoxeeError, id data) {
if (!appoxeeError && [data isKindOfClass:[NSString class]]) {
NSString *deviceAlias = (NSString *)data;
}
}];
@endcode
@param handler Code Block to be executed when method completes with an NSError object and data as arguments.
*/
- (void)getDeviceAliasWithCompletionHandler:(nullable AppoxeeCompletionHandler)handler;
/**
Clear cached value of an alias.
@brief Method clears cached value of an alias.
@code
[[Appoxee shared] clearAliasCacheWithCompletionHandler:^(NSError *appoxeeError, id data) {
if (!appoxeeError) {
// Alias cache was cleared.
}
}];
@endcode
@param handler Code Block to be executed when method completes with an NSError object and data as arguments.
*/
- (void)clearAliasCacheWithCompletionHandler:(nullable AppoxeeCompletionHandler)handler;
#pragma mark - Device Tags
/**