Class DeveloperLogs

Index

Constructors

Properties

Methods

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

Constructors

constructor

new DeveloperLogs(
    connectionProvider: SalesforceConnectionProvider,
    queryService: QueryService,
    logger: Logger,
): DeveloperLogs
Parameters
- connectionProvider: SalesforceConnectionProvider
- queryService: QueryService
- logger: Logger
Returns DeveloperLogs
- Defined in packages/salesforce/src/developerLogs.ts:14

Properties

`Private` `Readonly`connectionProvider

connectionProvider: SalesforceConnectionProvider

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`queryService

queryService: QueryService

Methods

clearAllTraceFlags

clearAllTraceFlags(): Promise<void>
Removes all active and expired trace flags for the current Salesforce instance.

Returns Promise<void>
- Defined in packages/salesforce/src/developerLogs.ts:189

clearDeveloperLogs

clearDeveloperLogs(
reportProgress?: (progress: { progress: number; total: number }) => any,
token?: CancellationToken,
): Promise<number>
Deletes all Developers for All users from the server and returns te number of delete log entries as number.
Parameters
- OptionalreportProgress: (progress: { progress: number; total: number }) => any
  Reports the progress of the delete operations
- Optionaltoken: CancellationToken
  Cancellation token
Returns Promise<number>
- Defined in packages/salesforce/src/developerLogs.ts:46

clearTraceFlags

clearTraceFlags(traceFlagsId: string): Promise<void>
Clears the specified trace flags from the server
Parameters
- traceFlagsId: string
  Id of the trace flags to clear
Returns Promise<void>
- Defined in packages/salesforce/src/developerLogs.ts:177

clearUserTraceFlags

clearUserTraceFlags(): Promise<void>
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>
- Defined in packages/salesforce/src/developerLogs.ts:196

createDebugLevel

createDebugLevel(
developerName: string,
debugLevel: SalesforceDebugLevel,
): Promise<SalesforceDebugLevelRecord>
Parameters
- developerName: string
- debugLevel: SalesforceDebugLevel
Returns Promise<SalesforceDebugLevelRecord>
- Defined in packages/salesforce/src/developerLogs.ts:90

`Private`deleteToolingRecords

deleteToolingRecords(query: string): Promise<void>
Parameters
- query: string
Returns Promise<void>
- Defined in packages/salesforce/src/developerLogs.ts:220

extendTraceFlags

extendTraceFlags(
traceFlagsId: string,
durationInSeconds?: number,
): Promise<void>
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>
- Defined in packages/salesforce/src/developerLogs.ts:162

`Private`getConnectedUserInfo

getConnectedUserInfo(): Promise<{ id: string; type: string; username: string }>
Gets basic details about the user for the current connection

Returns Promise<{ id: string; type: string; username: string }>
- Defined in packages/salesforce/src/developerLogs.ts:205

getDebugLevels

getDebugLevels(): Promise<SalesforceDebugLevel[]>
Gets a list of the currently configured logging levels in Salesforce

Returns Promise<SalesforceDebugLevel[]>
- Defined in packages/salesforce/src/developerLogs.ts:83

getDeveloperLogs

getDeveloperLogs(
from?: Date,
currentUserOnly?: boolean,
): Promise<DeveloperLog[]>
Retrieves developer logs from the server
Parameters
- Optionalfrom: Date
  Since date
- currentUserOnly: boolean = false
  true if to only query the logs fro the current user otherwise retiree all logs
Returns Promise<DeveloperLog[]>
- Defined in packages/salesforce/src/developerLogs.ts:25

`Private`getJsForceConnection

getJsForceConnection(): Promise<SalesforceConnection>
Returns Promise<SalesforceConnection>
- Defined in packages/salesforce/src/developerLogs.ts:216

setTraceFlags

setTraceFlags(
    debugLevel: string | { id: string },
    type: "DEVELOPER_LOG" | "USER_DEBUG",
    trackedEntityId?: undefined,
    durationInSeconds?: number,
): Promise<string>
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
- OptionaltrackedEntityId: undefined
  Optionally the tracked entity; required for class and use debugging
- OptionaldurationInSeconds: 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
- Defined in packages/salesforce/src/developerLogs.ts:134
setTraceFlags(
    debugLevel: string | { id: string },
    type: "USER_DEBUG" | "CLASS_TRACING",
    trackedEntityId: string,
    durationInSeconds?: number,
): Promise<string>
Set the trace flags based on the specified details.
Parameters
- debugLevel: string | { id: string }
  Logging level to set
- type: "USER_DEBUG" | "CLASS_TRACING"
  Type of logging to set
- trackedEntityId: string
  Optionally the tracked entity; required for class and use debugging
- OptionaldurationInSeconds: 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
- Defined in packages/salesforce/src/developerLogs.ts:135

Class DeveloperLogs

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeveloperLogs

Properties

Private ReadonlyconnectionProvider

Private Readonlylogger

Private ReadonlyqueryService

Methods

clearAllTraceFlags

Returns Promise<void>

clearDeveloperLogs

Parameters

Returns Promise<number>

clearTraceFlags

Parameters

Returns Promise<void>

clearUserTraceFlags

Returns Promise<void>

createDebugLevel

Parameters

Returns Promise<SalesforceDebugLevelRecord>

PrivatedeleteToolingRecords

Parameters

Returns Promise<void>

extendTraceFlags

Parameters

Returns Promise<void>

PrivategetConnectedUserInfo

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

getDebugLevels

Returns Promise<SalesforceDebugLevel[]>

getDeveloperLogs

Parameters

Returns Promise<DeveloperLog[]>

PrivategetJsForceConnection

Returns Promise<SalesforceConnection>

setTraceFlags

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Settings

On This Page

`Private` `Readonly`connectionProvider

`Private` `Readonly`logger

`Private` `Readonly`queryService

`Private`deleteToolingRecords

`Private`getConnectedUserInfo

`Private`getJsForceConnection