Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

 

Session Callbacks

Use the following SDK callbacks methods from the ISessionCallbacks interface to override these methods to suit your app.
 

Copiedfun sessionConnectionState(state: LensType, error: ErrorType? = null, message: String)
Called when session connection state changes.

The possible values of LensType are,

  • ERROR
  • CLIENT_IS_NOT_COMPATIBLE
  • BELOW_MIN_API_LEVEL
  • CONTEXT_NOT_AVAILABLE
  • INVALID_SDK_TOKEN
  • INVALID_SESSION_KEY
  • SESSION_CONNECTED
  • SESSION_INVALID
  • CLIENT_INVALID
  • SESSION_EXPIRED
  • DUPLICATE_CLIENT
  • CLOSED_SESSION
  • TECHNICIAN_CLOSED_SESSION
  • CUSTOMER_CLOSED_SESSION
  • SERVER_ISSUE_LEFT_SESSION
  • NETWORK_CONNECTED
  • NETWORK_DISCONNECTED
  • NO_NETWORK

 

Copiedfun chatMessage(message: ChatModel)

Called when participant receives chat messages.

Copiedfun onLensScreenShotTaken(displayName: String?)

Called when screenshot has been taken by technician.

Copiedfun handleAudioMute(isMute: Boolean)

Called when audio mute status is changed.

Copiedfun audioDeviceChange(selectedAudioDevice: AppRTCAudioManager.AudioDevice, availableAudioDevices: MutableSet<AppRTCAudioManager.AudioDevice>)
Called when the currently used audio device is changed.

The possible values for `AudioDevice` are,

  • SPEAKER_PHONE
  • EARPIECE
  • BLUETOOTH
  • WIRED_HEADSET
  • NONE

Copiedfun updateTechnicianList(technicians: ArrayList<ParticipantStatus>)

Called when there are changes in the list of technicians who are currently participating in the session.

Copiedfun log(tag: String, message: String)

Called for log statements in the SDK.

Copiedfun showToast(type: LensToast,displayName:String?)
Called when toast needs to be shown for a `LensToast` case.

The possible values of `LensToast` are,

  • JOINED_PARTICIPANT
  • LEFT_PARTICIPANT
  • CAMERA_STREAM_CHANGED
  • CAMERA_STREAM_REMOVED
  • CAMERA_STREAM_REQUEST_APPROVED
  • CAMERA_STREAM_REQUEST_DENIED
  • CAMERA_STREAM_REQUEST_SOMEONE_WAITING_ALREADY

 

Copiedfun showArTrackingListenerToast(trackingState: TrackingState, trackingFailureReason: TrackingFailureReason)
Called when toast message needs to be shown to user, since AR tracking has failed due to a `TrackingFailureReason`.

The possible values of `TrackingState` are,

  • TRACKING
  • PAUSED
  • STOPPED

The possible values of `TrackingFailureReason` are,

  • NONE
  • EXCESSIVE_MOTION
  • INSUFFICIENT_FEATURES
  • INSUFFICIENT_LIGHT
  • BAD_STATE

Copiedfun getActivity(): Activity?

Used by the SDK to get the activity in which the session is being conducted.

Copiedfun showStreamingType(type: StreamingType, displayName:String?)
Called when the `StreamingType` for the user changes, which can be used by the application to update UI to show buttons/warning/etc that is appropriate for the `StreamingType`.

The possible values of `StreamingType` are,

  • VIDEO_UPSTREAM
  • VIDEO_DOWNSTREAM
  • NO_ONE_IS_STREAMING

Copiedfun onFPSUpdate(averageFPS: Int, fifteenthSecondFPS: Int)

Called every 15 with the average FPS of the session, and the FPS at the last second before callback is called. Only available for AR sessions.

Copiedfun onCameraSwapDone(isFrontCamera: Boolean)

Called when camera has been swapped from front to rear camera or vice versa. `isFrontCamera` will be true if the currently streaming camera is the front camera, it will be false if it is the rear camera.

Copiedfun onOCRStateChanged(ocrStateModel: OCRStateModel)

Called when OCR state has been changed. The `OCRStateModel` will be called with three possible values for `OCRState`,  

  • STARTED - OCR request has been raised and is being processed by LensSDK.
  • COMPLETED - OCR scan has been completed successfully. The result text & associated confidence score will be available in the `ocrStateModel`.
  • ERROR- Error has occurred whilst trying to take/scan OCR, the `ocrStateModel` will contain the error message for the error.

Copiedfun onQRScanStarted()

Callback used to handle when qr scan started.

Copiedfun onQRSuccess(qrText: String)

Called when QR scan has been completed successfully.

Copiedfun onQRFailure(errorMessage: String, willRetry: Boolean)

Called when QR scan has failed. If the value of `willRetry` is true, then the QR scan will be conducted again.

Copiedfun onChatLetReverted(status: Boolean)

Called when any issue was faced while creating the webview based chat. When this callback is triggered, SDK will revert to providing chat messages via `chatMessage(message: ChatModel)`

Copiedfun chatLetState(currentStatus: ChatLetState)

Called when the webview chat state changes.

  • LOADING - Chat webview is in the process of loading.
  • SUCCESS - Chat webview has been loaded and is ready to be displayed.
  • ERROR - There is an issue with loading the chat.
Copiedfun onArAnnotationPlaced(arAnnotationObject: ArAnnotationObject)

Called when AR annotation is placed by any participant.

Copiedfun onArAnnotationRemoved(removedAnnotationList: ArrayList<ArAnnotationObject>)

Called when AR annotations are removed by any participant.

Copiedfun onArAnnotationSelected(arAnnotationObject: ArAnnotationObject)

Called when AR annotation is selected by the customer.

Copiedfun onArAnnotationDeSelected(arAnnotationObject: ArAnnotationObject)

Called when AR annotation is deselected by the customer.

Copiedfun onArAnnotationListUpdate(arAnnotationList: ArrayList<ArAnnotationObject>)

Called when the list of AR annotations is updated by any participant.

Copiedfun onArAnnotationNotesUpdate(arAnnotationObject: ArAnnotationObject)

Called when the comment associated with an AR annotation is updated by any participant.

Copiedfun customerAlreadyActiveInSession()

Called if the customer is already active in a session.

Copiedfun onMicroPhoneUsingByOtherApps()

Called when the microphone is being used by other applications. Deprecated, will be removed in next release.

Copiedfun onAnnotationsCountUpdated(annotationCount: Int?)

Called when annotations are added/removed, resulting in a change in the annotation count.

Copiedfun onFlashLightOn(flashSupportStatus: FlashSupportStatus, displayName: String?)

Called when flash is switched on for the technician. FlashSupportStatus is used to determine if flash has been successfully switched on.

  • SUCCESS - Flash light has been successfully turned on.
  • FAILED - Failed to turn on the Flash light.
Copiedfun onFlashLightOff(flashSupportStatus: FlashSupportStatus, displayName: String?)

Called when flash is switched off for the technician. FlashSupportStatus is used to determine if flash has been successfully switched off.

  • SUCCESS - Flash light has been successfully turned off.
  • FAILED - Failed to turn off the Flash light.
Copiedfun onFlashLightOff(flashSupportStatus: FlashSupportStatus, displayName: String?)

Called when camera freeze or snapshot action is called. The possible values for `Freeze actions` are,

  • FREEZE_VIDEO
  • UNFREEZE_VIDEO
  • FREEZE_SNAPSHOT
  • UNFREEZE_SNAPSHOT
  • FREEZE_SNAPSHOT_SELF
  • UNFREEZE_SNAPSHOT_SELF
  • FREEZE_SNAPSHOT_DOWNLOADED
  • FREEZE_SNAPSHOT_DOWNLOAD_FAILED
Copiedfun onFreezeActions(freezeActions: FreezeActions, displayName: String?)

Callback used to handle the device lock state.

Copiedfun onDeviceLockStateChanged(deviceLockState: DeviceLockState, displayName: String?)

Callback used to handle for features availability based on the license.