GoogleRidesharingDriver Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
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
-
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003e\u003ccode\u003eGMTDAuthTokenFetchCompletionHandler\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTDFleetEngineIDString\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTSFleetEngineIDString\u003c/code\u003e is a deprecated string ID type, for data being sent to Fleet Engine, that follows the same formatting rules as \u003ccode\u003eGMTDFleetEngineIDString\u003c/code\u003e.\u003c/p\u003e\n"]]],["The provided content defines three type definitions: `GMTDAuthTokenFetchCompletionHandler`, `GMTDFleetEngineIDString`, and `GMTSFleetEngineIDString` (deprecated). `GMTDAuthTokenFetchCompletionHandler` is a completion handler providing an authorization token or an error. `GMTDFleetEngineIDString` and `GMTSFleetEngineIDString` are string IDs used with Fleet Engine. They must be UTF-8 strings, normalized, no longer than 64 characters, and must not contain '/', ':', '?', ',', or '#'. The SDK will not modify the string values.\n"],null,["# GoogleRidesharingDriver Framework Reference\n\nType-Definitions\n================\n\nThe following type definitions are available globally.\n- `\n ``\n ``\n `\n\n ### [GMTDAuthTokenFetchCompletionHandler](/maps/documentation/mobility/driver-sdk/on-demand/reference/ios/Type-Definitions/GMTDAuthTokenFetchCompletionHandler)\n\n `\n ` \n Completion handler called when an authorization token is available. \n\n #### Declaration\n\n Swift \n\n typealias GMTDAuthTokenFetchCompletionHandler = (String?, (any Error)?) -\u003e Void\n\n Objective-C \n\n typedef void (^GMTDAuthTokenFetchCompletionHandler)(NSString *_Nullable,\n NSError *_Nullable)\n\n #### Parameters\n\n |-------------------|----------------------------------------------------------------------|\n | ` `*authToken*` ` | The authorization token. If an error occurs, this parameter is null. |\n | ` `*error*` ` | The error that occurs if any. |\n\n- `\n ``\n ``\n `\n\n ### [GMTDFleetEngineIDString](/maps/documentation/mobility/driver-sdk/on-demand/reference/ios/Type-Definitions/GMTDFleetEngineIDString)\n\n `\n ` \n Specifies an ID field that is of type String.\n\n The SDK receives string data from other APIs and passes that data unmodified to Fleet\n Engine. However, Fleet Engine requires that some string-typed data conform to specific rules.\n Data passed through the SDK to Fleet Engine can result in request failure if the data format\n does not conform to Fleet Engine rules. To prevent request failures to Fleet Engine, use this\n typedef to identify which fields from incoming calls must follow the following formatting\n rules:\n - The string must be a valid UTF-8 string in UTF normalized form C (see \u003chttp://www.unicode.org/reports/tr15/\u003e).\n - The string must be no longer than 64 characters in length.\n - The string must not contain the characters '/', ':', '?', ',', or '#'.\n\n \u003cbr /\u003e\n\n You are responsible for ensuring that when your client makes calls to Fleet Engine SDKs,\n ID strings conform to the restrictions above. The SDK itself will pass the input values\n unmodified to the backend. \n\n #### Declaration\n\n Objective-C \n\n typedef NSString GMTDFleetEngineIDString\n\n- `\n ``\n ``\n `\n\n ### [GMTSFleetEngineIDString](/maps/documentation/mobility/driver-sdk/on-demand/reference/ios/Type-Definitions/GMTSFleetEngineIDString)\n\n `\n ` \n Deprecated \n Specifies an ID field that is of type String.\n\n The SDK receives string data from other APIs and passes that data unmodified to Fleet\n Engine. However, Fleet Engine requires that some string-typed data conform to specific rules.\n Data passed through the SDK to Fleet Engine can result in request failure if the data format\n does not conform to Fleet Engine rules. To prevent request failures to Fleet Engine, use this\n typedef to identify which fields from incoming calls must follow the following formatting\n rules:\n - The string must be a valid UTF-8 string in UTF normalized form C (see \u003chttp://www.unicode.org/reports/tr15/\u003e).\n - The string must be no longer than 64 characters in length.\n - The string must not contain the characters '/', ':', '?', ',', or '#'.\n\n \u003cbr /\u003e\n\n You are responsible for ensuring that when your client makes calls to Fleet Engine SDKs,\n ID strings conform to the restrictions above. The SDK itself will pass the input values\n unmodified to the backend. \n\n #### Declaration\n\n Objective-C \n\n typedef NSString GMTSFleetEngineIDString"]]
