1 /*
2 * Copyright (C) 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.google.android.mobly.snippet.util
18
19 import android.os.Bundle
20 import com.google.android.mobly.snippet.event.EventCache
21 import com.google.android.mobly.snippet.event.SnippetEvent
22
23 /**
24 * Posts an {@link SnippetEvent} to the event cache with data bundle [fill] by the given function.
25 *
26 * This is a helper function to make your client side codes more concise. Sample usage:
27 * ```
28 * postSnippetEvent(callbackId, "onReceiverFound") {
29 * putLong("discoveryTimeMs", discoveryTimeMs)
30 * putBoolean("isKnown", isKnown)
31 * }
32 * ```
33 *
34 * @param callbackId the callbackId passed to the {@link
35 * com.google.android.mobly.snippet.rpc.AsyncRpc} method.
36 * @param eventName the name of the event.
37 * @param fill the function to fill the data bundle.
38 */
postSnippetEventnull39 fun postSnippetEvent(callbackId: String, eventName: String, fill: Bundle.() -> Unit) {
40 val eventData = Bundle().apply(fill)
41 val snippetEvent = SnippetEvent(callbackId, eventName).apply { data.putAll(eventData) }
42 EventCache.getInstance().postEvent(snippetEvent)
43 }
44