Functions

The following functions are available globally.

  • @abstract Returns a description for a given type of transport.

    @discussion This method will return a string describing the type of transport given as argument. These strings should be suitable for presenting to the end user, as they are descriptive of the underlying type of transport. This method always returns the transport type’s full name if it’s a single type of transport, and None if there’s no transport type at all, as well as Mixed if several types of transport are represented by the enumeration.

    @returns The transport type description.

    Declaration

    Objective-C

    NSString *HYPTransportTypeDescription(HYPTransportType transportType)

    Swift

    func HYPTransportTypeDescription(_ transportType: HYPTransportType) -> String!

    Parameters

    transportType

    The transport type to describe.

  • @abstract Returns a short description of the given transport type.

    @discussion Short descriptions are not suitable for displaying to the end user, but they are useful for development, as they are short and unique for each kind of transport. All short descriptions are three characters long. BLE stands for Bluetooth Low Energy, BLC stands for Bluetooth Classic, WFD stands for Wi-Fi Direct, WFI stands for Infrastructural Wi-Fi, and WEB stands for an Internet transport. Combined transports yield a MIX tag and the absence of transports yields NON.

    @returns The transport type short description.

    Declaration

    Objective-C

    NSString *HYPTransportTypeShortDescription(HYPTransportType transportType)

    Swift

    func HYPTransportTypeShortDescription(_ transportType: HYPTransportType) -> String!

    Parameters

    transportType

    The transport type to describe.