Skip to content

Commit 61d57d9

Browse files
authored
Added node field descriptions (#7)
1 parent 5c12d62 commit 61d57d9

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

addon/Deeplink.gd

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,43 @@ const PLUGIN_SINGLETON_NAME: String = "@pluginName@"
1111

1212
const DEEPLINK_RECEIVED_SIGNAL_NAME = "deeplink_received"
1313

14-
@export_category("Link")
14+
@export_category("Details")
15+
## The part of the URL that identifies the protocol and the specific app to open, such as 'http' or a custom
16+
## scheme like 'myapp'. It tells the operating system which application is responsible for handling the link and
17+
## launching it, often leading to a specific screen or function within the app.
18+
@export var scheme: String = "https"
19+
20+
## The host is the domain name of the server that provides the linked content, for example, example.com in
21+
## https://example.com/app-page. It identifies the website or service the deeplink is connected to, allowing a
22+
## device to route the user to the correct app.
23+
@export var host: String = ""
24+
25+
## A path prefix in a deeplink is a specific part of a URL that is used to map a web link to a particular
26+
## activity or screen within an app. For example, a path prefix like /recipe would route any URL with that
27+
## prefix, such as http://www.recipe-app.com/recipe/grilled-potato-salad, directly to the recipe viewing screen
28+
## for the specified recipe in the app instead of the website.
29+
@export var path_prefix: String = ""
30+
31+
@export_category("Android-specific")
32+
@export_group("Intent")
33+
## In Android, the android:label attribute within an <intent-filter> element serves to provide a user-readable
34+
## label for the capabilities described by that specific intent filter. This label is displayed to the user
35+
## when the activity is presented as an option to handle an intent that matches the filter.
1536
@export var label: String = ""
37+
38+
## The android:autoVerify="true" attribute in an Android intent-filter is a crucial component for implementing
39+
## Android App Links. It signals to the Android system that the app should be automatically verified as the
40+
## default handler for specific web domains and schemes defined within the intent filter.
1641
@export var is_auto_verify: bool = true
17-
@export_category("Link Category")
42+
43+
@export_group("Intent Category")
44+
## The android.intent.category.DEFAULT category in an Android intent-filter indicates that the activity
45+
## can be the target of an implicit intent when no other specific category is explicitly declared in the intent.
1846
@export var is_default: bool = true
47+
48+
## The android.intent.category.BROWSABLE category in an Android intent-filter signifies that the target
49+
## activity can be safely launched by a web browser or other applications that handle web links.
1950
@export var is_browsable: bool = true
20-
@export_category("Link Data")
21-
@export var scheme: String = "https"
22-
@export var host: String = ""
23-
@export var path_prefix: String = ""
2451

2552
var _plugin_singleton: Object
2653

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)