PipelineContext

public class PipelineContext : Sequence
extension PipelineContext: Equatable

Undocumented

Static Methods

  • Create a PipelineContext from a simple dictionary of key-value pairs.

    Declaration

    Swift

    public static func of(keyValues: [AnyHashable : AnyObject]) -> PipelineContext

    Parameters

    keyValues

    Dictionary of key-value pairs. Value must be cast to AnyObject.

    Return Value

    PipelineContext representing the provided dictionary.

  • Create an empty PipelineContext.

    Declaration

    Swift

    public init()

Public Methods

  • Adds a value to the PipelineContext.

    Declaration

    Swift

    public func add(value: AnyObject, forKey key: AnyHashable)

    Parameters

    value

    Object to be added, as AnyObject.
    key

    String key with which to store the object.

  • Adds a value to the PipelineContext.

    Declaration

    Swift

    public func add(value: AnyObject, forKey key: ContextKey)

    Parameters

    value

    Object to be added, as AnyObject.
    key

    ContextKey with which to store the object.

  • Retrieves a keyed value from the PipelineContext.

    Declaration

    Swift

    public func value(forKey key: AnyHashable) -> AnyObject?

    Parameters

    key

    Raw string key to retrieve.

    Return Value

    Value for the given property key, if found, as AnyObject.

  • Retrieves a keyed value from the PipelineContext.

    Declaration

    Swift

    public func value(forKey key: ContextKey) -> AnyObject?

    Parameters

    key

    ContextKey to retrieve.

    Return Value

    Value for the given property key, if found, as AnyObject.

  • Convert the PipelineContext linked list into a simple dictionary.

    Declaration

    Swift

    public func toDict() -> [AnyHashable : AnyObject?]

    Return Value

    Dictionary representation of the PipelineContext.

  • Add a CancellationToken while applying smart defaulting logic. If the client transport options specify a timeout, this will be used to automatically create CancellationTokens for each call, even when a token is not specified. If the client call options contain a CancellationToken with no timeout the default timeout will be applied, if specified in ClientOptions.

    Declaration

    Swift

    public func add(cancellationToken: CancellationToken?, applying clientOptions: ClientOptions)

    Parameters

    cancellationToken

    Optional CancellationToken object.
    clientOptions

    ClientOptions for the client generating the request.

  • Undocumented

    Declaration

    Swift

    public func merge(with newContext: PipelineContext?)

Sequence, IteratorProtocol

PipelineContext

  • Declaration

    Swift

    public static func == (lhs: PipelineContext, rhs: PipelineContext) -> Bool