AGSRequestConfiguration(Debug) Category Reference

Description

Networking related configuration of resources useful for debugging.

This category contains networking related configuration that can be helpful to debug network traffic. You can change the configuration of any resource individually by specifying it using AGSRemoteResource::requestConfiguration, or you can change it for all resources using #setGlobalConfiguration:. Certain sensitive information including tokens, user names, and passwords are masked in the log file.

Note

You should not use this in production deployment as it may impact performance of the application.

Since

100

Properties
BOOL	debugLogDeleteBeforeEachRun
NSURL *	debugLogFileURL
BOOL	debugLogIgnoreTiledLayerRequests
BOOL	debugLogIncludeRequestHeaders
BOOL	debugLogIncludeResponseHeaders
BOOL	debugLogIncludeTimestamp
BOOL	debugLogRequests
BOOL	debugLogResponses
NSUInteger	debugLogResponseTrimThreshold

Property Documentation

debugLogDeleteBeforeEachRun

- (BOOL) debugLogDeleteBeforeEachRun

readwritenonatomicassign

Indicates whether to delete existing log file before logging begins.

Note

Default value is true. If false, logs will be appended to the existing file at AGSRequestConfiguration::debugLogFileURL, if any.

Since

100.7

Extends class AGSRequestConfiguration.

debugLogFileURL

- (NSURL*) debugLogFileURL

readwritenonatomicstrong

Full path to the debug file location, including file name with extension. This property identifies the file when debug messages are logged for requests and responses. The default value is nil. If this property is nil and logging is turned on, the logs are written to the debug console instead of to a file.

If the file exists when the application starts, it may be deleted or appended to depending on the setting of the property AGSRequestConfiguration::debugLogDeleteBeforeEachRun. If the file does not exist when the application starts, it will be created. The file can grow large quickly, so do not leave logging on for longer than necessary, and remove the file when it is no longer needed.

The file is written in Markdown format for easy visual parsing in a markdown previewing application, so the file name extension ".md" is recommended. Certain sensitive information including tokens, user names, and passwords are masked in the log file.

Note

Default value is nil.

Since

100

Extends class AGSRequestConfiguration.

debugLogIgnoreTiledLayerRequests

- (BOOL) debugLogIgnoreTiledLayerRequests

readwritenonatomicassign

Indicates whether to log tiled layer requests after the layer is loaded.

Note

Default value is false. If true, tiled layer requests will not be logged after the layer is loaded.

Since

100.7

Extends class AGSRequestConfiguration.

debugLogIncludeRequestHeaders

- (BOOL) debugLogIncludeRequestHeaders

readwritenonatomicassign

Indicates whether to log request headers with requests.

Note

Default value is false. This property applies only when AGSRequestConfiguration::debugLogRequests is true.

Since

100.1

Extends class AGSRequestConfiguration.

debugLogIncludeResponseHeaders

- (BOOL) debugLogIncludeResponseHeaders

readwritenonatomicassign

Indicates whether to log response headers with responses.

Note

Default value is false. This property applies only when AGSRequestConfiguration::debugLogResponses is true.

Since

100

Extends class AGSRequestConfiguration.

debugLogIncludeTimestamp

- (BOOL) debugLogIncludeTimestamp

readwritenonatomicassign

Indicates whether to include time stamps with log entries when logging to a file.

Note

Default value is true. This property applies only when logging to a file. Time stamps are always generated by the console log.

Since

100.7

Extends class AGSRequestConfiguration.

debugLogRequests

- (BOOL) debugLogRequests

readwritenonatomicassign

Indicates whether to log requests.

Note

Default value is false.

Since

100

Extends class AGSRequestConfiguration.

debugLogResponses

- (BOOL) debugLogResponses

readwritenonatomicassign

Indicates whether to log responses.

Note

Default value is false.

Since

100

Extends class AGSRequestConfiguration.

debugLogResponseTrimThreshold

- (NSUInteger) debugLogResponseTrimThreshold

readwritenonatomicassign

Maximum number of characters to log for each response string.

Note

Default value is 0, meaning no maximum number of characters.

Since

100.7

Extends class AGSRequestConfiguration.