Support & Downloads

Quisque actraqum nunc no dolor sit ametaugue dolor. Lorem ipsum dolor sit amet, consyect etur adipiscing elit.

j j

Contact Info
New York +(123) 456 -7890 innovio@mikado-themes.com 184 Main Street Victoria 8007
Folow us on social

IOS SDK API REFERENCE

Setting User Information
You can set user-specific information. This information will be displayed in your dashboard along with the automatically collected user properties.
These methods can be called any time after calling Averous start:.



+(void)setUserID:(NSString*)userID

Sets the application specific user identifier. Pass nil to log out the current user.

Parameters:
userID : The application-specific user identifier

Note: User ID should not exceed 256 UTF-8 bytes and must not contain HTML tags, or any personal data (e.g. name, email, phone number).



+(void)setUserProperty:(NSString*)propertyName withValue:(id)propertyValue

Sets a single property for the current user.

Parameters:
propertyName : The name of the property to set. Must be an NSString.
propertyValue : The value of the property to set. Properties must be NSNumbers, NSStrings, NSDates, NSURL, or NSArray of NSStrings.

Note: Property keys should be shorter than 256 characters and may not contain the dot (‘.’) or dollar (‘$’) signs – they will be trimmed.
String values should be shorter than 1000 characters.



+(void)setUserProperties:(NSDictionary*)userProperties

Sets multiple (key-value) properties for the current user.

Parameters:
userProperties : The user properties to set. Keys must be NSStrings. Properties must be NSNumbers, NSStrings, NSDates, NSURL, or NSArray of NSStrings.

Note: Property keys should be shorter than 256 characters and may not contain the dot (‘.’) or dollar (‘$’) signs – they will be trimmed.
String values should be shorter than 1000 characters.



+(void)incUserProperty:(NSString *)propertyName incrementBy:(NSNumber *)value

Increment the value of a numeric property.

Parameters:
propertyName : The name of the user property
value : The value to increment or decrement by (if negative)



+(void)appendToUserProperty:(NSString *)propertyName listItem:(NSString *)item

Append an item to a list property.

Parameters:
propertyName : The name of the user property
item : The item to append



+(void)removeUserProperty:(NSString*)propertyName

Unsets a property for the current user.

Parameters:
propertyName : The name of the user property


+(void)setLocation:(double)latitude longitude:(double)longitude
horizontalAccuracy:(float)horizontalAccuracy
verticalAccuracy:(float)verticalAccuracy

 

Sets the current user location.

Parameters:
latitude : Latitude in degrees.
longitude : Longitude in degrees.
horizontalAccuracy : Horizontal accuracy.
verticalAccuracy : Vertical accuracy.



+(void)setLocationDescription:(NSString*)description

Sets the current user location’s description.

Parameters:
description : A custom string representing the user’s location.



Averous.setUserID("1234");

 

Averous.setUserProperty(“Role”, withValue:”Administrator”);

Averous.setUserProperties([“Role” : “Administrator”,
“AmountPaid” : 3.2,
“RegistrationDate” : NSDate()]);

Averous.incUserProperty(“AmountPaid”, incrementBy:3);
Averous.appendToUserProperty(“VisitedCities”, listItem:”New York”);
Averous.removeUserProperty(“Role”);

Averous.setLocationDescription(“Office”);

Masking Sensitive Views

You can mark UIViews as sensitive, so that their contents will be hidden in the video. These methods can be called any time
after calling
Averous start:.



+(void)markViewAsSensitive:(UIView*)view

Marks a view as sensitive. The view will be blanked out in the video (and also the keyboard attached to it).

Parameters:

view : A UIView object which contains sensitive information.



+(void)unmarkViewAsSensitive:(UIView*)view

Unmark a view as sensitive. Unmarking a view will also prevent future auto-detected views from being masked.

Parameters:

view : A UIView object which no longer contains sensitive information.


Masking Web Views with CSS ClassesAverous automatically hides text fields contained in UIWebViews. To unhide a specific
text element, you can add the ‘Averous-ignore’ class, i.e.:
class="Averous-ignore"
To hide a specific element, you can add the ‘Averous-hide’ class, i.e.:


Averous.markView(asSensitive: myView)
Averous.unmarkView(asSensitive: myView)

Setting Application Screens
Averous automatically detects the different screens in your app. However in some cases where screen detection is not available (for example in opengl apps) you can
set screens manually.



(void)startScreen:(NSString*)screenName

Mark the appearance starting time of a new screen. This method should be usually called from the viewDidAppear: method.

Parameters:
screenName : The name of the screen (ie: “WelcomeScreen”).

Note: Screen name should not exceed 256 UTF-8 bytes.


Code Example


Averous.startScreen("MyScreen");

Adding Application Events

You can add timed application events, such as reaching at a specific screen or level.

You will see these events in your dashboard along with the video, and you will be able to filter videos according to these events.
Adding events is also useful for controlling which sessions are recorded, using a recording condition. For example: you can choose to record
sessions of users which reached a specific level.
These methods can be called any time after calling Averous start:.



+(void)addEvent:(NSString*)eventName

Add a timed application event (such as: user reached a specific level or screen).

Parameters:
eventName : The name of the event (ie: “InAppPurchase”).



+(void)addEvent:(NSString*)eventName withProperties:(NSDictionary*)properties

Add a timed application event (such as: user reached a specific level or screen) along with custom properties.

Parameters:
eventName : The name of the event (ie: “Level”).
properties : Key-value pairs with custom properties for the event. Properties must be NSNumbers, NSStrings, NSDates, NSURL, or NSNull. Keys must be NSStrings.

Note: The total size of event name, property key and value should not exceed 300 bytes (per property). Strings are UTF-8 encoded. Events that exceed this limit will be ignored.
Property keys may not contain the dot (‘.’) or dollar (‘$’) signs – they will be trimmed.


Code Example


Averous.addEvent("Purchase");
Averous.addEvent("Purchase", withProperties: ["ItemType" : "Shoes",
"ItemModel" : "Nike",
"Price" : 3.2,
"PurchaseDate" : NSDate()])

Adding Screen Actions

Averous automatically detects actions performed on native UI components. To denote actions performed on non-native components you can manually tag custom screen actions.



(void)addScreenAction:(NSString*)actionName

Add a custom action to the current screen.

Parameters:
actionName : The name of the action (ie: “MyButtonClick”).

Note: Action name should not exceed 256 UTF-8 bytes.


Code Example


Averous.addScreenAction("MyButtonClick");