@acrobits/ipc-sdk 0.12.0-alpha.11 → 0.12.0-alpha.12

package/lib/index.d.ts

@@ -376,6 +376,10 @@ export declare const enum IPCEvents {
      * Event that is fired when the `Host` app sends a new PUSH TOKEN.
      */
     PushToken = "PUSH TOKEN",
+    /**
+     * Event that is fired when the `Host` app sends a new PUSH TOKEN with payload object callback.
+     */
+    PushTokenPayload = "PUSH TOKEN PAYLOAD",
     /**
      * Event that is fired when the `Host` app sends a REQUEST LOGS event.
      */
@@ -527,6 +531,23 @@ export declare class IPCManager {
       * @returns A promise with the Push Token as `string`.
       */
      requestPushToken(): Promise<string>;
+     /**
+      * Requests the `Host` app to provide the Push Token for the current device.
+      *
+      * @param options - Options for the request. Set `extended` to `true` to return the full payload
+      * object instead of just the token.
+      *
+      * @returns A promise with the full Push Token payload object.
+      */
+     requestPushToken(options: {
+         extended: true;
+     }): Promise<{
+         pushToken: string;
+         appId: string;
+         selector: string;
+         isRegistered?: boolean;
+         installationId?: string;
+     }>;
      /**
       * Sends the current badge count to the `Host` app.
       *
@@ -609,7 +630,29 @@ export declare class IPCManager {
       * is received.
       * @returns An unsubscribe callback to remove the listener.
       */
-     onPushToken(callback: (token: string, appId: string, selector: string) => void): () => boolean | undefined;
+     onPushToken(callback: (token: string, appId: string, selector: string) => void): UnsubscribeCallback;
+     /**
+      * Registers a callback to be invoked when a {@link IPCEvents.PushToken} event is received.
+      *
+      * @remarks
+      * When `asPayload` is `true`, the callback receives a single payload object with all fields
+      * including `isRegistered` and `installationId`.
+      *
+      * @param callback - A callback function to be invoked when a {@link IPCEvents.PushToken} event
+      * is received. Receives a payload object with all push token fields.
+      * @param options - Options for the callback registration. Set `asPayload` to `true` to receive
+      * a payload object instead of positional parameters.
+      * @returns An unsubscribe callback to remove the listener.
+      */
+     onPushToken(callback: (payload: {
+         pushToken: string;
+         appId: string;
+         selector: string;
+         isRegistered?: boolean;
+         installationId?: string;
+     }) => void, options: {
+         asPayload: true;
+     }): UnsubscribeCallback;
      /**
       * Registers a callback to be invoked when a {@link IPCEvents.RequestLogs} event is received.
       *
@@ -694,10 +737,19 @@ export declare class IPCManager {
          transportUri: string;
      }
 
-     declare type SelectContactsOptions = {
+     /**
+      * Options for the `selectContacts` method.
+      *
+      * @public
+      */
+     export declare type SelectContactsOptions = {
+         /** Whether to allow `single` or `multi` contact selection. */
          mode: 'single' | 'multi';
+         /** Whether to filter contacts to the selected type. */
          filterToSelectedType: boolean;
+         /** A list of currently selected contacts for multi-select mode. */
          currentContacts?: ContactItem[];
+         /** The types of contacts to return in the result. */
          resultTypes?: ContactType[];
      };