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.
|
-
Completion handler type definition for the create and update task operations.
Declaration
Swift
typealias GMTDDeliveryTaskManagerCompletionHandler = (GMTDDeliveryTask?, (any Error)?) -> Void
Objective-C
typedef void (^GMTDDeliveryTaskManagerCompletionHandler)(
GMTDDeliveryTask *_Nullable, NSError *_Nullable)
Parameters
task
|
The created or updated delivery task. If the requests fails, is null.
|
error
|
The error that occurs. If the request succeeds, is null.
|
-
Completion handler type definition for the create and get vehicle operations.
Declaration
Swift
typealias GMTDDeliveryVehicleManagerCompletionHandler = (GMTDDeliveryVehicle?, (any Error)?) -> Void
Objective-C
typedef void (^GMTDDeliveryVehicleManagerCompletionHandler)(
GMTDDeliveryVehicle *_Nullable, NSError *_Nullable)
Parameters
vehicle
|
The created or retrieved delivery vehicle. If request fails, is null.
|
error
|
The error that occurs. If request succeeds, is null.
|
-
Declaration
Swift
typealias GMTDVehicleReporterStopCompletionHandler = ([GMTDVehicleStop]?, (any Error)?) -> Void
Objective-C
typedef void (^GMTDVehicleReporterStopCompletionHandler)(
NSArray<GMTDVehicleStop *> *_Nullable, NSError *_Nullable)
Parameters
stops
|
|
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-01-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-21 UTC."],[[["\u003cp\u003eThis page details globally available type definitions for the Mobility Driver SDK for iOS.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTDAuthTokenFetchCompletionHandler\u003c/code\u003e provides a completion handler that returns an authorization token or an error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTDDeliveryTaskManagerCompletionHandler\u003c/code\u003e is a completion handler for creating and updating delivery tasks, returning the task or an error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTDDeliveryVehicleManagerCompletionHandler\u003c/code\u003e handles the creation and retrieval of delivery vehicles, providing the vehicle or an error upon completion.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMTDFleetEngineIDString\u003c/code\u003e and \u003ccode\u003eGMTSFleetEngineIDString\u003c/code\u003e define string ID fields that must adhere to specific UTF-8 formatting rules to prevent request failures, with the latter being deprecated.\u003c/p\u003e\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/scheduled/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 ### [GMTDDeliveryTaskManagerCompletionHandler](/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Type-Definitions/GMTDDeliveryTaskManagerCompletionHandler)\n\n `\n ` \n Completion handler type definition for the create and update task operations. \n\n #### Declaration\n\n Swift \n\n typealias GMTDDeliveryTaskManagerCompletionHandler = (/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDDeliveryTask?, (any Error)?) -\u003e Void\n\n Objective-C \n\n typedef void (^GMTDDeliveryTaskManagerCompletionHandler)(\n /maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDDeliveryTask *_Nullable, NSError *_Nullable)\n\n #### Parameters\n\n |---------------|-----------------------------------------------------------------------|\n | ` `*task*` ` | The created or updated delivery task. If the requests fails, is null. |\n | ` `*error*` ` | The error that occurs. If the request succeeds, is null. |\n\n- `\n ``\n ``\n `\n\n ### [GMTDDeliveryVehicleManagerCompletionHandler](/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Type-Definitions/GMTDDeliveryVehicleManagerCompletionHandler)\n\n `\n ` \n Completion handler type definition for the create and get vehicle operations. \n\n #### Declaration\n\n Swift \n\n typealias GMTDDeliveryVehicleManagerCompletionHandler = (/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDDeliveryVehicle?, (any Error)?) -\u003e Void\n\n Objective-C \n\n typedef void (^GMTDDeliveryVehicleManagerCompletionHandler)(\n /maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDDeliveryVehicle *_Nullable, NSError *_Nullable)\n\n #### Parameters\n\n |-----------------|-----------------------------------------------------------------------|\n | ` `*vehicle*` ` | The created or retrieved delivery vehicle. If request fails, is null. |\n | ` `*error*` ` | The error that occurs. If request succeeds, is null. |\n\n- `\n ``\n ``\n `\n\n ### [GMTDVehicleReporterStopCompletionHandler](/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Type-Definitions/GMTDVehicleReporterStopCompletionHandler)\n\n `\n ` \n Handler for updating stops via the [GMTDDeliveryVehicleReporter](/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDDeliveryVehicleReporter). \n\n #### Declaration\n\n Swift \n\n typealias GMTDVehicleReporterStopCompletionHandler = ([/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDVehicleStop]?, (any Error)?) -\u003e Void\n\n Objective-C \n\n typedef void (^GMTDVehicleReporterStopCompletionHandler)(\n NSArray\u003c/maps/documentation/mobility/driver-sdk/scheduled/reference/ios/Classes/GMTDVehicleStop *\u003e *_Nullable, NSError *_Nullable)\n\n #### Parameters\n\n |---------------|-------------------------------|\n | ` `*stops*` ` | The updated stops. |\n | ` `*error*` ` | The error that occurs if any. |\n\n- `\n ``\n ``\n `\n\n ### [GMTDFleetEngineIDString](/maps/documentation/mobility/driver-sdk/scheduled/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/scheduled/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"]]
