@capacitor/core

constructor

constructor(message: string, code?: ExceptionCode, data?: ExceptionData);

property code

readonly code?: ExceptionCode;

property data

readonly data?: ExceptionData;

property message

readonly message: string;

property listeners

protected listeners: { [eventName: string]: ListenerCallback[] };

property retainedEventArguments

protected retainedEventArguments: { [eventName: string]: any[] };

property windowListeners

protected windowListeners: { [eventName: string]: WindowListenerHandle };

method addListener

addListener: (
    eventName: string,
    listenerFunc: ListenerCallback
) => Promise<PluginListenerHandle>;

method hasListeners

protected hasListeners: (eventName: string) => boolean;

method notifyListeners

protected notifyListeners: (
    eventName: string,
    data: any,
    retainUntilConsumed?: boolean
) => void;

method registerWindowListener

protected registerWindowListener: (
    windowEventName: string,
    pluginEventName: string
) => void;

method removeAllListeners

removeAllListeners: () => Promise<void>;

method unavailable

protected unavailable: (msg?: string) => CapacitorException;

method unimplemented

protected unimplemented: (msg?: string) => CapacitorException;

property addListener

addListener?: (
    pluginName: string,
    eventName: string,
    callback: PluginCallback
) => PluginListenerHandle;

• Add a listener for a plugin event.

property convertFileSrc

convertFileSrc: (filePath: string) => string;

• Utility function to convert a file path into a usable src depending on the native WebView implementation value and environment.

property DEBUG

DEBUG?: boolean;

property Exception

Exception: typeof CapacitorException;

• The Exception class used when generating plugin Exceptions from bridge calls.

property getPlatform

getPlatform: () => string;

• Gets the name of the platform, such as android, ios, or web.

property isLoggingEnabled

isLoggingEnabled?: boolean;

property isNativePlatform

isNativePlatform: () => boolean;

• Boolean if the platform is native or not. android and ios would return true, otherwise false.

property isPluginAvailable

isPluginAvailable: (name: string) => boolean;

• Used to check if a platform is registered and available.

property registerPlugin

registerPlugin: RegisterPlugin;

property removeListener

removeListener?: (
    pluginName: string,
    callbackId: string,
    eventName: string,
    callback: PluginCallback
) => void;

• Remove a listener to a plugin event.

index signature

[key: string]: string;

• A key/value dictionary of Http headers.

property connectTimeout

connectTimeout?: number;

• How long to wait for the initial connection in milliseconds.

property data

data?: any;

• Note: On Android and iOS, data can only be a string or a JSON. FormData, Blob, ArrayBuffer, and other complex types are only directly supported on web or through enabling CapacitorHttp in the config and using the patched window.fetch or XMLHttpRequest.

  If you need to send a complex type, you should serialize the data to base64 and set the headers["Content-Type"] and dataType attributes accordingly.

property dataType

dataType?: 'file' | 'formData';

• This is used if we've had to convert the data from a JS type that needs special handling in the native layer

property disableRedirects

disableRedirects?: boolean;

• Sets whether automatic HTTP redirects should be disabled

property headers

headers?: HttpHeaders;

• Http Request headers to send with the request.

property method

method?: string;

• The Http Request method to run. (Default is GET)

property params

params?: HttpParams;

• URL parameters to append to the request.

property readTimeout

readTimeout?: number;

• How long to wait to read additional data in milliseconds. Resets each time new data is received.

property responseType

responseType?: HttpResponseType;

• This is used to parse the response appropriately before returning it to the requestee. If the response content-type is "json", this value is ignored.

property shouldEncodeUrlParams

shouldEncodeUrlParams?: boolean;

• Use this option if you need to keep the URL unencoded in certain cases (already encoded, azure/firebase testing, etc.). The default is _true_.

property url

url: string;

• The URL to send the request to.

property webFetchExtra

webFetchExtra?: RequestInit;

• Extra arguments for fetch when running on the web

index signature

[key: string]: string | string[];

• A key/value dictionary of URL parameters to set.

property data

data: any;

• Additional data received with the Http response.

property headers

headers: HttpHeaders;

• The headers received from the Http response.

property status

status: number;

• The status code received from the Http response.

property url

url: string;

• The response URL received from the Http response.

method addListener

addListener: (
    eventName: string,
    listenerFunc: (...args: any[]) => any
) => Promise<PluginListenerHandle>;

method removeAllListeners

removeAllListeners: () => Promise<void>;

property remove

remove: () => Promise<void>;

index signature

[key: string]: any;

property message

message: string;

property bar

bar?: SystemBarType;

• The system bar to which to apply the style.

  8.0.0 null

  Example 1

  SystemBarType.StatusBar

property style

style: SystemBarsStyle;

• Style of the text and icons of the system bars.

  8.0.0 'DEFAULT'

  Example 1

  "DARK"

property animation

animation?: SystemBarsAnimation;

• The type of status bar animation used when showing or hiding.

  This option is only supported on iOS.

  'FADE'

  8.0.0

property bar

bar?: SystemBarType;

• The system bar to hide or show.

  8.0.0 null

  Example 1

  SystemBarType.StatusBar

property path

path: string;

method getServerBasePath

getServerBasePath: () => Promise<WebViewPath>;

method persistServerBasePath

persistServerBasePath: () => Promise<void>;

method setServerAssetPath

setServerAssetPath: (options: WebViewPath) => Promise<void>;

method setServerBasePath

setServerBasePath: (options: WebViewPath) => Promise<void>;

member Unavailable

Unavailable = 'UNAVAILABLE'

• API is not available.

  This means the API can't be used right now because: - it is currently missing a prerequisite, such as network connectivity - it requires a particular platform or browser version

member Unimplemented

Unimplemented = 'UNIMPLEMENTED'

• API is not implemented.

  This usually means the API can't be used because it is not implemented for the current platform.

member Dark

Dark = 'DARK'

• Light system bar content on a dark background.

  8.0.0

member Default

Default = 'DEFAULT'

• The style is based on the device appearance or the underlying content. If the device is using Dark mode, the system bars content will be light. If the device is using Light mode, the system bars content will be dark.

  8.0.0

member Light

Light = 'LIGHT'

• For dark system bar content on a light background.

  8.0.0

member NavigationBar

NavigationBar = 'NavigationBar'

• The navigation bar (or gesture bar on iOS) on both Android and iOS.

  8.0.0

member StatusBar

StatusBar = 'StatusBar'

• The top status bar on both Android and iOS.

  8.0.0