Interface Spec

src/NativeOneSignal.ts:6–104

import type { EventEmitter } from 'react-native/Libraries/Types/CodegenTypes';

export interface Spec extends TurboModule {
  // OneSignal root
  initialize(appId: string): void;
  login(externalId: string): void;
  logout(): void;
  setPrivacyConsentRequired(required: boolean): void;
  setPrivacyConsentGiven(granted: boolean): void;

  // Debug
  setLogLevel(logLevel: number): void;
  setAlertLevel(logLevel: number): void;

  // Live Activities (iOS only, stubs on Android)
  enterLiveActivity(activityId: string, token: string, callback: (result: Object) => void): void;

  /** @deprecated Currently unsupported, avoid using this method. */
  exitLiveActivity(activityId: string, callback: (result: Object) => void): void;

  setPushToStartToken(activityType: string, token: string): void;
  removePushToStartToken(activityType: string): void;
  setupDefaultLiveActivity(options: Object | null): void;
  startDefaultLiveActivity(activityId: string, attributes: Object, content: Object): void;

  // Push Subscription
  addPushSubscriptionObserver(): void;
  getPushSubscriptionId(): Promise<string | null>;
  getPushSubscriptionToken(): Promise<string | null>;
  getOptedIn(): Promise<boolean>;
  optIn(): void;
  optOut(): void;

  // User
  addUserStateObserver(): void;
  getOnesignalId(): Promise<string | null>;
  getExternalId(): Promise<string | null>;
  setLanguage(language: string): void;
  addAlias(label: string, id: string): void;
  addAliases(aliases: Object): void;
  removeAlias(label: string): void;
  removeAliases(labels: string[]): void;
  addEmail(email: string): void;
  removeEmail(email: string): void;
  addSms(smsNumber: string): void;
  removeSms(smsNumber: string): void;
  addTag(key: string, value: string): void;
  removeTag(key: string): void;
  addTags(tags: Object): void;
  removeTags(keys: string[]): void;
  getTags(): Promise<Object>;
  trackEvent(name: string, properties: Object | null): void;

  // Notifications
  hasNotificationPermission(): Promise<boolean>;
  requestNotificationPermission(fallbackToSettings: boolean): Promise<boolean>;
  canRequestNotificationPermission(): Promise<boolean>;
  registerForProvisionalAuthorization(callback: (accepted: boolean) => void): void;
  permissionNative(): Promise<number>;
  addNotificationClickListener(): void;