LGV_MeetingSDK_Transport_Protocol

public protocol LGV_MeetingSDK_Transport_Protocol : AnyObject

This defines requirements for a loosely-coupled transport layer.

  • REQUIRED - The initiator, for creating search commands.

    Declaration

    Swift

    var initiator: LGV_MeetingSDK_SearchInitiator_Protocol? { get }

  • REQUIRED - The parser, for parsing search commands.

    Declaration

    Swift

    var parser: LGV_MeetingSDK_Parser_Protocol? { get }

  • REQUIRED - The transport organization to which this instance is assigned. It should generally be declared weak.

    Declaration

    Swift

    var organization: LGV_MeetingSDK_Organization_Transport_Protocol? { get set }
  • sdkInstance Default implementation

    OPTIONAL, AND SHOULD GENERALLY NOT BE IMPLEMENTED - The SDK instance to which this transport’s organization is assigned.

    Default Implementation

    The default simply returns the organization’s SDK instance.

    Declaration

    Swift

    var sdkInstance: LGV_MeetingSDK? { get }
  • baseURL Default implementation

    OPTIONAL - The “base” URL for the transport target.

    Default Implementation

    Default is nil.

    Declaration

    Swift

    var baseURL: URL? { get set }

  • OPTIONAL - This is used to “short-circuit” the actual network call.

    If this is non-nil, then the Data instance is sent to the callback closure as a “one-shot” call. The property is immediately cleared, after being read. The URL is ignored.

    Declaration

    Swift

    var debugMockDataResponse: Data? { get set }

  • REQUIRED - Creates a URL Request, for the given search parameters.

    Declaration

    Swift

    func ceateURLRequest(type inSearchType: LGV_MeetingSDK_Meeting_Data_Set.SearchConstraints,
                     refinements inSearchRefinements: Set<LGV_MeetingSDK_Meeting_Data_Set.Search_Refinements>
) -> URLRequest?

    Parameters

    type

    Any search type that was specified.
    refinements

    Any search refinements.

    Return Value

    A new URL Request object, ready for a task.