Set User Identifier

Owned by Yotam Wimmer (Unlicensed)
Last updated: Jul 31, 2016 by Raz Elkayam (Unlicensed)

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 will create an association between a user and a device

Objective-C

#pragma mark - Alias

//setDeviceAlias -  Sets the device alias, replacing the current alias value.
- (void)setDeviceAlias:(nullable NSString *)alias withCompletionHandler:(nullable AppoxeeCompletionHandler)handler;

 
//removeDeviceAlias - Removes the device alias
- (void)removeDeviceAliasWithCompletionHandler:(nullable AppoxeeCompletionHandler)handler;

 
//getDeviceAlias - Returns the device alias from the device cache
- (void)getDeviceAliasWithCompletionHandler:(nullable AppoxeeCompletionHandler)handler;

 

Swift

#pragma mark - Alias

//setDeviceAlias -  Sets the device alias, replacing the current alias value.
func setDeviceAlias(alias: String?, withCompletionHandler handler: AppoxeeCompletionHandler?)

 
//removeDeviceAlias - Removes the device alias
func removeDeviceAliasWithCompletionHandler(handler: AppoxeeCompletionHandler?)

 
//getDeviceAlias - Returns the device alias from the device cache
func getDeviceAliasWithCompletionHandler(handler: AppoxeeCompletionHandler?)