TVOLogParameters

Objective-C

@interface TVOLogParameters : NSObject

Swift

class TVOLogParameters : NSObject

A struct used to pass logging parameters to the log method in <TVOLogger>.

  • TVOLogModule for the logger.

    Declaration

    Objective-C

    @property (nonatomic) TVOLogModule logModule;

    Swift

    var logModule: TVOLogModule { get set }

  • TVOLogLevel for the logger.

    Declaration

    Objective-C

    @property (nonatomic) TVOLogLevel logLevel;

    Swift

    var logLevel: TVOLogLevel { get set }

  • Local Timestamp for the log statement in YY-MM-DD HH:MM:SS.MMM format

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *timeStamp;

    Swift

    var timeStamp: String? { get set }

  • File name for the log statement.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *fileName;

    Swift

    var fileName: String? { get set }

  • Function name for the log statement.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *functionName;

    Swift

    var functionName: String? { get set }

  • Line number for the log statement.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSNumber *lineNumber;

    Swift

    var lineNumber: NSNumber? { get set }
  • tag

    Tag for the log statement.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *tag;

    Swift

    var tag: String? { get set }

  • The thread name/id.

    Declaration

    Objective-C

    @property (nonatomic, copy, nonnull) NSString *thread;

    Swift

    var thread: String { get set }

  • The log statement body.

    Declaration

    Objective-C

    @property (nonatomic, copy, nonnull) NSString *message;

    Swift

    var message: String { get set }

  • Unavailable

    Use initWithModule:logLevel:fileName:functioName:lineNumber:tag:message instead

    Undocumented

    Declaration

    Objective-C

    - (null_unspecified instancetype)init __attribute__((unavailable("Use initWithModule:logLevel:fileName:functioName:lineNumber:tag:message instead")));

  • @brief Initialize the LogParameters.

    Declaration

    Objective-C

    - (null_unspecified instancetype)initWithModule:(TVOLogModule)logModule
                                       logLevel:(TVOLogLevel)logLevel
                                      timeStamp:(nullable NSString *)timeStamp
                                       fileName:(nullable NSString *)fileName
                                   functionName:
                                       (nullable NSString *)functionName
                                     lineNumber:(nullable NSNumber *)lineNumber
                                            tag:(nullable NSString *)tag
                                         thread:(nullable NSString *)thread
                                        message:(nonnull NSString *)message;

    Swift

    init!(module logModule: TVOLogModule, logLevel: TVOLogLevel, timeStamp: String?, fileName: String?, functionName: String?, lineNumber: NSNumber?, tag: String?, thread: String?, message: String)

    Parameters

    logModule

    The TVOLogModule value for the log statement
    logLevel

    The TVOLogLevel for the log statement
    timeStamp

    Local Timestamp in YY-MM-DD HH:MM:SS.MMM format
    fileName

    A nullable string that shows the file name of the log statement
    functionName

    A nullable string that shows the function name of the log statement
    lineNumber

    A nullable number representing the line number of the log statement in the file
    tag

    A nullable string that can be used to specify any user defined tag in the log line
    thread

    A nullable string that can be used to specify the thread name or id
    message

    Nonnull string for the log statement

    Return Value

    An initialized LogParameters instance.

  • @brief Initialize the LogParameters. @discussion This initilizer only initializes required varriables for the log statement. All other parameters are set to nil

    Declaration

    Objective-C

    - (null_unspecified instancetype)initWithModule:(TVOLogModule)logModule
                                       logLevel:(TVOLogLevel)logLevel
                                        message:(nonnull NSString *)message;

    Swift

    init!(module logModule: TVOLogModule, logLevel: TVOLogLevel, message: String)

    Parameters

    logModule

    The TVOLogModule value for the log statement
    logLevel

    The TVOLogLevel for the log statement
    message

    Nonnull string for the log statement

    Return Value

    An initialized LogParameters instance.