वर्शन 1.2.0 से, Navigation 3, DeepLinkRequest और
DeepLinkMatcher क्लास का इस्तेमाल करके, आपके ऐप्लिकेशन में मौजूद डेस्टिनेशन के लिए डीप लिंकिंग की सुविधा देता है.
अपने ऐप्लिकेशन में डीप लिंक की सुविधा जोड़ने के लिए, यह तरीका अपनाएं:
- यह तय करने के लिए कि आपका ऐप्लिकेशन किन यूआरआई को मैनेज कर सकता है, अपने
AndroidManifest.xmlमें इंटेंट फ़िल्टर तय करें. - आने वाले अनुरोधों को अपने
नेविगेशन की से मैप करने के लिए,
DeepLinkMatcherइंस्टेंस बनाएं. - अपनी गतिविधि के
onCreateयाonNewIntentतरीके में, आने वाले अनुरोधों को मैच करें और उसके हिसाब से, बैक स्टैक को अपडेट करें.
DeepLinkRequest बनाना
DeepLinkRequest का मतलब, आने वाला डीप लिंक होता है. इसमें एक
DeepLinkUri और ज़रूरी नहीं कि RequestExtras शामिल हो. इसमें इंटेंट ऐक्शन या MIME टाइप जैसी अतिरिक्त
जानकारी होती है.
// Create a request with a String URI val request = DeepLinkRequest(uri = "https://www.example.com/home") // Create a request from a DeepLinkUri val deepLinkUri = DeepLinkUri("https://www.example.com/home") val requestFromUri = DeepLinkRequest(uri = deepLinkUri) // Create a request with a URI and action val requestWithAction = DeepLinkRequest( uri = "https://www.example.com/home", extras = DeepLinkRequest.actionExtra("android.intent.action.VIEW") ) // Create a request with URI, action and mimeType val requestWithMimeType = DeepLinkRequest( uri = "https://www.example.com/image", extras = requestExtras { put(DeepLinkRequest.ActionExtrasKey, "android.intent.action.VIEW") put(DeepLinkRequest.Companion.MimeTypeExtrasKey, "image/png") } )
DeepLinkRequest के एक्स्ट्रा उपलब्ध कराना
डीप लिंक से जुड़ी अतिरिक्त जानकारी सेव करने के लिए, RequestExtras क्लास का इस्तेमाल करें. एक्स्ट्रा को टाइप-सेफ़ तरीके से तय करने और इंस्टैंशिएट करने के लिए,
लाइब्रेरी RequestExtrasKey इंटरफ़ेस और
requestExtras DSL उपलब्ध कराती है.
इसके अलावा, लाइब्रेरी दो एक्स्ट्रा की और उनसे जुड़े हेल्पर उपलब्ध कराती है:
MimeTypeExtrasKey: इसका इस्तेमाल, एमआईएमई टाइपStringको सेव करने के लिए किया जाता है.ActionExtrasKey(सिर्फ़ Android के लिए): इसका इस्तेमाल,Intentके ऐक्शनStringको सेव करने के लिए किया जाता है.
val extras: RequestExtras = requestExtras { put(DeepLinkRequest.Companion.MimeTypeExtrasKey, "application/json") put(DeepLinkRequest.ActionExtrasKey, Intent.ACTION_VIEW) } // Access typed values using the get operator val mimeType: String? = extras[DeepLinkRequest.Companion.MimeTypeExtrasKey] val action: String? = extras[DeepLinkRequest.ActionExtrasKey] // Create extras using helper functions and combine them val mimeTypeExtras: RequestExtras = DeepLinkRequest.mimeTypeExtra("application/json") val combinedExtras: RequestExtras = extras + DeepLinkRequest.actionExtra(Intent.ACTION_VIEW)
अपने कस्टम एक्स्ट्रा तय करने के लिए, टाइप किए गए जेनेरिक के साथ RequestExtrasKey
इंटरफ़ेस लागू करें:
// Define a custom typed key: object CampaignIdExtrasKey : RequestExtrasKey<String> val customExtras: RequestExtras = requestExtras { put(CampaignIdExtrasKey, "123") } val campaignId: String? = customExtras[CampaignIdExtrasKey]
खाली इंस्टेंस बनाने के लिए, emptyRequestExtras() का इस्तेमाल भी किया जा सकता है. इसके अलावा,
+ (plus) और - (minus) ऑपरेटरों का इस्तेमाल करके, एक्स्ट्रा को जोड़ा जा सकता है.
Intent से DeepLinkRequest बनाना
Android पर, सीधे Intent से DeepLinkRequest बनाया जा सकता है. इस तरीके से बनाने पर, DeepLinkRequest इस तरह बनता है:
uriको इंटेंट केdataफ़ील्ड से कॉपी किया जाता है.- अगर यह शून्य नहीं है, तो एमआईएमई टाइप और ऐक्शन एक्स्ट्रा को इंटेंट के संबंधित फ़ील्ड से सेट किया जाता है.
- शून्य नहीं होने वाली सभी
intent.extrasकोDeepLinkRequest.IntentExtrasKeyमेंSavedStateके तौर पर सेव किया जाता है. extrasपैरामीटर का इस्तेमाल करके दिए गए सभी अतिरिक्त एक्स्ट्रा को जोड़ा जाता है.
object CampaignIdExtrasKey : RequestExtrasKey<String> val intent = Intent(Intent.ACTION_VIEW).apply { data = Uri.parse("https://www.example.com/item/42") type = "application/json" putExtra("user_id", "123") } val request = DeepLinkRequest( intent = intent, extras = requestExtras { put(CampaignIdExtrasKey, "spring_promo") } ) // The resulting DeepLinkRequest contains: val uri = request.uri // "https://www.example.com/item/42" val action = request.extras[DeepLinkRequest.ActionExtrasKey] // "android.intent.action.VIEW" val mimeType = request.extras[DeepLinkRequest.Companion.MimeTypeExtrasKey] // "application/json" val intentExtras: SavedState? = request.extras[DeepLinkRequest.IntentExtrasKey] val userId: String? = intentExtras?.read { getStringOrNull("user_id") } // "123" val campaignId: String? = request.extras[CampaignIdExtrasKey] // "spring_promo"
DeepLinkMatcher इंस्टेंस बनाना
एक DeepLinkMatcher, आने वाले DeepLinkRequest इंस्टेंस को
नेविगेशन की से मैप करता है. इन्हें आपके ऐप्लिकेशन के बैक स्टैक में जोड़ा जा सकता है. Navigation 3
में तीन बिल्ट-इन मैचिंग टूल उपलब्ध हैं: UriDeepLinkMatcher पैटर्न के आधार पर यूआरआई मैच करने के लिए, StaticKeyDeepLinkMatcher सामान्य लिंक के लिए, और
BackStackMatcher सिंथेटिक बैक स्टैक बनाने के लिए. लाइब्रेरी, बिल्ट-इन
मैचिंग टूल से कवर न होने वाले इस्तेमाल के उदाहरणों के लिए, कस्टम मैचिंग टूल भी उपलब्ध कराती है.
ज़्यादा जानकारी के लिए, DeepLinkMatchers बनाना देखें.
इंटेंट फ़िल्टर जोड़ना
डीप लिंक की मदद से अपनी गतिविधि शुरू करने के लिए, आपको अपने ऐप्लिकेशन के AndroidManifest.xml में मैचिंग
<intent-filter> एलिमेंट तय करने होंगे. ज़्यादा जानकारी के लिए, आने वाले लिंक के लिए इंटेंट फ़िल्टर जोड़ना देखें.
आने वाले अनुरोध को मैच करना
आपके इंस्टेंसDeepLinkMatcher बनाने के बाद, आप अपनी गतिविधि में आने वाले अनुरोधों को मैच कर सकते हैं.
आने वाले अनुरोध को मैच करने के लिए, यह तरीका अपनाएं:
- अपने
DeepLinkMatcherइंस्टेंस को इंस्टैंशिएट करें. - अपने सभी
DeepLinkMatcherइंस्टेंस को, साफ़ तौर पर या मल्टीबाइंडिंग का इस्तेमाल करके एक साथ इकट्ठा करें. - आने वाले
Intentसे,DeepLinkRequestबनाएं. - सभी मैचिंग टूल के ख़िलाफ़ अनुरोध को मैच करें और सबसे अच्छा मैच ढूंढें.
- मैच के नतीजे से, पिछली गतिविधियां बनाएं.
// 1. Instantiate your DeepLinkMatcher instances. val homeMatcher = StaticKeyDeepLinkMatcher(HomeKey, listOf(DeepLinkMatcher.actionFilter(Intent.ACTION_VIEW))) val userProfileMatcher = UriDeepLinkMatcher( DeepLinkUri("www.example.com/users/{id}"), serializer<UserProfileKey>() ).withBackStack { matchResult -> listOf(HomeKey, matchResult.key) } val telMatcher = TelDeepLinkMatcher() // 2. Collate all of your DeepLinkMatcher instances. // Note: Collating matchers with different generic types requires wildcards, // erasing the specific generic types. val deepLinkMatchers: List<DeepLinkMatcher<*, *>> = listOf( homeMatcher, userProfileMatcher, telMatcher ) class MainActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // ... // 3. Create a DeepLinkRequest from the incoming Intent val request = DeepLinkRequest(intent = intent) // 4. Match the request against all matchers and find the best match. // Because DeepLinkMatcher.MatchResult implements Comparable, you can // use maxOrNull() to find the best match. val matchResult = deepLinkMatchers .mapNotNull { it.match(request) } // List<DeepLinkMatcher.MatchResult<*>> .maxOrNull() // DeepLinkMatcher.MatchResult<*>? // 5. Create the back stack from the match result (or fall back to a default). val backStack: List<NavKey> = when (matchResult) { // If no match is found, use the default back stack (e.g., HomeKey) null -> listOf(HomeKey) // If a BackStackMatchResult is found, use the back stack from the result is BackStackMatchResult<*, *> -> { // Because star-projected matchers erase the key type, cast the back stack to List<NavKey>. @Suppress("UNCHECKED_CAST") matchResult.backStack as List<NavKey> } // Otherwise, use the key from the match result to make a single-item back stack else -> listOf(matchResult.key as NavKey) } } }