ProfileHandlerProtocol

public protocol ProfileHandlerProtocol : OwnedInstanceProtocol

This protocol is used to define the basic interface for our ONVIF Profile implementation classes.

  • This is the scope enum for this handler.

    Declaration

    Swift

    static var scopeProfile: RVS_ONVIF_Core.Scope.ProfileType { get }
  • These are the namespaces handled by this profile handler.

    Declaration

    Swift

    static var namespaces: [String] { get }
  • This is which of the profile namespaces are supported by this device. Latest version is last.

    Declaration

    Swift

    var supportedNamespaces: [String] { get set }
  • This is the profile name key.

    Declaration

    Swift

    var profileName: String { get }
  • This is a list of the commands (as enum values) available for this enum

    Declaration

    Swift

    var availableCommands: [RVS_ONVIF_DeviceRequestProtocol] { get }
  • availableCommandsAsStrings Default implementation

    This is a list of the commands (as Strings) available for this handler

    Default Implementation

    This is a list of the commands (as Strings) available for this handler

    Declaration

    Swift

    var availableCommandsAsStrings: [String] { get }
  • profileNamespace(_:) Default implementation

    This is the profile namespace (for looking up in the services list).

    Default Implementation

    This is the profile namespace (for looking up in the services list).

    Declaration

    Swift

    func profileNamespace(_ inIndex: Int) -> String

    Parameters

    inIndex

    This is an index into the namespace array.

  • This is called upon a successful SOAP call.

    Declaration

    Swift

    func callbackHandler(_ responseDictionary: [String : Any], soapRequest: String, soapEngine: SOAPEngine?) -> Bool

    Parameters

    inResponseDictionary

    The Dictionary ([String: Any]) of the response data.

    soapRequest

    The SOAP request object call, as a String

    soapEngine

    The SOAPEngine object that executed the request. This can be nil

    Return Value

    true, if the callback was handled (including as an error).