Interop external object

Official Content
This documentation is valid for:

The Interop external object (which can be found in the KB Explorer under the Smart Devices API) is used for interacting with the device using procedural programming.

Interopexternalobject-Location_png_v17u11 interopEO_png_v17u11

Properties

ApplicationState

Warning: Deprecated. Use AppLifecycle.ApplicationState instead.

Runtime state of the application. It is based on the ApplicationState domain.

SceenBrightness

Gets or sets the brightness of the device screen.

Methods

SendMessage method

Sends a message to a contact without specifying the channel (it can be a phone number, an email address, a Facebook account, etc).
Check HowTo: Using SendMessage from Interop in Smart Devices.

Return value  None
Parameters Message:VarChar(200), To:Character(60)
 

PlayVideo method

Plays a video from its URI (e.g. by 'http', 'file' or 'data' schemes).
Check HowTo: Using PlayVideo from Interop in SDApi for Smart Devices.

Return value  None
Parameters Video:URL
 

PlayAudio method

Plays an audio from its URI (e.g. by 'http', 'file' or 'data' schemes).
Check HowTo: Using the PlayAudio Method From Interop in Smart Devices Api.

Return value  None
Parameters Audio:URL
 

PlaceCall method

Opens the defined app for making calls with the input phone number.
Check HowTo: Using PlaceCall Method From Interop in Smart Devices API.

Return value  None
Parameters Phone:Phone
 

SendEmail method

Sends a simple email through the native email client.
Check HowTo: Using the SendEmail Method From Interop in Smart Devices API.

Return value  None
Parameters To:Email, Subject:VarChar(200), Message:VarChar(200)
 

SendEmailAdvanced method

Sends a more complex email through the native email client to multiple targets.
Check HowTo: Using SendEmailAdvanced from Interop in SDApi for Smart Devices.

Return value  None
Parameters To:Collection(Email), CC:Collection(Email), BCC:Collection(Email), Subject:VarChar(200), Message:VarChar(200)
 

SendSMS method

Sends an SMS (Small Message System) to a target phone number.
Check HowTo: Using SendSMS From Interop in Smart Devices Api.

Return value  None
Parameters To:Phone, Message:VarChar(200)
 

Msg method

Displays a message to the end user.
Check HowTo: Using the Msg method from Interop in Smart Devices API.

Return value  None
Parameters Message:VarChar(200), OkButtonText:VarChar(200))
 

Note: Parameter "OkButtonText" is optional and is only available from v16u9.

Confirm method

Displays a message to the end user and returns True if it was confirmed or False otherwise. If the returned value has not been used, the event execution is canceled.
Check HowTo: Using Confirm method from Interop in Smart Devices API.

Return value  Boolean
Parameters Message:VarChar(200), OkButtonText:VarChar(200)), CancelButtonText:VarChar(200)
 

Note: Parameters "OkButtonText" and "CancelButtonText" are optional and are only available from GeneXus 16 upgrade 9.

OpenInBrowser method

Opens a URL in the default web browser of the device.
Check HowTo: Open a Web Page in a New Browser Window from a Smart Devices Application.

Return value  None
Parameters Url:URL
 

CanOpen method

Checks if a URL can be opened (True) or not (False).
Check Interop.CanOpen method.

Return value  Boolean
Parameters Url:URL
 

Open method

Opens a URI content using the appropriate application depending on its scheme.
For instance, 'http' scheme can open a deep link or web content in a browser, 'mailto' will open the email client, 'maps' will open the maps app, etc. Check URI scheme definition and Interop.Open method article.

Return value  None
Parameters Url:URL
 

ClearCache method

Enables you to clear the cache on the device.
Check HowTo: Using ClearCache Method From Interop in Smart Devices Api.

Return value  None
Parameters None
 

SetBadgeNumber method

Sets a badge number on the application icon.
Check HowTo: Using iOS Badge operations.

Return value  None
Parameters number:Numeric(8.0)
 

IOSSetBadgeTextToTabIndex method

Sets a badge text on a tab index when using a Menu object with Control Type = Tabs.
Check HowTo: Using iOS Badge operations.

Return value  None
Parameters text:Character(255), tabIndex:Numeric(8.0)
 

IOSSetSelectedTabIndex method

Selects a tab by a code indicating its index when using a Menu object with Control Type = Tabs.
Check HowTo: Using iOS Badge operations.

Return value  None
Parameters tabIndex:Numeric(8.0)
 

IOSSetBadgeNumber method

Warning: Deprecated since GeneXus X Evolution 3 Upgrade 3; use SetBadgeNumber method instead.

Check HowTo: Using iOS Badge operations.

Return value  None
Parameters number:Numeric(8.0)
 

ShowError method   

Performs the equivalent of what is automatically done to display errors when a Composite command fails in a Native Mobile application.
Check HowTo: Using the ShowError method from Interop in Native Mobile applications.

Return value  number:Numeric(3.0)
Parameters None


Events

It does not have any.

Domains

ApplicationState domain

List of possible application states.

Active The application is in the foreground or received events.
Inactive The application is in the foreground but not receiving events. This can happen when an interruption occurs (for example, an incoming call) or while switching from the background state.
Background  The application is not in the foreground.

Scope

Generators:  Android, Apple