PlatformAPI

From RAD Studio API Documentation
Jump to: navigation, search

The PlatformAPI unit provides interfaces to interact with and control RAD Studio aspects related to target platforms and devices.

You can use these interfaces to:

Classes

EPlatformNotSupportedEPlatformNotSupported is the exception class for unsupported platform errors.
IiOSPlatformProvisionAction
IOTAAndroidServicesManager
IOTAConnectionCallbackIOTAConnectionCallback allows you to specify when to abort or retry a connection to the Platform Assistant server.
IOTADesignerDeviceIOTADesignerDevice represents design-time information about a device.
IOTADesignerDevice190
IOTADesignerDevice220
IOTADesignerDeviceServicesIOTADesignerDeviceServices provides procedures, functions, and properties to manage design-time devices.
IOTADesignerDeviceServices190
IOTADesignerOSEntryIOTADesignerOSEntry represents a platform.
IOTADesignerOSEntry190
IOTAExternalDeviceIOTAExternalDevice represents a mobile device, emulator, or simulator.
IOTAExternalDeviceNotifierIOTAExternalDeviceNotifier lets you associate callbacks with events related to external devices.
IOTAExternalDeviceServicesIOTAExternalDeviceServices provides procedures, functions, and properties to manage external devices.
IOTAMobileDevice (deprecated)
IOTAMobileDeviceNotifierIOTAMobileDeviceNotifier lets you associate callbacks with events related to design-time devices.
IOTAMobileDeviceServices (deprecated)
IOTAPlatform
IOTAPlatform160IOTAPlatform160 represents a platform.
IOTAPlatform170
IOTAPlatform180
IOTAPlatform190
IOTAPlatform200
IOTAPlatform210
IOTAPlatform220
IOTAPlatform230
IOTAPlatform240
IOTAPlatformSDK
IOTAPlatformSDK180
IOTAPlatformSDKAndroid
IOTAPlatformSDKAndroid210
IOTAPlatformSDKAndroid240
IOTAPlatformSDKAndroid270
IOTAPlatformSDKLinux
IOTAPlatformSDKNotifierIOTAPlatformSDKNotifier lets you associate callbacks with events related to SDKs.
IOTAPlatformSDKOSX
IOTAPlatformSDKServices
IOTAPlatformSDKServices180
IOTAPlatformSDKServices190
IOTAPlatformSDKServices210
IOTAPlatformSDKWin10
IOTAPlatformServices
IOTAPlatformServices160
IOTAPlatformServices220
IOTAPlatformServices230
IOTAProjectPlatforms
IOTAProjectPlatforms160
IOTARemoteProfile
IOTARemoteProfile170
IOTARemoteProfile210
IOTARemoteProfileNotifier
IOTARemoteProfileNotifier170
IOTARemoteProfileServices
IOTARemoteProfileServices160
IOTARemoteProfileServices170
IOTARemoteProfileServices180
IOTARemoteProfileServices190
IOTARemoteProfileServices230
IPlatformContainerCategoryCreator
IPlatformContainerCreator
IPlatformProvisionInformation
IPlatformProvisionInformation180
IPlatformProvisionInformation220
IPlatformResources
IPlatformSpecificBuildAction
IProjectPlatformInitializeYou can implement the IProjectPlatformInitialize interface in a custom platform class so that the IDE calls your InitializeProject implementation when a user adds your custom platform to a project (IOTAProject).

Routines

ConfigurationDisplayTitleConfigurationDisplayTitle returns the display name of the specified build configuration (IOTABuildConfiguration).

Types

TDeviceRecordTDeviceRecord provides information about an external device as returned by the Platform Assistant client.
TDeviceTypeTDeviceType is a type of device, either a physical device (dtDevice), such as an iPhone, or a virtual device (dtEmulator), such as an Android emulator or an iOS simulator.
TEntitlement
TOTABuildTypeTOTABuildType represents a platform configuration.
TOTABuildTypeConfig
TOTADesignerDevicesTOTADesignerDevices is an array of design-time devices.
TOTADesignerOSListTOTADesignerOSList is an array of platform versions.
TOTADeviceFormFactor
TOTADeviceFormFactors
TOTADeviceLayoutTOTADeviceLayout represents the layout of a device for a specific orientation.
TOTADeviceOrientationTOTADeviceOrientation is a type of device orientation.
TOTADevicePlatform (deprecated)TOTADevicePlatform defines a platform for a design-time device.
TOTADevicePlatforms (deprecated)
TOTADeviceStatus
TOTAExternalDevicesTOTAExternalDevices is an array of external devices.
TOTAFileOverwriteControlTOTAFileOverwriteControl lets you define an approach to follow when dealing with file operations that would result in overwriting existing files.
TOTAMobileDeviceChangeActionTOTAMobileDeviceChangeAction defines a type of change in the IDE design-time devices.
TOTAOSFamilies
TOTAOSFamily
TOTAPlatformsTOTAPlatforms is an array of platforms.
TOTAPlatformSDKStatus
TOTAProgressType
TOTAPutFileArrayTOTAPutFileArray is an array of TOTAPutFileItem records.
TOTAPutFileFlagsTOTAPutFileFlags are flags for a TOTAPutFileItem record that indicate how to handle the specified file after copying it to a remote system.
TOTAPutFileItemTOTAPutFileItem represents a file to copy from your local machine to a remote machine.
TOTARemoteFileInfoTOTARemoteFileInfo represents a file on a remote machine.
TOTARemoteFileInfoArrayTOTARemoteFileInfoArray is an array of remote files.
TOTARemotePathTypeTOTARemotePathType indicates the type of a file or folder within an SDK.
TOTARemoteProfileCredentialTOTARemoteProfileCredential provides the credentials required to connect to a running instance of the Platform Assistant server.
TOTARemoteProfilePathArrayTOTARemoteProfilePathArray is an array of SDK remote paths.
TOTARemoteProfilePathItemTOTARemoteProfilePathItem represents a remote path defined in an SDK.
TOTARemoteProfileStatus
TOTASDKInfoTOTASDKInfo provides information about an SDK.
TOTASDKInfoArrayTOTASDKInfoArray is an array of SDKs.
TOTAStatusbarPosTOTAStatusbarPos defines the position of the status bar of a design-time device.
TPlatformSupportsOperation
TProvisionProfileInfo
TProvisionProfileInfoArray

Constants

AllPlatformsAllPlatforms: Integer = $394DF;
btAdHocbtAdHoc: Integer = 1;
btAppStorebtAppStore: Integer = 2;
btDebugbtDebug: Integer = 0;
btNormalbtNormal: Integer = 3;
cAndroidArm32PlatformcAndroidArm32Platform: string = Android;
cAndroidArm64PlatformcAndroidArm64Platform: string = Android64;
cAndroidFamilyNamecAndroidFamilyName: string = Android;
cAndroidPlatformcAndroidPlatform: string = Android;
cAndroidServiceTypecAndroidServiceType: string = AndroidServiceType;
ciOSDevice32PlatformciOSDevice32Platform: string = iOSDevice32;
ciOSDevice64PlatformciOSDevice64Platform: string = iOSDevice64;
ciOSDevicePlatformciOSDevicePlatform: string = iOSDevice32;
ciOSFamilyNameciOSFamilyName: string = iOS;
ciOSSimulator32PlatformciOSSimulator32Platform: string = iOSSimulator;
ciOSSimulator64PlatformciOSSimulator64Platform: string = iOSSimulator64;
ciOSSimulatorPlatformciOSSimulatorPlatform: string = iOSSimulator;
cLinux32PlatformcLinux32Platform: string = Linux32;
cLinux64PlatformcLinux64Platform: string = Linux64;
cLinuxFamilyNamecLinuxFamilyName: string = Linux;
cOSFamilyDisplayNamescOSFamilyDisplayNames: :1;
cOSX32PlatformcOSX32Platform: string = OSX32;
cOSX64PlatformcOSX64Platform: string = OSX64;
cOSXArm64PlatformcOSXArm64Platform: string = OSXARM64;
cOSXFamilyNamecOSXFamilyName: string = macOS;
cSrvTypeIntentLocalcSrvTypeIntentLocal: string = IntentLocal;
cSrvTypeIntentRemotecSrvTypeIntentRemote: string = IntentRemote;
cSrvTypeLocalcSrvTypeLocal: string = Local;
cSrvTypeRemotecSrvTypeRemote: string = Remote;
cUndefinedFamilyNamecUndefinedFamilyName: string = Unknown;
cWin32PlatformcWin32Platform: string = Win32;
cWin64PlatformcWin64Platform: string = Win64;
cWinArmPlatformcWinArmPlatform: string = WinARM32;
cWindowsFamilyNamecWindowsFamilyName: string = Windows;
cWinIoT32PlatformcWinIoT32Platform: string = WinIoT32;
cWinNX32PlatformcWinNX32Platform: string = WinNX32;
dffComputerFactorsdffComputerFactors: TOTADeviceFormFactors;
dffFormFactorsdffFormFactors: TOTADeviceFormFactors;
dffPhoneFactorsdffPhoneFactors: TOTADeviceFormFactors;
dffPlatformsdffPlatforms: TOTADevicePlatforms;
dffWearableFactorsdffWearableFactors: TOTADeviceFormFactors;
fetCBuilderRemoteDebugfetCBuilderRemoteDebug: Integer = $A;
fetCUnitBinaryfetCUnitBinary: Integer = 6;
fetDelphiLibraryRemoteDebugfetDelphiLibraryRemoteDebug: Integer = $B;
fetDelphiRemoteDebugfetDelphiRemoteDebug: Integer = 9;
fetDelphiUnitBinaryfetDelphiUnitBinary: Integer = 7;
fetDllfetDll: Integer = 3;
fetExefetExe: Integer = 1;
fetImportLibraryfetImportLibrary: Integer = 8;
fetLastfetLast: Integer = 8;
fetPackagefetPackage: Integer = 2;
fetPackageImportLibraryfetPackageImportLibrary: Integer = 5;
fetStaticLibraryfetStaticLibrary: Integer = 4;
fetUnknownTypefetUnknownType: Integer = 0;
piBTAdHocpiBTAdHoc: Integer = $1F;
piBTAppStorepiBTAppStore: Integer = $20;
piBTDebugpiBTDebug: Integer = $1E;
piBTNormalpiBTNormal: Integer = $21;