chrome_app library

A library to expose the Chrome app APIs.

Classes

AbortRequestedOptions
Options for the onAbortRequested event.
AcceptError
AcceptErrorInfo
Data from an onAcceptError event.
AcceptInfo
Data from an onAccept event.
AcceptOption
AccountInfo
Action
Information about an action for an entry.
ActionsCallback
AdapterState
Information about the state of the Bluetooth adapter.
AddGalleryWatchResult
A dictionary that describes the add gallery watch request results.
AddUserSelectedFolderResult
The return type for addUserSelectedFolder.
AddWatcherRequestedOptions
Options for the onAddWatcherRequested event.
Represents a Bluetooth LE advertisement instance.
AdvertisementType
Type of advertisement. If 'broadcast' is chosen, the sent advertisement type will be ADV_NONCONN_IND and the device will broadcast with a random MAC Address. If set to 'peripheral', the advertisement type will be ADV_IND or ADV_SCAN_IND and the device will broadcast with real Bluetooth Adapter's MAC Address.
Alarm
AlarmCreateInfo
todo(mpcomplete): rename to CreateInfo when http://crbug.com/123073 is fixed.
AppWindow
ArrayBuffer
AudioDeviceInfo
Blob
BluetoothAcceptErrorInfo
Data from an onAcceptError event.
BluetoothAcceptInfo
Data from an onAccept event.
BluetoothCreateInfo
Result of create call.
BluetoothDevice
Information about the state of a known Bluetooth device. Note: this dictionary is also used in bluetooth_private.idl
BluetoothDeviceType
Common device types recognized by Chrome.
BluetoothReceiveError
BluetoothReceiveErrorInfo
Data from an onReceiveError event.
BluetoothReceiveInfo
Data from an onReceive event.
BluetoothSocketInfo
Result of the getInfo method.
BluetoothSocketProperties
The socket properties specified in the create or update function. Each property is optional. If a property value is not specified, a default value is used when calling create, or the existing value is preserved when calling update.
Bounds
BoundsSpecification
CapabilitiesCallback
CertificatesCallback
Change
Information about a change happened to an entry within the observed directory (including the entry itself).
ChangeType
Type of a change detected on the observed directory.
Characteristic
Represents a GATT characteristic, which is a basic data element that provides further information about a peripheral's service.
CharacteristicProperty
Values representing the possible properties of a characteristic. Characteristic permissions are inferred from these properties. Please see the Bluetooth 4.x spec to see the meaning of each individual property.
ChildChange
Change to an entry within a tracked directory.
ChildChangeType
Type of a change happened to a child entry within a tracked directory.
ChooseEntryOptions
ChooseEntryResult
The return type for chooseEntry.
ChooseEntryType
ChromeAlarms
ChromeApi
A common super class for the Chrome APIs.
ChromeApp
ChromeAppWindow
ChromeAudio
ChromeBluetooth
ChromeBluetoothLowEnergy
ChromeBluetoothSocket
ChromeBrowser
ChromeCommands
ChromeContextMenus
ChromeDocumentScan
ChromeEnum
The abstract superclass of Chrome enums.
ChromeEvent
An object which allows the addition and removal of listeners for a Chrome event.
ChromeEvents
ChromeExtensionTypes
ChromeFileEntry
A convience class for reading and writing file content.
ChromeFileSystem
ChromeFileSystemProvider
ChromeGcm
ChromeHid
ChromeI18N
ChromeIdentity
ChromeIdle
ChromeInstanceID
ChromeLocation
ChromeMediaGalleries
ChromeNotifications
ChromeObject
The abstract superclass of objects that can hold JsObject proxies.
ChromePermissions
ChromePower
ChromePrinterProvider
ChromeRuntime
ChromeSerial
ChromeSetting
An interface that allows access to a Chrome browser setting. See accessibilityFeatures for an example.
ChromeSettingScope
The scope of the ChromeSetting. One of
ChromeSockets
ChromeSocketsTcp
Use the chrome.sockets.tcp API to send and receive data over the network using TCP connections. This API supersedes the TCP functionality previously found in the chrome.socket API.
ChromeSocketsTcpServer
Use the chrome.sockets.tcpServer API to create server applications using TCP connections. This API supersedes the TCP functionality previously found in the chrome.socket API.
ChromeSocketsUdp
Use the chrome.sockets.udp API to send and receive data over the network using UDP connections. This API supersedes the UDP functionality previously found in the "socket" API.
ChromeStorage
ChromeSyncFileSystem
ChromeSystem
ChromeSystemCpu
Use the system.cpu API to query CPU metadata.
ChromeSystemDisplay
Use the system.display API to query display metadata.
ChromeSystemMemory
The chrome.system.memory API.
ChromeSystemNetwork
Use the chrome.system.network API.
ChromeSystemStorage
Use the chrome.system.storage API to query storage device information and be notified when a removable storage device is attached and detached.
ChromeTts
ChromeTypes
ChromeUsb
ChromeVpnProvider
ChromeWallpaper
CloseFileRequestedOptions
Options for the onCloseFileRequested event.
Command
CommonActionId
List of common actions. "SHARE" is for sharing files with others. "SAVE_FOR_OFFLINE" for pinning (saving for offline access). "OFFLINE_NOT_NECESSARY" for notifying that the file doesn't need to be stored for offline access anymore. Used by onGetActionsRequested and onExecuteActionRequested.
ConfigDescriptor
ConfigureRequestedOptions
Options for the onConfigureRequested event.
ConflictResolutionPolicy
ConnectionHandle
ConnectionInfo
Result of the getInfo method.
ConnectionOptions
ConnectProperties
The connection properties specified during a call to connect.
ContentBounds
Previously named Bounds.
ContextMenusCreateParams
ContextMenusUpdateParams
ContextType
The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts except for 'launcher'. The 'launcher' context is only supported by apps and is used to add menu items to the context menu that appears when clicking on the app icon in the launcher/taskbar/dock/etc. Different platforms might put limitations on what is actually supported in a launcher context menu.
ControlTransferInfo
Coordinates
Coordinates part of the Location object.
CopyEntryRequestedOptions
Options for the onCopyEntryRequested event.
CpuInfo
CpuTime
Counters for assessing CPU utilization. Each field is monotonically increasing while the processor is powered on. Values are in milliseconds.
CreateDirectoryRequestedOptions
Options for the onCreateDirectoryRequested event.
CreateFileRequestedOptions
Options for the onCreateFileRequested event.
CreateInfo
Result of create call.
CreateWindowOptions
CSSOrigin
The origin of injected CSS.
DataBits
Date
DeleteEntryRequestedOptions
Options for the onDeleteEntryRequested event.
Descriptor
Represents a GATT characteristic descriptor, which provides further information about a characteristic's value.
DescriptorPermission
Values representing possible permissions for a descriptor. Please see the Bluetooth 4.x spec to see the meaning of each individual permission.
Device
Represents a bluetooth central device that is connected to the local GATT server.
DeviceCallback
DeviceControlSignals
The set of control signals which may be set by a connected serial device. These can be queried using getControlSignals. Note that support for these signals is device-dependent.
DeviceFilter
DeviceIdLists
DeviceInfo
DeviceProperties
DeviceType
Available audio device types.
Direction
Direction, Recipient, RequestType, and TransferType all map to their namesakes within the USB specification.
DirectoryEntry
DirectoryReader
DisplayLayout
DisplayMode
DisplayProperties
DisplayUnitInfo
DomException
EjectDeviceResultCode
EndpointDescriptor
EntriesCallback
Entry
EntryChangedEvent
Event notifying about a change in a file or a directory, including its contents.
EntryMetadata
Represents metadata of a file or a directory.
EntryRemovedEvent
Event notifying about a tracked file or a directory being removed.
EnumerateDevicesAndRequestAccessOptions
EnumerateDevicesOptions
EventTarget
Base class for all browser objects that support events. [...]
EventType
ExecuteActionRequestedOptions
Options for the onExecuteActionRequested event.
File
FileDataCallback
FileEntry
FileInfo
FileReader
FileStatus
FileStatusInfo
FileSystem
FileSystemInfo
Represents a mounted file system.
FileWriter
FrameOptions
GalleryChangeDetails
GalleryChangeType
GcmSendParams
GenericTransferInfo
GetActionsRequestedOptions
Options for the onGetActionsRequested event.
GetInfoFlags
GetInfoResult
The return type for getInfo.
GetMediaFileSystemsInteractivity
GetMetadataRequestedOptions
Options for the onGetMetadataRequested event.
GetMetadataType
HidCollectionInfo
HidConnectInfo
HidDeviceFilter
HidDeviceInfo
HidDevicePromptOptions
HidGetDevicesOptions
HostControlSignals
The set of control signals which may be sent to a connected serial device using setControlSignals. Note that support for these signals is device-dependent.
IdleState
ImageDetails
Details about the format and quality of an image.
ImageFormat
The format of an image.
InjectDetails
Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
InputDeviceInfo
Insets
InstanceIDDeleteTokenParams
InstanceIDGetTokenParams
InterfaceDescriptor
InvalidTokenDetails
IsochronousTransferInfo
ItemType
The type of menu item.
LanguageCode
An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. For an unknown language, und will be returned, which means that percentage of the text is unknown to CLD
LastErrorRuntime
LayoutPosition
Layout position, i.e. edge of parent that the display is attached to.
Level
LevelChangedEvent
ListenOptions
Options that may be passed to the listenUsingRfcomm and listenUsingL2cap methods. Each property is optional with a default being used if not specified.
LocalMediaStream
LocalStorageArea
Location
Parameter of onLocationUpdate event's listener.
ManufacturerData
Represents an entry of the "Manufacturer Specific Data" field of Bluetooth LE advertisement data.
MediaFileSystemMetadata
MediaFileSystemsDetails
MediaMetadata
MediaMetadataOptions
MemoryInfo
MessageSender
An object containing information about the script context that sent a message or request.
Metadata
MetadataCallback
MirrorMode
Mirror mode, i.e. different ways of how a display is mirrored to other displays.
MirrorModeInfo
MountOptions
Options for the mount method.
MoveEntryRequestedOptions
Options for the onMoveEntryRequested event.
MuteChangedEvent
NetworkInterface
Notification
Represents a notification to be sent to a remote device.
NotificationBitmap
NotificationButton
NotificationItem
NotificationOptions
NotificationProperties
Optional characteristic notification session properties specified during a call to startCharacteristicNotifications.
NotifyOptions
Options for the notify method.
OnAbortRequestedEvent
OnAddWatcherRequestedEvent
OnButtonClickedEvent
OnCharacteristicReadRequestEvent
OnCharacteristicWriteRequestEvent
OnClosedEvent
OnCloseFileRequestedEvent
OnConfigCreatedEvent
OnConfigureRequestedEvent
OnCopyEntryRequestedEvent
OnCreateDirectoryRequestedEvent
OnCreateFileRequestedEvent
OnDeleteEntryRequestedEvent
OnDescriptorReadRequestEvent
OnDescriptorWriteRequestEvent
OnExecuteActionRequestedEvent
OnGetActionsRequestedEvent
OnGetCapabilityRequestedEvent
OnGetMetadataRequestedEvent
OnGetUsbPrinterInfoRequestedEvent
OnInstalledReason
The reason that this event is being dispatched.
OnMessageEvent
Fired when a message is sent from either an extension process (by runtime.sendMessage) or a content script (by tabs.sendMessage).
OnMessageExternalEvent
Fired when a message is sent from another extension/app (by runtime.sendMessage). Cannot be used in a content script.
OnMountRequestedEvent
OnMoveEntryRequestedEvent
OnOpenFileRequestedEvent
OnPlatformMessageEvent
OnPrintRequestedEvent
OnReadDirectoryRequestedEvent
OnReadFileRequestedEvent
OnRemoveWatcherRequestedEvent
OnRestartRequiredReason
The reason that the event is being dispatched. 'app_update' is used when the restart is needed because the application is updated to a newer version. 'os_update' is used when the restart is needed because the browser/OS is updated to a newer version. 'periodic' is used when the system runs for more than the permitted uptime set in the enterprise policy.
OnSignInChangedEvent
OnTruncateRequestedEvent
OnUIEventEvent
OnUnmountRequestedEvent
OnWriteFileRequestedEvent
OpenedFile
Represents an opened file.
OpenFileMode
Mode of opening a file. Used by onOpenFileRequested.
OpenFileRequestedOptions
Options for the onOpenFileRequested event.
OpenTabOptions
Options for the openTab function.
OutputDeviceInfo
Parameters
A parameters class for the VPN interface.
ParityBit
PermissionLevel
Permissions
PlatformArch
The machine's processor architecture.
PlatformInfo
An object containing information about the current platform.
PlatformMessage
The enum is used by the platform to notify the client of the VPN session status.
PlatformNaclArch
The native client architecture. This may be different from arch on some platforms.
PlatformOs
The operating system chrome is running on.
Point
Port
An object which allows two way communication with other pages. See Long-lived connections for more information.
PrintCallback
PrinterInfo
Printer description for onGetPrintersRequested event.
PrinterInfoCallback
PrintError
Error codes returned in response to onPrintRequested event.
PrintersCallback
PrintJob
Printing request parameters. Passed to onPrintRequested event.
ProcessorInfo
ProfileUserInfo
ProgressEvent
ProviderError
Error codes used by providing extensions in response to requests as well as in case of errors when calling methods of the API. For success, "OK" must be used.
ProviderErrorCallback
ProviderSuccessCallback
ReadDirectoryRequestedOptions
Options for the onReadDirectoryRequested event.
ReadFileRequestedOptions
Options for the onReadFileRequested event.
ReceiveError
ReceiveErrorInfo
Data from an onReceiveError event.
ReceiveInfo
Data from an onReceive event.
ReceiveResult
The return type for receive.
Recipient
RemoveWatcherRequestedOptions
Options for the onRemoveWatcherRequested event.
Request
Represents a an attribute read/write request.
RequestFileSystemOptions
RequestPinCallback
RequestType
RequestUpdateCheckResult
The return type for requestUpdateCheck.
RequestUpdateCheckStatus
Result of the update check.
Response
Represents a response to an attribute read/write request.
Rule
Description of a declarative rule for handling events.
RunAt
The soonest that the JavaScript or CSS will be injected into the tab.
RuntimeConnectParams
RuntimeSendMessageParams
ScanOptions
ScanProgressDetails
ScanProgressType
ScanResults
SecureOptions
SendError
SendInfo
Result of the send method.
SerialReceiveErrorInfo
Data from an onReceiveError event.
SerialReceiveInfo
Data from an onReceive event.
SerialSendInfo
Service
Represents a peripheral's Bluetooth GATT Service, a collection of characteristics and relationships to other services that encapsulate the behavior of part of a device.
ServiceData
Represents an entry of the "Service Data" field of Bluetooth LE advertisement data.
ServiceInfo
ServiceStatus
SignCallback
SocketInfo
Result of the getInfo method.
SocketProperties
The socket properties specified in the create or update function. Each property is optional. If a property value is not specified, a default value is used when calling create, or the existing value if preserved when calling update.
State
State of a window: normal, fullscreen, maximized, minimized.
StopBits
StopPinRequestCallback
StorageArea
StorageAvailableCapacityInfo
StorageChange
StorageInfo
StorageOnChangedEvent
Fired when one or more items change.
StorageUnitInfo
StorageUnitType
StreamInfo
StreamType
Type of stream an audio device provides.
SubtleCrypto
SuggestFilenameCallback
SyncAction
SyncDirection
SynchronizationType
For interrupt and isochronous modes, SynchronizationType and UsageType map to their namesakes within the USB specification.
SyncStorageArea
TemplateType
TLSVersionConstraints
TokenDetails
TouchCalibrationPair
TouchCalibrationPairQuad
TransferResultInfo
TransferType
TruncateRequestedOptions
Options for the onTruncateRequested event.
TtsEvent
An event from the TTS engine to communicate the status of an utterance.
TtsSpeakParams
TtsVoice
A description of a voice available for speech synthesis.
TypesClearParams
TypesGetParams
TypesLevelOfControl
One of
TypesSetParams
UIEvent
The enum is used by the platform to indicate the event that triggered onUIEvent.
UnmountOptions
Options for the unmount method.
UnmountRequestedOptions
Options for the onUnmountRequested event.
UrlFilter
Filters URLs for various criteria. See event filtering. All criteria are case sensitive.
UsageType
UsbDevice
UsbDeviceFilter
UsbDevicePromptOptions
VendorIdSource
Allocation authorities for Vendor IDs.
VoiceGender
Volume
Represents a mounted volume, which can be accessed via chrome. fileSystem.requestFileSystem.
VolumeListChangedEvent
Event notifying about an inserted or a removed volume from the system.
VpnConnectionState
The enum is used by the VPN client to inform the platform of its current state. This helps provide meaningful messages to the user.
WallpaperLayout
The supported wallpaper layouts.
WallpaperSetWallpaperParams
Watcher
Represents a watcher.
WatchLocationRequestInfo
Parameter of watchLocation call.
WebAuthFlowDetails
WindowType
Specifies the type of window to create.
WriteFileRequestedOptions
Options for the onWriteFileRequested event.

Properties

alarms ChromeAlarms
Accessor for the chrome.alarms namespace.
final
app ChromeApp
final
audio ChromeAudio
Accessor for the chrome.audio namespace.
final
bluetooth ChromeBluetooth
Accessor for the chrome.bluetooth namespace.
final
bluetoothLowEnergy ChromeBluetoothLowEnergy
Accessor for the chrome.bluetoothLowEnergy namespace.
final
bluetoothSocket ChromeBluetoothSocket
Accessor for the chrome.bluetoothSocket namespace.
final
browser ChromeBrowser
Accessor for the chrome.browser namespace.
final
commands ChromeCommands
Accessor for the chrome.commands namespace.
final
contextMenus ChromeContextMenus
Accessor for the chrome.contextMenus namespace.
final
documentScan ChromeDocumentScan
Accessor for the chrome.documentScan namespace.
final
events ChromeEvents
Accessor for the chrome.events namespace.
final
extensionTypes ChromeExtensionTypes
Accessor for the chrome.extensionTypes namespace.
final
fileSystem ChromeFileSystem
Accessor for the chrome.fileSystem namespace.
final
fileSystemProvider ChromeFileSystemProvider
Accessor for the chrome.fileSystemProvider namespace.
final
gcm ChromeGcm
Accessor for the chrome.gcm namespace.
final
hid ChromeHid
Accessor for the chrome.hid namespace.
final
i18n ChromeI18N
Accessor for the chrome.i18n namespace.
final
identity ChromeIdentity
Accessor for the chrome.identity namespace.
final
idle ChromeIdle
Accessor for the chrome.idle namespace.
final
instanceID ChromeInstanceID
Accessor for the chrome.instanceID namespace.
final
location ChromeLocation
Accessor for the chrome.location namespace.
final
mediaGalleries ChromeMediaGalleries
Accessor for the chrome.mediaGalleries namespace.
final
notifications ChromeNotifications
Accessor for the chrome.notifications namespace.
final
permissions ChromePermissions
Accessor for the chrome.permissions namespace.
final
power ChromePower
Accessor for the chrome.power namespace.
final
printerProvider ChromePrinterProvider
Accessor for the chrome.printerProvider namespace.
final
runtime ChromeRuntime
Accessor for the chrome.runtime namespace.
final
serial ChromeSerial
Accessor for the chrome.serial namespace.
final
sockets ChromeSockets
final
storage ChromeStorage
Accessor for the chrome.storage namespace.
final
syncFileSystem ChromeSyncFileSystem
Accessor for the chrome.syncFileSystem namespace.
final
system ChromeSystem
final
tts ChromeTts
Accessor for the chrome.tts namespace.
final
types ChromeTypes
Accessor for the chrome.types namespace.
final
usb ChromeUsb
Accessor for the chrome.usb namespace.
final
vpnProvider ChromeVpnProvider
Accessor for the chrome.vpnProvider namespace.
final
wallpaper ChromeWallpaper
Accessor for the chrome.wallpaper namespace.
final