Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_partials/_cuf_date_valuetype.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Values of type `Date` in `Custom User Fields (custom_user_fields)` should be in UNIX epoch time in <u>seconds</u>.
8 changes: 6 additions & 2 deletions docs/sdkx-cocos2dx/identity-user-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [install API](/sdkx-cocos2dx/getting-started#initializing)
Expand Down Expand Up @@ -193,7 +195,8 @@ Global attributes must be one of the following types -
- `new_tags` - List< String >
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map< String, String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-cocos2dx/delegates/#user-identity-system-events) page.
Expand Down Expand Up @@ -240,7 +243,8 @@ App specific attributes must be one of the following types -
- `user_level` - String
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map< String, String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-cocos2dx/delegates/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx-react-native/identity-user-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Helpshift.install() API](/sdkx-react-native/getting-started/#adding-to-project)
Expand Down Expand Up @@ -186,6 +188,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - Array< String >
- `reset_tags` - Array< String >
- `custom_user_fields` - object<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-react-native/delegates/#user-identity-system-events) page.
Expand Down Expand Up @@ -238,6 +241,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - object<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-react-native/delegates/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx-unity/identity-user-hub-android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Helpshift.install() API](/sdkx-unity/getting-started-android#adding-to-project)
Expand Down Expand Up @@ -252,6 +254,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unity/delegates-android/#user-identity-system-events) page.
Expand Down Expand Up @@ -312,6 +315,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unity/delegates-android/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx-unity/identity-user-hub-ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Helpshift.install() API](/sdkx-unity/getting-started-ios/#initializing)
Expand Down Expand Up @@ -252,6 +254,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unity/delegates-ios/#user-identity-system-events) page.
Expand Down Expand Up @@ -312,6 +315,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unity/delegates-ios/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx-unreal/identity-user-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Init() API](/sdkx-unreal/getting-started/#initializing)
Expand Down Expand Up @@ -187,6 +189,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unreal/delegates/#user-identity-system-events) page.
Expand Down Expand Up @@ -237,6 +240,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx-unreal/delegates/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx_android/identity-user-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Helpshift.install() API](/sdkx_android/getting-started#start-using)
Expand Down Expand Up @@ -199,6 +201,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

<Admonition type="info" title="Note">

Expand Down Expand Up @@ -247,6 +250,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx_android/delegates/#user-identity-system-events) page.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdkx_ios/identity-user-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
Image,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

<Admonition type="info" title="Note">

All the public APIs in the SDK should be called after initializing the SDK via [Helpshift installWithPlatformId API](/sdkx_ios/getting-started#start-using)
Expand Down Expand Up @@ -263,6 +265,7 @@ Global attributes must be one of the following types -
- `tags_to_remove` - List< String >
- `reset_tags` - List< String >
- `custom_user_fields` - Map<String, String>
- <CUFDateTypeNotice />

<Admonition type="info" title="Note">

Expand Down Expand Up @@ -329,6 +332,7 @@ App specific attributes must be one of the following types -
- `app_status` - String
- `lifetime_value` - String // String value of Integer
- `custom_user_fields` - Map<String,String>
- <CUFDateTypeNotice />

This API leverages the existing Helpshift delegates system to notify the app in case of any errors.
For more details on the error events that can be triggered by this API, please refer the [Delegates](/sdkx_ios/delegates/#user-identity-system-events) page.
Expand Down
54 changes: 34 additions & 20 deletions docs/web-chat/identity-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import {
Step,
} from "@site/src/components/forDocs";

import CUFDateTypeNotice from "@site/docs/_partials/_cuf_date_valuetype.mdx";

# User Hub {#user-hub}

The new Identity System provides many advantages, with minimal efforts (as outlined below) over the legacy method, in the form of faster context collection,
Expand Down Expand Up @@ -236,25 +238,29 @@ interface GlobalUserData {
last_name?: "string",
full_name?: "string",
display_name?: "string",
last_country?: "string",
last_country?: "string", // Full country name or country code, as per ISO-3166
last_city?: "string",
age?: "string",
lifetime_value?: "string",
age?: "string", // String value of Integer; 0 < age < 150
lifetime_value?: "string", // String value of Integer
user_persona?: "string",
user_vip_segment?: "string",
user_support_status?: "string"
last_active_date?: "string" // epoch time in ms/seconds
accepted_t_and_c?: "string" // true/false converted to string
preferred_language?:"string"
user_support_status?: "string",
last_active_date?: "string", // UNIX epoch time in seconds
accepted_t_and_c?: "string", // true/false converted to string
preferred_language?:"string", // ISO639-1 language code

// Non-primitives
new_tags?: Array<string>
tags_to_remove?: Array<string>
reset_tags?: Array<string>
custom_user_fields?: CustomUserFields
new_tags?: Array<string>,
tags_to_remove?: Array<string>,
reset_tags?: Array<string>,
custom_user_fields?: CustomUserFields // Values of type Date should be in UNIX epoch time in seconds.
}
```

<Admonition type="info" title="Important">
<CUFDateTypeNotice />
</Admonition>

Example:
```js
// ... Some custom logic here that obtains user data
Expand Down Expand Up @@ -286,27 +292,35 @@ interface CustomUserFields {

interface AppUserData {
// Note that all primitive values must be coerced to string
app_version: "string",
app_version: "string", // Maximum length of 10 characters
user_vip_segment: "string",
sdk_version: "string",
language:"string",
language:"string", // ISO639-1 language code
app_rating: "string",
user_paying_segment: "string",
country: "string"
user_support_status: "string"
user_persona: "boolean string"
accepted_t_and_c: "string"
user_paying_segment: "string", // Must be one of the following values:
- `low_paying`
- `medium_paying`
- `high_paying`
- `non_paying`
country: "string", // Full country name or country code, as per ISO-3166
user_support_status: "string",
user_persona: "boolean string",
accepted_t_and_c: "string", // true/false converted to string
user_level: "string",
app_status: "string",
city: "string",
lifetime_value: "string",
lifetime_value: "string", // String value of Integer


// Non-primitives
custom_user_fields?: CustomUserFields
custom_user_fields?: CustomUserFields // Values of type Date should be in UNIX epoch time in seconds.
}
```

<Admonition type="info" title="Important">
<CUFDateTypeNotice />
</Admonition>

Example:
```js
// ... Some custom logic here that obtains user data
Expand Down
2 changes: 1 addition & 1 deletion src/data/navbar.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"alt": "Helpshift",
"src": "img/helpshift-kws-logo.svg",
"srcDark": "img/helpshift-kws-logo-white.png",
"style": {"height": "50px"}
"style": {"height": "40px"}
},
"items": [
{
Expand Down
Loading