Class DeveloperLogs

Hierarchy

  • DeveloperLogs

Constructors

constructor

Properties

connectionProvider logger queryService

Methods

clearAllTraceFlags clearDeveloperLogs clearTraceFlags clearUserTraceFlags createDebugLevel deleteToolingRecords extendTraceFlags getConnectedUserInfo getDebugLevels getDeveloperLogs getJsForceConnection setTraceFlags

Constructors

constructor

Properties

Private Readonly connectionProvider

connectionProvider: SalesforceConnectionProvider

Private Readonly logger

logger: Logger

Private Readonly queryService

queryService: QueryService

Methods

clearAllTraceFlags

clearDeveloperLogs

  • Deletes all Developers for All users from the server and returns te number of delete log entries as number.

    Parameters

    • Optional reportProgress: ((progress) => any)

      Reports the progress of the delete operations

        • (progress): any

        • Parameters

          • progress: {
                progress: number;
                total: number;
            }
            • progress: number
            • total: number

          Returns any

    • Optional token: CancellationToken

      Cancellation token

    Returns Promise<number>

clearTraceFlags

  • Clears the specified trace flags from the server

    Parameters

    • traceFlagsId: string

      Id of the trace flags to clear

    Returns Promise<void>

clearUserTraceFlags

  • Clear all trace flags for the currently connected user; deletes TraceFlag where TracedEntityId is set to the id of the current user

    Returns Promise<void>

createDebugLevel

Private deleteToolingRecords

extendTraceFlags

  • Extends/refresh the trace flag with the specified ID

    Parameters

    • traceFlagsId: string

      Id of the trace flags to extend

    • durationInSeconds: number = 3600

      Number of seconds starting now by which to extend the trace flag

    Returns Promise<void>

Private getConnectedUserInfo

  • Gets basic details about the user for the current connection

    Returns Promise<{
        id: string;
        type: string;
        username: string;
    }>

getDebugLevels

getDeveloperLogs

  • Retrieves developer logs from the server

    Parameters

    • Optional from: Date

      Since date

    • currentUserOnly: boolean = false

      true if to only query the logs fro the current user otherwise retiree all logs

    Returns Promise<DeveloperLog[]>

Private getJsForceConnection

setTraceFlags

  • Set the trace flags based on the specified details.

    Parameters

    • debugLevel: string | {
          id: string;
      }

      Logging level to set

    • type: "DEVELOPER_LOG" | "USER_DEBUG"

      Type of logging to set

    • Optional trackedEntityId: undefined

      Optionally the tracked entity; required for class and use debugging

    • Optional durationInSeconds: number

      Duration of the logging sessions; default is 1 hour or 3600 seconds

    Returns Promise<string>

    Trace flag instance id which can be used to extend or clear

  • Parameters

    • debugLevel: string | {
          id: string;
      }
    • type: "USER_DEBUG" | "CLASS_TRACING"
    • trackedEntityId: string
    • Optional durationInSeconds: number

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page