GoogleRidesharingConsumer Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Type-Definitions
The following type definitions are available globally.
-
Completion block called when an authorization token is available.
Declaration
Swift
typealias GMTCAuthTokenFetchCompletionHandler = (String?, (any Error)?) -> Void
Objective-C
typedef void (^GMTCAuthTokenFetchCompletionHandler)(NSString *_Nullable,
NSError *_Nullable)
Parameters
authToken
|
The authorization token. Will be null if an error occurs.
|
error
|
The error that occurred 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 GMTCFleetEngineIDString
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\u003eGMTCAuthTokenFetchCompletionHandler\u003c/code\u003e is a completion block triggered when an authorization token is ready, providing the token or an error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGMTCAuthTokenFetchCompletionHandler\u003c/code\u003e type definition can take an authorization token or an error as parameters.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTCFleetEngineIDString\u003c/code\u003e defines an ID field of type String, used for data sent to Fleet Engine, which will not be modified by the SDK.\u003c/p\u003e\n"],["\u003cp\u003eString-type fields passed to Fleet Engine via \u003ccode\u003eGMTCFleetEngineIDString\u003c/code\u003e must adhere to specific UTF-8, length, and character restrictions to prevent request failures.\u003c/p\u003e\n"]]],[],null,["# GoogleRidesharingConsumer Framework Reference\n\nType-Definitions\n================\n\nThe following type definitions are available globally.\n- `\n ``\n ``\n `\n\n ### [GMTCAuthTokenFetchCompletionHandler](/maps/documentation/mobility/journey-sharing/on-demand/reference/ios/Type-Definitions/GMTCAuthTokenFetchCompletionHandler)\n\n `\n ` \n Completion block called when an authorization token is available. \n\n #### Declaration\n\n Swift \n\n typealias GMTCAuthTokenFetchCompletionHandler = (String?, (any Error)?) -\u003e Void\n\n Objective-C \n\n typedef void (^GMTCAuthTokenFetchCompletionHandler)(NSString *_Nullable,\n NSError *_Nullable)\n\n #### Parameters\n\n |-------------------|-----------------------------------------------------------|\n | ` `*authToken*` ` | The authorization token. Will be null if an error occurs. |\n | ` `*error*` ` | The error that occurred if any. |\n\n- `\n ``\n ``\n `\n\n ### [GMTCFleetEngineIDString](/maps/documentation/mobility/journey-sharing/on-demand/reference/ios/Type-Definitions/GMTCFleetEngineIDString)\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 GMTCFleetEngineIDString"]]
