ping-identity
    Preparing search index...

    Type Alias PushConfig

    Runtime configuration for createPushClient.

    All fields are optional; the client uses platform-default values when omitted. The ios sub-object holds options that are only meaningful on iOS.

    import { createPushClient } from '@ping-identity/rn-push';
    import { configurePushStorage } from '@ping-identity/rn-storage';

    const storage = configurePushStorage({ android: { keyAlias: 'push_key' } });
    const client = createPushClient({ storage, timeoutMs: 20000 });
    type PushConfig = {
        enableCredentialCache?: boolean;
        ios?: { encryptionEnabled?: boolean };
        logger?: JourneyInstance;
        notificationCleanupConfig?: PushNotificationCleanupConfig;
        storage?: JourneyInstance;
        timeoutMs?: number;
    }
    Index

    Properties

    enableCredentialCache? ios? logger? notificationCleanupConfig? storage? timeoutMs?

    Properties

    enableCredentialCache?: boolean

    Whether to enable credential caching.

    false
    ios?: { encryptionEnabled?: boolean }

    iOS-specific configuration options.

    Type Declaration

    • OptionalencryptionEnabled?: boolean

      Whether to encrypt the local push credential database on iOS.

      iOS only. Android uses SQLPushStorage with KeyStorePassphraseProvider by default and ignores this option.

      true
    logger?: JourneyInstance

    Optional JavaScript logger instance.

    Must be created by @ping-identity/rn-logger (logger(...)). Both JavaScript-side and native logs are forwarded through this logger.

    notificationCleanupConfig?: PushNotificationCleanupConfig

    Optional notification cleanup configuration controlling when stored notifications are purged from the local database.

    storage?: JourneyInstance

    Optional custom push storage handle.

    Obtained from configurePushStorage() in @ping-identity/rn-storage. When omitted, the native default SQLite/Keychain storage is used.

    timeoutMs?: number

    Network operation timeout in milliseconds.

    15000

    Settings

    Member Visibility

    On This Page

    Properties