Search Results for

    / fm / liveswitch / Log

    Class: Log

    fm.liveswitch.Log

    Log utility class.

    Table of contents

    Constructors

    • constructor

    Methods

    • getTypeString
    • addProvider
    • debug
    • error
    • fatal
    • flush
    • getDefaultLogLevel
    • getIsDebugEnabled
    • getIsErrorEnabled
    • getIsFatalEnabled
    • getIsInfoEnabled
    • getIsVerboseEnabled
    • getIsWarnEnabled
    • getLogLevel
    • getLogger
    • getProvider
    • getProviders
    • info
    • registerProvider
    • removeProvider
    • removeProviders
    • setDefaultLogLevel
    • setLogLevel
    • setProvider
    • setTagOverride
    • unregisterProvider
    • unregisterProviders
    • verbose
    • warn
    • writeLine

    Constructors

    constructor

    + new Log(): Log

    Returns: Log

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:13

    Methods

    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:9


    addProvider

    ▸ StaticaddProvider(provider: LogProvider): void

    Registers a log provider as a logging target. Alias for RegisterProvider.

    Parameters:

    Name Type Description
    provider LogProvider The new provider.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:34

    ▸ StaticaddProvider(provider: LogProvider, level: LogLevel): void

    Registers a log provider as a logging target, setting its log level in the process. Alias for RegisterProvider.

    Parameters:

    Name Type Description
    provider LogProvider The new provider.
    level LogLevel The log level.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:44


    debug

    ▸ Staticdebug(message: string): void

    Logs a debug-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:64

    ▸ Staticdebug(message: string, ex: Exception): void

    Logs a debug-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:72


    error

    ▸ Staticerror(message: string): void

    Logs an error-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:92

    ▸ Staticerror(message: string, ex: Exception): void

    Logs an error-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:100


    fatal

    ▸ Staticfatal(message: string): void

    Logs a fatal-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:120

    ▸ Staticfatal(message: string, ex: Exception): void

    Logs a fatal-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:128


    flush

    ▸ Staticflush(): void

    Blocks until all logs are written out.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:147


    getDefaultLogLevel

    ▸ StaticgetDefaultLogLevel(): LogLevel

    Gets the default log level.

    Returns: LogLevel

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:160


    getIsDebugEnabled

    ▸ StaticgetIsDebugEnabled(): boolean

    Gets a value indicating whether logging is enabled for debug-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:174


    getIsErrorEnabled

    ▸ StaticgetIsErrorEnabled(): boolean

    Gets a value indicating whether logging is enabled for error-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:188


    getIsFatalEnabled

    ▸ StaticgetIsFatalEnabled(): boolean

    Gets a value indicating whether logging is enabled for fatal-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:202


    getIsInfoEnabled

    ▸ StaticgetIsInfoEnabled(): boolean

    Gets a value indicating whether logging is enabled for info-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:216


    getIsVerboseEnabled

    ▸ StaticgetIsVerboseEnabled(): boolean

    Gets a value indicating whether logging is enabled for verbose-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:230


    getIsWarnEnabled

    ▸ StaticgetIsWarnEnabled(): boolean

    Gets a value indicating whether logging is enabled for warn-level messages for at least one of the registered providers.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:244


    getLogLevel

    ▸ StaticgetLogLevel(): LogLevel

    Gets the default log level.

    deprecated Use DefaultLogLevel instead.

    Returns: LogLevel

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:313


    getLogger

    ▸ StaticgetLogger(tag: string): ILog

    Get a logger for a specific Tag.

    Parameters:

    Name Type Description
    tag string The tag to log to.

    Returns: ILog

    A ILog that will log to the specified tag.

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:259

    ▸ StaticgetLogger(tag: string, level: LogLevel): ILog

    Get a logger for a specific Tag.

    Parameters:

    Name Type Description
    tag string The tag to log to.
    level LogLevel Logger's default log level.

    Returns: ILog

    A ILog that will log to the specified tag.

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:268

    ▸ StaticgetLogger(type: Type): ILog

    Get a logger for a specific Tag. The tag is taken from the class namespace and name.

    Parameters:

    Name Type Description
    type Type The type to use as the tag.

    Returns: ILog

    A ILog that will log to the specified tag.

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:276

    ▸ StaticgetLogger(type: Type, level: LogLevel): ILog

    Get a logger for a specific Tag. The tag is taken from the class namespace and name.

    Parameters:

    Name Type Description
    type Type The type to use as the tag.
    level LogLevel Logger's default log level.

    Returns: ILog

    A ILog that will log to the specified tag.

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:285


    getProvider

    ▸ StaticgetProvider(): LogProvider

    Gets the first log provider.

    Returns: LogProvider

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:326


    getProviders

    ▸ StaticgetProviders(): LogProvider[]

    Gets the log providers.

    Returns: LogProvider[]

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:340


    info

    ▸ Staticinfo(message: string): void

    Logs an info-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:354

    ▸ Staticinfo(message: string, ex: Exception): void

    Logs an info-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:362


    registerProvider

    ▸ StaticregisterProvider(provider: LogProvider): void

    Registers a log provider as a logging target.

    Parameters:

    Name Type Description
    provider LogProvider The provider.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:382

    ▸ StaticregisterProvider(provider: LogProvider, level: LogLevel): void

    Registers a log provider as a logging target, setting its log level in the process.

    Parameters:

    Name Type Description
    provider LogProvider The provider.
    level LogLevel The log level.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:391


    removeProvider

    ▸ StaticremoveProvider(provider: LogProvider): boolean

    Unregisters a log provider as a logging target. Alias for UnregisterProvider.

    Parameters:

    Name Type Description
    provider LogProvider The provider.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:416


    removeProviders

    ▸ StaticremoveProviders(): void

    Unregisters all log providers as logging targets. Alias for UnregisterProviders.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:430


    setDefaultLogLevel

    ▸ StaticsetDefaultLogLevel(value: LogLevel): void

    Sets the default log level.

    Parameters:

    Name Type
    value LogLevel

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:443


    setLogLevel

    ▸ StaticsetLogLevel(value: LogLevel): void

    Sets the default log level.

    deprecated Use DefaultLogLevel instead.

    Parameters:

    Name Type
    value LogLevel

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:457


    setProvider

    ▸ StaticsetProvider(value: LogProvider): void

    Sets the first log provider.

    Parameters:

    Name Type
    value LogProvider

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:470


    setTagOverride

    ▸ StaticsetTagOverride(tag: string, level: LogLevel): void

    Override the default log level for a specific tag.

    Parameters:

    Name Type Description
    tag string The Tag to set the log level to.
    level LogLevel The new loglevel to use.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:486


    unregisterProvider

    ▸ StaticunregisterProvider(provider: LogProvider): boolean

    Unregisters a log provider as a logging target.

    Parameters:

    Name Type Description
    provider LogProvider The provider.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:500


    unregisterProviders

    ▸ StaticunregisterProviders(): void

    Unregisters all log providers as logging targets.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:513


    verbose

    ▸ Staticverbose(message: string): void

    Logs a verbose-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:527

    ▸ Staticverbose(message: string, ex: Exception): void

    Logs a verbose-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:535


    warn

    ▸ Staticwarn(message: string): void

    Logs a warn-level message.

    Parameters:

    Name Type Description
    message string The message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:555

    ▸ Staticwarn(message: string, ex: Exception): void

    Logs a warn-level message.

    Parameters:

    Name Type Description
    message string The message.
    ex Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:563


    writeLine

    ▸ StaticwriteLine(text: string): void

    Writes a line of text to the log.

    Parameters:

    Name Type Description
    text string The text to write to the log.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Log.ts:583

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6