Cllent Mobile Api Reference

Use Cabrillo JS to build custom mobile experiences inside of ServiceNow AI Platform native mobile apps.

Use the ServiceNow Mobile SDK to leverage the functionality and resources of the ServiceNow platform within your standalone mobile Android and iOS applications.

The AuthorizationToken class provides the authorization token provided by the host application. Used by the NowSDK to authorize access to a specified ServiceNow instance for the currently logged in user.

The name space for Cabrillo JS attachment functions. This enables adding and viewing attachments.

Cabrillo JS camera functions to provide camera access for bar code scanning.

These are the constants used by Cabrillo JS.

These are common data types used by Cabrillo JS APIs.

Cabrillo JS functions for managing the flow of a web view.

Cabrillo JS functions to display messages in the native UI.

Cabrillo JS functions for presenting web content inside of native modals.

Cabrillo JS is a client side JavaScript API for accessing capabilities inside ServiceNow native mobile applications.

Cabrillo JS functions for forward and backward navigation.

The name space for Cabrillo Now App functions. This enables you to interact with screens inside of ServiceNow AI Platform native mobile apps.

Cabrillo JS functions to provide access to native UI elements like buttons and spinners.

The Call interface represents a request that is prepared for processing.

The FetchConfiguration class provides the ability to define the configuration for fetching records from the associatedServiceNow table.

The FetchConfiguration structure provides the ability to define the configuration for fetching records from your ServiceNow instance.

The FieldReadConfiguration class provides the ability to define what fields to return or not return in a response record.

The FieldReadConfiguration structure enables you to configure which fields to fetch from a ServiceNow instance table and in which format.

The FieldWriteOptions class provides functions that set the options for updating or creating fields in a record on a ServiceNow instance.

The FieldWriteOptions class provides functions that set the options for updating or creating fields in a record on a ServiceNow instance.

The Filter class provides the ability to configure filters that define the data to return in the return results of a REST endpoint query.

The Filter structure provides the ability to configure filters that define the data to return in the return results of a REST endpoint query.

Provides methods to get and set input values on input form screens, as well as display messages.

Provides methods to call script includes from Mobile UI Rule Actions.

The Mobile SDK for Android provides the classes necessary to interface Android devices with the ServiceNow platform.

The Mobile SDK for iOS provides the classes necessary to interface iOS-based devices with the ServiceNow platform.

A function from the NotSupportedPushError class is thrown when the NowPushSDK cannot process the push notification request. When this type of error is thrown, you must parse and handle the push notification outside of the MobileSDK framework.

The NowAPIEndpoint protocol provides an interface for accessing any publicly exposed ServiceNow REST APIs.

The NowAPIService interface provides the ability to perform requests on a specified ServiceNow REST API.

The NowAPIService class provides functions that enable you to perform requests to a specified ServiceNow REST API.

The NowAttachment class provides an object that contains an attachment and its associated metadata.

The NowAttachment structure provides functions that enable you to validate attachments by comparing their computed hash.

The NowAttachmentMetadata class provides functions that enable you to encode and manage attachment metadata.

The NowAttachmentMetadata structure provides functions that enable you to encode and manage attachment metadata.

The NowAttachmentService class provides functions that enable you to upload and query attachments that are associated with records within a table on a ServiceNow instance.

The NowAttachmentService interface provides functions that enable the manipulation of file attachments and their associated metadata.

The NowAttachmentUploadConfiguration structure enables you to define the configuration information for an attachment that you are uploading to your ServiceNow instance.

The NowChatColoring protocol defines default colors for the elements in the Live Agent and Virtual Agent chat UI.

The NowChat API is a top-level global API that enables users to instantiate a NowChat service instance.

The NowChatConfiguration class enables you to configure options on a chat session, such as showing a prompt before closing a chat window, disabling features while using chat, applying different conversation options when using chat, and configuring UI components in NowChat.

Configures options on a chat session.

The NowChatService class provides the function necessary to create a NowChatService that interacts with NowChat. NowChat provides the ability to embed Live Agent and Virtual Agent within your application.

The NowChatSdkCallbacks interface provides functions that enable callbacks for host applications to configure or handle actions from the NowChatSDK.

The NowChatService class provides functions that enable you to launch the NowChat activity and set error configurations.

The NowChatServiceDelegate protocol provides callbacks for notification of actions within the NowChatService such as a request to open a URL or dismiss the chat view controller.

The NowChatService class provides Virtual and Live Agent chat capabilities.

The NowChatThemeable protocol provides properties that enable you to override the colors used within chat pages hosted on your ServiceNow instance.

The NowChatTheme interface defines default colors for the elements in the Live Agent and Virtual Agent chat UI.

The NowCoreService class provides fundamental services to the various SDK feature services. This class should only be instantiated by NowSDK.

The NowData framework contains methods that enable the instantiation of NowData services, such as NowGraphQLService, NowTableService, NowAPIService (for custom APIs), and NowAttachmentService.

The NowDataSDK class provides functions that enable the creation and initialization of various features services such as NowGraphQLService, NowAttachmentService, NowTableService, and NowAPIService.

The NowGraphQLService interface provides functions that allow you to make GraphQL requests to your ServiceNow through its GraphQL API.

The NowGraphQLService class provides functions that enable you to make requests using GraphQL queries against data on your ServiceNow instance through its GraphQL REST API.

The NowLoggingService class provides functions that provide logging capabilities to feature services with the NowSDK.

The NowPush API is a top-level global API that enables users to instantiate a NowPush service instance.

The NowPushPayload interface defines the push notification payload that the NowSDK implements.

NowPushPayload is a generic protocol you can use to define a push notification protocol within the NowSDK framework.

The NowPushSDK class provides the function necessary to create a NowPushService that enables the sending of unsolicited (push) notifications to Android devices.

The NowPushService class provides functions that enable interaction with the Push Notification service.

The NowPushService class provides functions that enable interaction with the Push Notification service.

The NowRecord class defines a model that represents a record in a table on a ServiceNow instance.

The NowSDK class is a singleton that provides the public API for the NowSDK. This class is the gateway to all Android SDK feature services.

The NowSDK framework contains methods that enable the instantiation of various feature services.

The NowSDKAuthorizationProviding interface provides a function that configures the link to the ServiceNow instance for which authorization is needed and any associated callbacks.

The NowSDKConfiguration class contains configuration information needed to initialize the NowSDK.

The NowSDKConfiguration class contains configuration information needed to initialize the NowSDK.

The NowServiceConfiguration class enables you to configure the ServiceNow instance URL and package name for a feature service.

The NowServiceConfiguration structure defines configuration information for a feature service.

The NowServiceError sealed class that returns NowSDK errors.

The NowService protocol provides a single interface to the NowSDK for all feature services. It defines the configuration parameters needed to access your ServiceNow instance.

The NowTableService interface provides functions that enable you to create, read, delete, and update records within a table on a ServiceNow instance.

The NowTableService class provides functions that enable you to perform create, read, update, and delete operations on records of existing ServiceNow tables.

Provides callback functions for voice session lifecycle and content events.

Specifies callbacks for voice session lifecycle and content events.

Describes a voice agent endpoint.

Describes a voice agent endpoint.

NowVoice is a top-level global API for embedding voice agent sessions in iOS applications.

The NowVoiceSDK factory object creates NowVoiceService instances.

Manages voice agent sessions for a single ServiceNow instance.

The NowVoiceService class manages voice agent sessions for a single ServiceNow instance.

Customizes the visual appearance of the voice agent UI.

A prebuilt dark theme implementation of NowVoiceTheme.

Specifies presentation options for the voice agent UI.

The NowWebColoring protocol provides default values for the colors used within web pages hosted on your ServiceNow instance in a native web view.

The NowWeb API is a top-level global API that enables uses to instantiate a NowWeb service instance.

The NowWebSDK class provides a single function that enables you to load web pages hosted on your ServiceNow instance in a native web view and Cabrillo. It automatically handles user authentication and session management instead of forcing users to log into the instance through a login web page.

The NowWebService class provides a function that launches a NowWebActivity that hosts a web view.

The NowWebService class provides functions that enable the browsing of web pages on a ServiceNow instance.

The NowWebThemeable protocol provides properties that enable you to override the colors used within web pages hosted on your ServiceNow instance in a native web view.

The NowWebTheme interface provides properties that enable you to override the colors used within web pages hosted on your ServiceNow instance in a native web view.

The NowWebViewServiceDelegate API provides callbacks for notification of issues within the NowWebService processing such as when a flow ends or a navigation fails.

The default implementation of NowVoiceThemeable.

Sets the colors to apply to NowVoice UI elements.

Represents a single message in the voice session transcript.

Specifies presentation options for the voice agent UI.

The NowWebViewController class provides functions that enable you to manage a web viewer.

The NowWebViewControllerDelegate protocol provides callbacks for notification of issues within the NowWebViewController processing such as when a flow ends or a navigation fails.

The Paginator class provides functions for paging through the return results passed back by a REST endpoint call, such as those returned by the NowTableService class.

The Paginator class provides methods for iterating through a record set returned by a call to the ServiceNow Table API through the NowTableService. It is the object that is returned by the NowTableService paginator() methods. Do not call this method outside of that environment.

Represents a single message in the voice session transcript.