Skip to content

Class: BinaryModule ​

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:8

Extends ​

Constructors ​

Constructor ​

new BinaryModule(): BinaryModule

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:34

Creates a new event emitter instance.

Returns ​

BinaryModule

Inherited from ​

NativeModule<BinaryModuleEvents>.constructor

Properties ​

emitLog ​

emitLog: (emitLog?) => boolean

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:27

Get/Set/update emitLog flag.

If enabled, each line of stdout log from the binary will be emitted as they appear with event named "log".

CAUTION: make sure to disable it when logs are no longer needed. If you only need to receive notifications use StartOptions.ipcOptions when starting the binary.

Default: undefined

Subscribe to log events: ​

js
binaryModule.emitLog(true)
binaryModule.addListener('log', data => {
	console.log('log', data)
})

Parameters ​

emitLog? ​

boolean

Returns ​

boolean


getEnv ​

getEnv: () => object

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:30

Get exposed environment variables

Returns ​

object


getError ​

getError: () => string | null

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:33

Get most recent binary startup error message

Returns ​

string | null


getPathAppFilesDir ​

getPathAppFilesDir: () => string

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:49

Get app files storage directory path

Eg: "/storage/emulated/0/Android/data/app.package.name/files"

Returns ​

string


getPathJniLibsDir ​

getPathJniLibsDir: () => string

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:69

Get path of the native library directory where the executable binaries (from jniLibs in Android) are stored.

Returned path example:

"/data/app/~~.......==/<PACKAGE>-......==/lib/<ARCH>"
  • PACKAGE refers to the package name. Eg: com.google.chrome
  • ARCH refers to one of the following:
    • arm64-v8a: most modern smartphones
    • x86_64: devices or most of the emulators running on X86 64 bit
    • armeabi-v7a: older Arm based devices
    • x86: older x86 based devices

CAUTION: the path returned is not a permanent path and may change on app/device restart/reinstall. See EnvEntry for more details.

Returns ​

string


getStartCount ​

getStartCount: () => number

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:39

Get the number of times binary has started since the app launched. Can be useful to check if there were any crashes causing auto-restart.

Returns ​

number


getStatus ​

getStatus: () => Status

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:42

Get binary/foreground service status

Returns ​

Status


notification ​

notification: NotificationManager

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:71


permissionCheck ​

permissionCheck: (permission) => boolean

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:78

Check if app has device permission (eg: storage access code)

Parameters ​

permission ​

string

Android permission string eg: "Manifest.permission.WRITE_EXTERNAL_STORAGE".

Returns ​

boolean


permissionRequest ​

permissionRequest: (permission, code) => boolean

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:87

Request one or more device permissions

Parameters ​

permission ​

string

Android permission string eg: "Manifest.permission.WRITE_EXTERNAL_STORAGE". To request multiple permission in one go use comma-separated string

code ​

number

any number for self reference

Returns ​

boolean


sendToBinary ​

sendToBinary: (mesasge) => boolean

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:92

Send a message to the binary's input stream.

Parameters ​

mesasge ​

string

Returns ​

boolean


setAppState ​

setAppState: (status) => void

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:100

Update current app status

PS: Binary module will auto update the app state. Only use this if you would like to manually trigger a change if IPC notifictation should be triggered.

Parameters ​

status ​

AppStateStatus

Returns ​

void


start ​

start: (options) => Promise<Status>

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:109

Start binary (if not already started)

Parameters ​

options ​

StartOptions

Persistent options used to start the binary. See StartOptions for more details.

Returns ​

Promise<Status>

binary status


startOptions ​

startOptions: (options?) => StartOptions | null

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:118

Get/Set start options If the binary has not been previously started, this will NOT start the binary.

If the binary has already been running or stopped using auto-stop options, auto-stop options come into effect on the next device status change.

Parameters ​

options? ​

Partial<StartOptions>

Returns ​

StartOptions | null


stop ​

stop: () => Promise<void>

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:121

Stop the binary, foreground service and close persistent notification

Returns ​

Promise<void>


storagePermissionCheck ​

storagePermissionCheck: () => boolean

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:124

Check if app has read/write permission to external storage

Returns ​

boolean


storagePermissionRequest ​

storagePermissionRequest: (code) => Promise<boolean>

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:136

Request access to read and write to external storage. Your Android manifest file (expo.android.permissions in Expo app.json) must include the following permissions:

  • Android 11+: MANAGE_EXTERNAL_STORAGE
  • Android ≤10: WRITE_EXTERNAL_STORAGE & READ_EXTERNAL_STORAGE

Parameters ​

code ​

number

any number for self reference

Returns ​

Promise<boolean>


store ​

store: Store

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:147

Simple unencrypted app-private storage using Android SharedPreferences.

Data may be backed up uncrypted or unencrypted by Android backup depending on the backup provider.

You can also exclude it from backup: https://developer.android.com/identity/data/autobackup.

For encrypted data use BinaryModule.storeEncrypted


storeEncrypted ​

storeEncrypted: Store & object

Defined in: packages/expo-binary-module/src/types/binaryModule.ts:152

Simple encrypted storage using Android Keystore and SharedPreferences.

Type Declaration ​

deleteAsync ​

deleteAsync: (key) => Promise<null>

Parameters ​
key ​

string

Returns ​

Promise<null>

getAsync ​

getAsync: (key) => Promise<string | null>

Parameters ​
key ​

string

Returns ​

Promise<string | null>

setAsync ​

setAsync: (key, value) => Promise<string | null>

Parameters ​
key ​

string

value ​

string

Returns ​

Promise<string | null>

Methods ​

addListener() ​

addListener<EventName>(eventName, listener): EventSubscription

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:44

Adds a listener for the given event name.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

listener ​

BinaryModuleEvents[EventName]

Returns ​

EventSubscription

Inherited from ​

NativeModule.addListener


emit() ​

emit<EventName>(eventName, ...args): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:57

Synchronously calls all the listeners attached to that specific event. The event can include any number of arguments that will be passed to the listeners.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

args ​

...Parameters<BinaryModuleEvents[EventName]>

Returns ​

void

Inherited from ​

NativeModule.emit


listenerCount() ​

listenerCount<EventName>(eventName): number

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:61

Returns a number of listeners added to the given event.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

Returns ​

number

Inherited from ​

NativeModule.listenerCount


removeAllListeners() ​

removeAllListeners(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:52

Removes all listeners for the given event name.

Parameters ​

eventName ​

keyof BinaryModuleEvents

Returns ​

void

Inherited from ​

NativeModule.removeAllListeners


removeListener() ​

removeListener<EventName>(eventName, listener): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:48

Removes a listener for the given event name.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

listener ​

BinaryModuleEvents[EventName]

Returns ​

void

Inherited from ​

NativeModule.removeListener


startObserving()? ​

optional startObserving<EventName>(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:66

Function that is automatically invoked when the first listener for an event with the given name is added. Override it in a subclass to perform some additional setup once the event started being observed.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

Returns ​

void

Inherited from ​

NativeModule.startObserving


stopObserving()? ​

optional stopObserving<EventName>(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:71

Function that is automatically invoked when the last listener for an event with the given name is removed. Override it in a subclass to perform some additional cleanup once the event is no longer observed.

Type Parameters ​

EventName ​

EventName extends keyof BinaryModuleEvents

Parameters ​

eventName ​

EventName

Returns ​

void

Inherited from ​

NativeModule.stopObserving