Type Definitions

The following type definitions are available globally.

  • Undocumented

    Declaration

    Objective-C

    typedef void (^AWSCancellationBlock)(void)

    Swift

    typealias AWSCancellationBlock = () -> Void

  • Undocumented

    Declaration

    Objective-C

    typedef _AWSVoid_Nonexistant *AWSVoid

    Swift

    typealias AWSVoid = _AWSVoid_Nonexistant

  • Undocumented

    Declaration

    Objective-C

    typedef id _Nullable (^AWSContinuationBlock)(AWSTask<ResultType> *_Nonnull)

    Swift

    typealias AWSContinuationBlock = (AWSTask<ResultType>) -> Any?

  • Undocumented

    Declaration

    Objective-C

    typedef int(^AWSFMDBExecuteStatementsCallbackBlock)(NSDictionary *resultsDictionary)

    Swift

    typealias AWSFMDBExecuteStatementsCallbackBlock = ([AnyHashable : Any]?) -> Int32

  • Undocumented

    Declaration

    Objective-C

    typedef void(^AWSKSReachabilityCallback)(AWSKSReachability* reachability)

    Swift

    typealias AWSKSReachabilityCallback = (AWSKSReachability?) -> Void

  • Undocumented

    Declaration

    Objective-C

    typedef NSString *AWSDDLoggerName

    Swift

    struct AWSDDLoggerName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Undocumented

    Declaration

    Objective-C

    typedef UIColor AWSDDColor

  • Deprecated

    Use AWSDDContextAllowlistFilterLogFormatter instead

    This class provides a log formatter that filters log statements from a logging context not on the whitelist. @deprecated Use AWSDDContextAllowlistFilterLogFormatter instead.

    A log formatter can be added to any logger to format and/or filter its output. You can learn more about log formatters here: Documentation/CustomFormatters.md

    You can learn more about logging context’s here: Documentation/CustomContext.md

    But here’s a quick overview / refresher:

    Every log statement has a logging context. These come from the underlying logging macros defined in AWSDDLog.h. The default logging context is zero. You can define multiple logging context’s for use in your application. For example, logically separate parts of your app each have a different logging context. Also 3rd party frameworks that make use of Lumberjack generally use their own dedicated logging context.

    Declaration

    Objective-C

    typedef AWSDDContextAllowlistFilterLogFormatter
    AWSDDContextWhitelistFilterLogFormatter

  • Deprecated

    Use AWSDDContextDenylistFilterLogFormatter instead

    This class provides a log formatter that filters log statements from a logging context on the blacklist. @deprecated Use AWSDDContextDenylistFilterLogFormatter instead.

    Declaration

    Objective-C

    typedef AWSDDContextDenylistFilterLogFormatter
    AWSDDContextBlacklistFilterLogFormatter

  • Quality of Service names.

    Since macOS 10.10 and iOS 8.0, pthreads, dispatch queues and NSOperations express their scheduling priority by using an abstract classification called Quality of Service (QOS).

    This formatter will add a representation of this QOS in the log message by using those string constants. For example:

    2011-10-17 20:21:45.435 AppName[19928:5207 (QOS:DF)] Your log message here

    Where QOS is one of: - UI = User Interactive - IN = User Initiated - DF = Default - UT = Utility - BG = Background - UN = Unspecified

    Note: QOS will be absent in the log messages if running on OS versions that don’t support it.

    Declaration

    Objective-C

    typedef NSString *AWSDDQualityOfServiceName

    Swift

    struct AWSDDQualityOfServiceName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Undocumented

    Declaration

    Objective-C

    typedef id (^AWSMTLValueTransformerBlock)(id)

    Swift

    typealias AWSMTLValueTransformerBlock = (Any?) -> Any?

  • Undocumented

    Declaration

    Objective-C

    typedef void (^AWSNetworkingUploadProgressBlock) (int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend)

    Swift

    typealias AWSNetworkingUploadProgressBlock = (Int64, Int64, Int64) -> Void

  • Undocumented

    Declaration

    Objective-C

    typedef void (^AWSNetworkingDownloadProgressBlock) (int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite)

    Swift

    typealias AWSNetworkingDownloadProgressBlock = (Int64, Int64, Int64) -> Void