@iterable/react-native-sdk - v2.1.0-beta.1
    Preparing search index...

    Class IterableLogger

    A logger class for the Iterable SDK.

    This class is responsible for logging messages based on the configuration provided, is useful in unit testing or debug environments.

    The logging behavior is controlled by the logReactNativeSdkCalls property in IterableConfig.

    If this property is not set, logging defaults to true, which is useful in unit testing or debug environments.

    IterableLogger.logLevel = IterableLogLevel.debug;
    IterableLogger.loggingEnabled = true;

    // This log will show in the developer console
    IterableLogger.log('I will be shown.');

    Iterable.loggingEnabled = false;

    // This log will show in the developer console
    IterableLogger.log('I will NOT be shown.');
    Index

    Constructors

    constructor

    Properties

    loggingEnabled logLevel

    Methods

    debug error info log setLoggingEnabled setLogLevel

    Constructors

    Properties

    loggingEnabled: boolean = DEFAULT_LOGGING_ENABLED

    Whether logs should show in the developer console.

    logLevel: IterableLogLevel = DEFAULT_LOG_LEVEL

    The level of logging.

    This controls which logs will show when using the IterableLogger.error, IterableLogger.debug, and IterableLogger.info methods.

    Methods

    • Logs a message to the console if the log level is IterableLogLevel.debug or IterableLogLevel.error.

      Parameters

      • Optionalmessage: unknown

        The message to be logged.

      • ...optionalParams: unknown[]

      Returns void

      IterableLogger.debug('I will show if the log level is debug and logging is enabled');
      IterableLogger.debug('I will also show if the log level is error and logging is enabled');

    • Logs a message to the console if the log level is IterableLogLevel.error.

      Parameters

      • Optionalmessage: unknown

        The message to be logged.

      • ...optionalParams: unknown[]

      Returns void

      IterableLogger.error('I will only show if the log level is error and logging is enabled');

    • Logs a message to the console if the log level is IterableLogLevel.info, IterableLogLevel.debug or IterableLogLevel.error.

      Parameters

      • Optionalmessage: unknown

        The message to be logged.

      • ...optionalParams: unknown[]

      Returns void

      IterableLogger.info('I will show if the log level is info and logging is enabled');
      IterableLogger.info('I will also show if the log level is debug and logging is enabled');
      IterableLogger.info('I will also show if the log level is error and logging is enabled');

    • Logs a message to the console if logging is enabled.

      Parameters

      • Optionalmessage: unknown

        The message to be logged.

      • ...optionalParams: unknown[]

      Returns void

      IterableLogger.log('I will show if logging is enabled');

    • Sets whether logs should show in the developer console.

      Parameters

      • OptionalloggingEnabled: boolean

        Whether logs should show in the developer console.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods