Integration Code Field Guide - iOS

Depending on your schema, your integration code will have a variety of commands to call in your SDK. This article covers each command option and what they represent.

Register

Registering an object is how you relate your application data with the schema you had created.

registerUser
Mandatory - Registers your users and associated fields

registerInteraction
Mandatory - Registers your users’ interactions with your content.

registerObject
Optional - Registers any content within your software, such as features, articles, merchandise, etc.

💡
IMPORTANT NOTE: All objects and fields will need to be defined in the schema in order for these calls to work. You can read more about schema definitions in Generate A Schema.

Add Field

The add*Field relates to the different field values within your schema (username, genre, author, last sign-in, date of birth, etc). They’re broken down as:

for user:
updateUserTextField(*)
for object:
updateTextField(*)
Related to text-based entries in your schema (for example: names, bios, posts, etc)
 
Example: update_user_text_field(‘bio’, ‘my great bio’);

for user:
updateUserNumericalField(*)
for object:
updateNumericalField(*)
Relates to numerical entries in your schema (for example: phone numbers, ISBN codes, etc)
 
Example: add_numerical_field(’Book’, ‘price’, 32);

addBooleanField(*)
Relates to boolean entries (for example, active/inactive, true/false, etc)
 
Example: add_boolean_field(’Book’, ‘is_ebook’, True);

addCategoricalField(*)
Relates to categorical fields in your schema
 
Example: add_categorical_field(’Book’, ‘genre’, ‘fiction’);

addLocationField(*)
Relates to latitude/longitude co-ordinates in your schema.
 
Example: add_location_field(’User’, ‘present_location’, );

addDateField(*)
Refers to date fields in your schema.
⚠️
HEADS UP: In Python, the date format is required to follow dd-mm-yyyy. For example, July 10th, 1985 will need to be expressed as 10-07-1985.

Each call will follow the source key and value in parenthesis. For example, if under the “book” object a “book title” field is present, a call will be available for:
begin_Worker.add_text_field('Book', 'book_title', 'Thinking fast & slow.')

Learn

learnFromData call will generate an anonymized signature using the registered content and submit to Begin AI’s servers for learning.