Installation

npm install @rescript-react-native/push-notification-ios#oryarn add @rescript-react-native/push-notification-ios

{  //...  "bs-dependencies": [    "@rescript/react",    "rescript-react-native",    // ...+    "@rescript-react-native/push-notification-ios"  ],  //...}

Usage

Types

ReactNativePushNotificationIOS.Notification.t

typet;// abstract type

ReactNativePushNotificationIOS.localNotification

typelocalNotification;[@bs.obj]externallocalNotification:  (    ~alertBody:string=?,    ~alertTitle:string=?,    ~alertAction:string=?,    ~soundName:string=?,    ~isSilent:bool=?,    ~category:string=?,    ~userInfo:Js.Json.t=?,    ~applicationIconBadgeNumber:int=?,    ~fireDate:Js.Date.t=?,    ~repeatInterval: [@bs.string] [                       |`minute                       | `hour                       |`day                       | `week                       |`month                       | `year                     ]=?,unit  )=>localNotification="";

ReactNativePushNotificationIOS.deliveredNotification

typedeliveredNotification= {identifier:stringdate:option(string)title:option(string)body:option(string)category:option(string)threadId:option(string)userInfo:option(Js.Json.t),};

ReactNativePushNotificationIOS.formattedLocalNotification

typeformattedLocalNotification= {fireDate:option(string),alertAction:option(string),alertTitle:option(string),alertBody:option(string),applicationIconBadgeNumber:option(int),category:option(string),repeatInterval:option(string),soundName:option(string),userInfo:option(Js.Json.t),};

ReactNativePushNotificationIOS.registrationError

typeregistrationError('a)= {message:string,code:int,details:Js.t('a),};

ReactNativePushNotificationIOS.permissions

typepermissions= {alert:bool,badge:bool,sound:bool,lockScreen:bool,notificationCenter:bool,};

ReactNativePushNotificationIOS.requestPermissionsOptions

typerequestPermissionsOptions;[@bs.obj]externalrequestPermissionsOptions:  (~alert:bool=?, ~badge:bool=?, ~sound:bool=?,unit)=>requestPermissionsOptions="";

ReactNativePushNotificationIOS.fetchResult

typefetchResult;[@bs.obj]externalfetchResult:  (~_NewData:string=?, ~_NoData:string=?, ~_ResultFailed:string=?,unit)=>fetchResult="";

Methods

ReactNativePushNotificationIOS.Notification.getAlert

Notification.t=>option(Js.Json.t)

ReactNativePushNotificationIOS.Notification.getTitle

Notification.t=>option(string)

ReactNativePushNotificationIOS.Notification.getMessage

Notification.t=>option(Js.Json.t)

ReactNativePushNotificationIOS.Notification.getSound

Notification.t=>option(string)

ReactNativePushNotificationIOS.Notification.getCategory

Notification.t=>option(string)

ReactNativePushNotificationIOS.Notification.getContentAvailable

Notification.t=>bool

ReactNativePushNotificationIOS.Notification.getBadgeCount

Notification.t=>option(int)

ReactNativePushNotificationIOS.Notification.getData

Notification.t=>option(Js.Json.t)

ReactNativePushNotificationIOS.Notification.getThreadID

Notification.t=>option(string)

ReactNativePushNotificationIOS.presentLocalNotification

localNotification=>unit

ReactNativePushNotificationIOS.scheduleLocalNotification

localNotification=>unit

ReactNativePushNotificationIOS.cancelAllLocalNotifications

unit=>unit

ReactNativePushNotificationIOS.removeAllDeliveredNotifications

unit=>unit

ReactNativePushNotificationIOS.getDeliveredNotifications

(array(deliveredNotification)=>unit)

ReactNativePushNotificationIOS.removeDeliveredNotifications

(~identifiers:array(string))=>unit

ReactNativePushNotificationIOS.setApplicationIconBadgeNumber

int=>unit

ReactNativePushNotificationIOS.getApplicationIconBadgeNumber

(int=>unit)=>unit

ReactNativePushNotificationIOS.cancelLocalNotifications

unit=>unit

ReactNativePushNotificationIOS.cancelLocalNotificationsWithUserInfo

Js.Json.t=>unit

ReactNativePushNotificationIOS.getScheduledLocalNotifications

(array(formattedLocalNotification)=>unit)=>unit

ReactNativePushNotificationIOS.addEventListener

  (  [@bs.string]  [    |`notification(Notification.t => unit)    | `localNotification(Notification.t=>unit)    |`register((~deviceToken: string) => unit)    | `registrationError(registrationError('a)=>unit)  ]  )=>unit

ReactNativePushNotificationIOS.removeEventListener

(  [@bs.string]  [    |`notification(Notification.t => unit)    | `localNotification(Notification.t=>unit)    |`register((~deviceToken: string) => unit)    | `registrationError(registrationError('a)=>unit)  ]  )=>unit

ReactNativePushNotificationIOS.requestPermissions

unit=>Js.Promise.t(permissions)

ReactNativePushNotificationIOS.requestPermissionsWithOptions

requestPermissionsOptions=>Js.Promise.t(permissions)

ReactNativePushNotificationIOS.abandonPermissions

unit=>unit

ReactNativePushNotificationIOS.checkPermissions

(unit=>permissions)=>unit

ReactNativePushNotificationIOS.finish

fetchResult=>unit

ReactNativePushNotificationIOS.getInitialNotification

unit=>Js.Promise.t(Js.Nullable.t(Notification.t))

Changelog

Contribute

Code of Conduct