@@ -61,8 +61,7 @@ import cloud.pace.sdk.appkit.communication.generated.model.response.StartNavigat
6161import cloud.pace.sdk.appkit.communication.generated.model.response.VerifyLocationResult
6262
6363/* *
64- * Used for receiving messages from the PWA. These methods are called when the listener is
65- * registered with the [CommunicationManager].
64+ * Used for receiving messages from the PWA. These methods are called when the listener is registered with the [CommunicationManager].
6665 */
6766public interface Communication {
6867 /* *
@@ -87,11 +86,9 @@ public interface Communication {
8786 public suspend fun logout (timeout : Long? ): LogoutResult
8887
8988 /* *
90- * Requests the biometric status, i.e. whether biometric authentication is possible (e.g. via
91- * fingerprint or face recognition).
89+ * Requests the biometric status, i.e. whether biometric authentication is possible (e.g. via fingerprint or face recognition).
9290 *
93- * @param timeout The timeout of getBiometricStatus in milliseconds or null if no timeout should
94- * be used
91+ * @param timeout The timeout of getBiometricStatus in milliseconds or null if no timeout should be used
9592 */
9693 public suspend fun getBiometricStatus (timeout : Long? ): GetBiometricStatusResult
9794
@@ -104,8 +101,7 @@ public interface Communication {
104101 public suspend fun setTOTP (timeout : Long? , setTOTPRequest : SetTOTPRequest ): SetTOTPResult
105102
106103 /* *
107- * Return a TOTP generated by previously saved TOTP secret data for the specified key. The user
108- * should authenticate the access to the secret data e.g. with biometric authentication.
104+ * Return a TOTP generated by previously saved TOTP secret data for the specified key. The user should authenticate the access to the secret data e.g. with biometric authentication.
109105 *
110106 * @param timeout The timeout of getTOTP in milliseconds or null if no timeout should be used
111107 * @param getTOTPRequest The getTOTP request body object
@@ -115,23 +111,24 @@ public interface Communication {
115111 /* *
116112 * Requests to save a string securely on the device for later retrieval.
117113 *
118- * @param timeout The timeout of setSecureData in milliseconds or null if no timeout should be
119- * used
114+ * @param timeout The timeout of setSecureData in milliseconds or null if no timeout should be used
120115 * @param setSecureDataRequest The setSecureData request body object
121116 */
122- public suspend fun setSecureData (timeout : Long? , setSecureDataRequest : SetSecureDataRequest ):
123- SetSecureDataResult
117+ public suspend fun setSecureData (
118+ timeout : Long? ,
119+ setSecureDataRequest : SetSecureDataRequest
120+ ): SetSecureDataResult
124121
125122 /* *
126- * Retrieve a previously saved string value by key. The user should authenticate the access to the
127- * string e.g. with biometric authentication.
123+ * Retrieve a previously saved string value by key. The user should authenticate the access to the string e.g. with biometric authentication.
128124 *
129- * @param timeout The timeout of getSecureData in milliseconds or null if no timeout should be
130- * used
125+ * @param timeout The timeout of getSecureData in milliseconds or null if no timeout should be used
131126 * @param getSecureDataRequest The getSecureData request body object
132127 */
133- public suspend fun getSecureData (timeout : Long? , getSecureDataRequest : GetSecureDataRequest ):
134- GetSecureDataResult
128+ public suspend fun getSecureData (
129+ timeout : Long? ,
130+ getSecureDataRequest : GetSecureDataRequest
131+ ): GetSecureDataResult
135132
136133 /* *
137134 * The current app will no longer be displayed up until the given date.
@@ -144,11 +141,9 @@ public interface Communication {
144141 /* *
145142 * Open the given url in a new browser tab.
146143 * This specifically is the case in the payment process.
147- * Only works when a client schema is set and returned via `appInterceptableLink` or if integrated
148- * is set to true (assuming client listens to default schema: `cloudsdk`).
144+ * Only works when a client schema is set and returned via `appInterceptableLink` or if integrated is set to true (assuming client listens to default schema: `cloudsdk`).
149145 *
150- * @param timeout The timeout of openURLInNewTab in milliseconds or null if no timeout should be
151- * used
146+ * @param timeout The timeout of openURLInNewTab in milliseconds or null if no timeout should be used
152147 * @param openURLInNewTabRequest The openURLInNewTab request body object
153148 */
154149 public suspend fun openURLInNewTab (
@@ -157,46 +152,48 @@ public interface Communication {
157152 ): OpenURLInNewTabResult
158153
159154 /* *
160- * In specific situations the app needs the user's current location to be verified in order to
161- * continue its flow.
155+ * In specific situations the app needs the user's current location to be verified in order to continue its flow.
162156 *
163- * @param timeout The timeout of verifyLocation in milliseconds or null if no timeout should be
164- * used
157+ * @param timeout The timeout of verifyLocation in milliseconds or null if no timeout should be used
165158 * @param verifyLocationRequest The verifyLocation request body object
166159 */
167- public suspend fun verifyLocation (timeout : Long? , verifyLocationRequest : VerifyLocationRequest ):
168- VerifyLocationResult
160+ public suspend fun verifyLocation (
161+ timeout : Long? ,
162+ verifyLocationRequest : VerifyLocationRequest
163+ ): VerifyLocationResult
169164
170165 /* *
171166 * Requests a fresh access token for the currently authenticated user.
172167 *
173- * @param timeout The timeout of getAccessToken in milliseconds or null if no timeout should be
174- * used
168+ * @param timeout The timeout of getAccessToken in milliseconds or null if no timeout should be used
175169 * @param getAccessTokenRequest The getAccessToken request body object
176170 */
177- public suspend fun getAccessToken (timeout : Long? , getAccessTokenRequest : GetAccessTokenRequest ):
178- GetAccessTokenResult
171+ public suspend fun getAccessToken (
172+ timeout : Long? ,
173+ getAccessTokenRequest : GetAccessTokenRequest
174+ ): GetAccessTokenResult
179175
180176 /* *
181177 * Send an base64 encoded png image for sharing with the user.
182178 *
183179 * @param timeout The timeout of imageData in milliseconds or null if no timeout should be used
184180 * @param imageDataRequest The imageData request body object
185181 */
186- public suspend fun imageData (timeout : Long? , imageDataRequest : ImageDataRequest ): ImageDataResult
182+ public suspend fun imageData (
183+ timeout : Long? ,
184+ imageDataRequest : ImageDataRequest
185+ ): ImageDataResult
187186
188187 /* *
189188 * Requests, if Apple Pay is ready to be used (enabled + cards onboarded; iOS only)
190189 *
191- * @param timeout The timeout of applePayAvailabilityCheck in milliseconds or null if no timeout
192- * should be used
190+ * @param timeout The timeout of applePayAvailabilityCheck in milliseconds or null if no timeout should be used
193191 * @param applePayAvailabilityCheckRequest The applePayAvailabilityCheck request body object
194192 */
195193 public suspend fun applePayAvailabilityCheck (
196194 timeout : Long? ,
197195 applePayAvailabilityCheckRequest : ApplePayAvailabilityCheckRequest
198- ):
199- ApplePayAvailabilityCheckResult
196+ ): ApplePayAvailabilityCheckResult
200197
201198 /* *
202199 * The app requests navigating back.
@@ -206,21 +203,18 @@ public interface Communication {
206203 public suspend fun back (timeout : Long? ): BackResult
207204
208205 /* *
209- * Some services (e.g. Paypal) will be opened independently from the web app, see
210- * "openURLInNewTab".
206+ * Some services (e.g. Paypal) will be opened independently from the web app, see "openURLInNewTab".
211207 * On completion, the flow will be redirected to the schema provided to this request.
212208 * This needs to be a unique identifier, e.g. "pace.some_uuid".
213209 *
214- * @param timeout The timeout of appInterceptableLink in milliseconds or null if no timeout should
215- * be used
210+ * @param timeout The timeout of appInterceptableLink in milliseconds or null if no timeout should be used
216211 */
217212 public suspend fun appInterceptableLink (timeout : Long? ): AppInterceptableLinkResult
218213
219214 /* *
220215 * Requests to set a user property for the current user in the analytics backend (e.g. Firebase).
221216 *
222- * @param timeout The timeout of setUserProperty in milliseconds or null if no timeout should be
223- * used
217+ * @param timeout The timeout of setUserProperty in milliseconds or null if no timeout should be used
224218 * @param setUserPropertyRequest The setUserProperty request body object
225219 */
226220 public suspend fun setUserProperty (
@@ -243,7 +237,10 @@ public interface Communication {
243237 * @param timeout The timeout of getConfig in milliseconds or null if no timeout should be used
244238 * @param getConfigRequest The getConfig request body object
245239 */
246- public suspend fun getConfig (timeout : Long? , getConfigRequest : GetConfigRequest ): GetConfigResult
240+ public suspend fun getConfig (
241+ timeout : Long? ,
242+ getConfigRequest : GetConfigRequest
243+ ): GetConfigResult
247244
248245 /* *
249246 * Requests a unique identifier for the user session for tracing purposes.
@@ -262,23 +259,22 @@ public interface Communication {
262259
263260 /* *
264261 * Asks the client for permission to redirect to another web app than the current one.
265- * The client can decide whether the app switch should be allowed or disallowed and intercepted by
266- * the client
267- * (e.g. a client with an own map might not want the web app to redirect to the
268- * fuel-station-finder).
262+ * The client can decide whether the app switch should be allowed or disallowed and intercepted by the client
263+ * (e.g. a client with an own map might not want the web app to redirect to the fuel-station-finder).
269264 * By default, redirects should always be allowed.
270265 *
271266 * @param timeout The timeout of appRedirect in milliseconds or null if no timeout should be used
272267 * @param appRedirectRequest The appRedirect request body object
273268 */
274- public suspend fun appRedirect (timeout : Long? , appRedirectRequest : AppRedirectRequest ):
275- AppRedirectResult
269+ public suspend fun appRedirect (
270+ timeout : Long? ,
271+ appRedirectRequest : AppRedirectRequest
272+ ): AppRedirectResult
276273
277274 /* *
278275 * Checks if biometric authentication is enabled.
279276 *
280- * @param timeout The timeout of isBiometricAuthEnabled in milliseconds or null if no timeout
281- * should be used
277+ * @param timeout The timeout of isBiometricAuthEnabled in milliseconds or null if no timeout should be used
282278 */
283279 public suspend fun isBiometricAuthEnabled (timeout : Long? ): IsBiometricAuthEnabledResult
284280
@@ -292,8 +288,7 @@ public interface Communication {
292288 /* *
293289 * Checks if remote config is available.
294290 *
295- * @param timeout The timeout of isRemoteConfigAvailable in milliseconds or null if no timeout
296- * should be used
291+ * @param timeout The timeout of isRemoteConfigAvailable in milliseconds or null if no timeout should be used
297292 */
298293 public suspend fun isRemoteConfigAvailable (timeout : Long? ): IsRemoteConfigAvailableResult
299294
@@ -303,26 +298,26 @@ public interface Communication {
303298 * @param timeout The timeout of shareText in milliseconds or null if no timeout should be used
304299 * @param shareTextRequest The shareText request body object
305300 */
306- public suspend fun shareText (timeout : Long? , shareTextRequest : ShareTextRequest ): ShareTextResult
301+ public suspend fun shareText (
302+ timeout : Long? ,
303+ shareTextRequest : ShareTextRequest
304+ ): ShareTextResult
307305
308306 /* *
309307 * Requests, if Google Pay is ready to be used (enabled + cards onboarded; Android only)
310308 *
311- * @param timeout The timeout of googlePayAvailabilityCheck in milliseconds or null if no timeout
312- * should be used
309+ * @param timeout The timeout of googlePayAvailabilityCheck in milliseconds or null if no timeout should be used
313310 * @param googlePayAvailabilityCheckRequest The googlePayAvailabilityCheck request body object
314311 */
315312 public suspend fun googlePayAvailabilityCheck (
316313 timeout : Long? ,
317314 googlePayAvailabilityCheckRequest : GooglePayAvailabilityCheckRequest
318- ):
319- GooglePayAvailabilityCheckResult
315+ ): GooglePayAvailabilityCheckResult
320316
321317 /* *
322318 * The Google Pay payment request to be handled (Android only).
323319 *
324- * @param timeout The timeout of googlePayPayment in milliseconds or null if no timeout should be
325- * used
320+ * @param timeout The timeout of googlePayPayment in milliseconds or null if no timeout should be used
326321 * @param googlePayPaymentRequest The googlePayPayment request body object
327322 */
328323 public suspend fun googlePayPayment (
@@ -333,8 +328,7 @@ public interface Communication {
333328 /* *
334329 * Requests to start the navigation to the specified coordinates.
335330 *
336- * @param timeout The timeout of startNavigation in milliseconds or null if no timeout should be
337- * used
331+ * @param timeout The timeout of startNavigation in milliseconds or null if no timeout should be used
338332 * @param startNavigationRequest The startNavigation request body object
339333 */
340334 public suspend fun startNavigation (
@@ -348,22 +342,26 @@ public interface Communication {
348342 * @param timeout The timeout of shareFile in milliseconds or null if no timeout should be used
349343 * @param shareFileRequest The shareFile request body object
350344 */
351- public suspend fun shareFile (timeout : Long? , shareFileRequest : ShareFileRequest ): ShareFileResult
345+ public suspend fun shareFile (
346+ timeout : Long? ,
347+ shareFileRequest : ShareFileRequest
348+ ): ShareFileResult
352349
353350 /* *
354351 * Asks the client for an optional additional receipt email.
355352 *
356353 * @param timeout The timeout of receiptEmail in milliseconds or null if no timeout should be used
357354 * @param receiptEmailRequest The receiptEmail request body object
358355 */
359- public suspend fun receiptEmail (timeout : Long? , receiptEmailRequest : ReceiptEmailRequest ):
360- ReceiptEmailResult
356+ public suspend fun receiptEmail (
357+ timeout : Long? ,
358+ receiptEmailRequest : ReceiptEmailRequest
359+ ): ReceiptEmailResult
361360
362361 /* *
363362 * Asks the client for optional attachments to be included in the fueling receipt.
364363 *
365- * @param timeout The timeout of receiptAttachments in milliseconds or null if no timeout should
366- * be used
364+ * @param timeout The timeout of receiptAttachments in milliseconds or null if no timeout should be used
367365 * @param receiptAttachmentsRequest The receiptAttachments request body object
368366 */
369367 public suspend fun receiptAttachments (
0 commit comments