GoogleRidesharingDriver Framework Reference

  • GMTDAuthTokenFetchCompletionHandler is a completion handler, available in both Swift and Objective-C, that is called when an authorization token is ready, providing the token or an error if one occurred.

  • GMTDFleetEngineIDString defines a string ID type used for data passed to Fleet Engine, which requires specific formatting rules, including UTF-8 encoding, a maximum length of 64 characters, and exclusion of certain characters.

  • GMTSFleetEngineIDString is a deprecated string ID type, for data being sent to Fleet Engine, that follows the same formatting rules as GMTDFleetEngineIDString.

Type-Definitions

The following type definitions are available globally.

  • Completion handler called when an authorization token is available.

    Declaration

    Swift

    typealias GMTDAuthTokenFetchCompletionHandler = (String?, (any Error)?) -> Void

    Objective-C

    typedef void (^GMTDAuthTokenFetchCompletionHandler)(NSString *_Nullable,
                                                    NSError *_Nullable)

    Parameters

    authToken

    The authorization token. If an error occurs, this parameter is null.
    error

    The error that occurs if any.

  • Specifies an ID field that is of type String.

    The SDK receives string data from other APIs and passes that data unmodified to Fleet Engine. However, Fleet Engine requires that some string-typed data conform to specific rules. Data passed through the SDK to Fleet Engine can result in request failure if the data format does not conform to Fleet Engine rules. To prevent request failures to Fleet Engine, use this typedef to identify which fields from incoming calls must follow the following formatting rules:

    • The string must be a valid UTF-8 string in UTF normalized form C (see http://www.unicode.org/reports/tr15/).
    • The string must be no longer than 64 characters in length.
    • The string must not contain the characters ‘/’, ‘:’, ‘?’, ‘,’, or ‘#’.

    You are responsible for ensuring that when your client makes calls to Fleet Engine SDKs, ID strings conform to the restrictions above. The SDK itself will pass the input values unmodified to the backend.

    Declaration

    Objective-C

    typedef NSString GMTDFleetEngineIDString

  • Deprecated

    Specifies an ID field that is of type String.

    The SDK receives string data from other APIs and passes that data unmodified to Fleet Engine. However, Fleet Engine requires that some string-typed data conform to specific rules. Data passed through the SDK to Fleet Engine can result in request failure if the data format does not conform to Fleet Engine rules. To prevent request failures to Fleet Engine, use this typedef to identify which fields from incoming calls must follow the following formatting rules:

    • The string must be a valid UTF-8 string in UTF normalized form C (see http://www.unicode.org/reports/tr15/).
    • The string must be no longer than 64 characters in length.
    • The string must not contain the characters ‘/’, ‘:’, ‘?’, ‘,’, or ‘#’.

    You are responsible for ensuring that when your client makes calls to Fleet Engine SDKs, ID strings conform to the restrictions above. The SDK itself will pass the input values unmodified to the backend.

    Declaration

    Objective-C

    typedef NSString GMTSFleetEngineIDString