Element details
type: meya.orb.mobile.integration
class: OrbMobileIntegration
path: /meya/orb/mobile/integration/integration.py
signature: -
Fields
| field | description | required | signature | default | type |
|---|---|---|---|---|---|
| spec | Override the original spec for this element. | ○ | ○ | null | Spec |
| enabled | Enables the integration, allowing it to process events and HTTP/WS entries. | ○ | ○ | true | bool |
| filter | ○ | ○ | rx_sub: true rx: true tx: "\nNOT (\n meya.http.event.webhook\n OR meya.csp.event.event\n OR meya.orb.event.device\n \ OR meya.orb.event.device.connect\n OR meya.orb.event.device.heartbeat\n \ OR meya.orb.event.device.state\n)\n" tx_pub: true push_tx: "\nNOT (\n meya.analytics.event.identify\n OR meya.session.event.chat.close\n \ OR meya.session.event.chat.open\n OR meya.session.event.page.open\n OR meya.orb.event.screen.continue\n OR meya.orb.event.screen.end\n OR meya.analytics.event.track\n \ OR meya.presence.event.typing\n OR meya.presence.event.typing.on\n OR meya.presence.event.typing.off\n OR meya.orb.event.device\n OR meya.orb.event.device.connect\n \ OR meya.orb.event.device.heartbeat\n OR meya.orb.event.device.state\n)\n" | OrbMobileIntegrationFilter | |
| verify_token | The token to be verified for each incoming request. You need to add the verify_token=YOUR_TOKEN query parameter to integration's webhook URL. | ○ | ○ | null | str |
| max_attachment_size | Controls maximum attachment size supported by the integration in bytes. | ○ | ○ | null | int |
| markdown | The markdown features that are supported by this integration. Check the Markdown guide for more info. | ○ | ○ | false | list bool |
| typing | When set to false, all typing indicators received by the integration will be ignored. | ○ | ○ | true | bool |
| theme | Allows you to set the Orb's theme properties such as the brand color, etc. | ○ | ○ | brand_color: bot_avatar_monogram: bot_avatar_url: | OrbThemeElementSpec |
| composer | Allows you to set the Orb's composer properties such as placeholder, text, etc. | ○ | ○ | focus: placeholder: collapse_placeholder: visibility: character_limit: placeholder_text: collapse_placeholder_text: file_button_text: file_send_text: image_button_text: camera_button_text: gallery_button_text: upload: | OrbComposerElementSpec |
| header | Allows you to set the Orb's header properties such buttons, title, etc. | ○ | ○ | buttons: title: progress: milestones: extra_buttons: | OrbHeaderElementSpec |
| menu | Allows you to set the Orb's menu properties such as close display text. | ○ | ○ | close_text: back_text: | OrbMenuElementSpec |
| drop | Allows you to set the Orb's drag and drop properties such as the drag and drop display text. | ○ | ○ | drag_and_drop_text: | OrbDropElementSpec |
| splash | Allows you to the set the Orb Mobile SDK's splash screen properties. Note that this property is not fully observed yet, but will be in the future. | ○ | ○ | ready_text: | OrbSplashElementSpec |
| launcher | Allows you to set the Orb's launcher properties such as the launcher type, text etc. Note that this is only applicable for the Orb Web SDK and not the Orb Mobile SDK. | ○ | ○ | type: icon: text: | OrbLauncherElementSpec |
| media_upload | Allows you to configure which media types are enabled for upload. If a specific type is not specified, the all value is used. | ○ | ○ | all: file: image: | OrbMediaUploadElementSpec |
| container | The HTML container to mount the Orb in e.g. document.querySelector("#orb-mount"). Note that this is only applicable for the Orb Web SDK and not the Orb Mobile SDK. | ○ | ○ | null | str |
| session_expiry | The amount time until an Orb session expires. When the user connects after the session has expired, a new session will be created and the old session token will no longer be valid. | ○ | ○ | "4w 2d" | timedelta |
| collect | The Orb integration collects a number data points, e.g. ip address, when a user connects. This property allows you to configure in which data scope (event|thread|user) each data point should be stored. | ○ | ○ | language: user ip_address: event location: referrer: event url: event context: event | OrbCollectConfig |
| identity_verification | Verify the identity of every Orb user. If disabled, the Orb user ID becomes self-authenticating, so it is recommended to use secure random user IDs (e.g. salted hash of app user ID or email). | ○ | ○ | true | bool |
| heartbeat_interval_seconds | The period at which the Orb Mobile SDK will send a hearbeat to indicate that the device's connection is active. If you set this property to null then the Orb Mobile SDK will not send any heartbeats and push notifications will only use the reported device state to determine whether or not to send a push notification. | ○ | ○ | 30 | Real |
| inactive_timeout_seconds | The number of seconds from the last active heartbeat to wait before marking the connection as inactive. Note that this must always be greater than heartbeat_interval_seconds. | ○ | ○ | 35 | Real |
| android | This contains all the settings for push notifications on Android. | ○ | ○ | null | AndroidSpec |
| ios | This contains all the settings for push notifications on iOS. | ○ | ○ | null | IosSpec |
Usage reference
Basic
type: meya.orb.mobile.integration
Full
type: meya.orb.mobile.integration
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
enabled: false
filter:
rx_sub: STRING
rx: STRING
tx: STRING
tx_pub: STRING
push_tx: STRING
verify_token: STRING
max_attachment_size: 123
markdown:
- format|linkify|breaks|typographer
typing: false
theme:
brand_color: STRING
bot_avatar_monogram: STRING
bot_avatar_url: STRING
composer:
focus: file|image|text|blur
placeholder: STRING
collapse_placeholder: STRING
visibility: collapse|hide|show
character_limit:
length: 123
error_text: STRING
placeholder_text: STRING
collapse_placeholder_text: STRING
file_button_text: STRING
file_send_text: STRING
image_button_text: STRING
camera_button_text: STRING
gallery_button_text: STRING
upload:
progress_text: STRING
error_text: STRING
header:
buttons:
- url: STRING
javascript: STRING
button_id: STRING
context:
STRING: ANY
default: false
disabled: false
divider: false
icon:
url: STRING
color: STRING
path: STRING
action: COMPONENT
value: ANY
result: ANY
data:
STRING: ANY
magic: false
type: text|url|static|menu|divider|action|flow_next|component_next
menu:
- BUTTONELEMENTSPEC
text: STRING
title:
text: STRING
icon:
url: STRING
color: STRING
path: STRING
progress:
value: 123
show_percent: false
milestones:
- text: STRING
current: false
extra_buttons:
- url: STRING
javascript: STRING
button_id: STRING
context:
STRING: ANY
default: false
disabled: false
divider: false
icon:
url: STRING
color: STRING
path: STRING
action: COMPONENT
value: ANY
result: ANY
data:
STRING: ANY
magic: false
type: text|url|static|menu|divider|action|flow_next|component_next
menu:
- BUTTONELEMENTSPEC
text: STRING
menu:
close_text: STRING
back_text: STRING
drop:
drag_and_drop_text: STRING
splash:
ready_text: STRING
launcher:
type: orb|message|hide
icon: STRING
text: STRING
media_upload:
all: false
file: false
image: false
container: STRING
session_expiry: 60s
collect:
language: user|user_overwrite|thread|thread_overwrite|event
ip_address: user|user_overwrite|thread|thread_overwrite|event
location: user|user_overwrite|thread|thread_overwrite|event
referrer: user|user_overwrite|thread|thread_overwrite|event
url: user|user_overwrite|thread|thread_overwrite|event
context: user|user_overwrite|thread|thread_overwrite|event
identity_verification: false
heartbeat_interval_seconds: 123
inactive_timeout_seconds: 123
android:
service_account_key:
foo: bar
project_id: STRING
title: STRING
click_action: STRING
custom_data:
STRING: ANY
ios:
auth_key: STRING
auth_key_id: STRING
team_id: STRING
topic: STRING
title: STRING
sound: STRING
title_loc_key: STRING
title_loc_args:
- STRING
action_loc_key: STRING
loc_key: STRING
loc_args:
- STRING
launch_image: STRING
apns_mode: dev|prod
custom_data:
STRING: ANY