@vertigis/viewer-spec 61.18.2 → 61.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/app-config/schema/common-app-config.schema.json +1 -1
- package/app-config/schema/mobile-app-config.schema.json +1 -1
- package/app-config/schema/web-app-config.schema.json +1 -1
- package/messaging/registry/auth.d.ts +39 -0
- package/messaging/registry/map.d.ts +447 -50
- package/messaging/registry/tasks.d.ts +1 -1
- package/messaging/schema/common-action.reference.json +1 -0
- package/messaging/schema/common-action.schema.json +1 -2
- package/messaging/schema/common-event.reference.json +1 -0
- package/messaging/schema/common-event.schema.json +1 -2
- package/messaging/schema/mobile-action.reference.json +1 -0
- package/messaging/schema/mobile-action.schema.json +1 -2
- package/messaging/schema/mobile-event.reference.json +1 -0
- package/messaging/schema/mobile-event.schema.json +1 -2
- package/messaging/schema/web-action.reference.json +1 -0
- package/messaging/schema/web-action.schema.json +1 -2
- package/messaging/schema/web-auth-command-definitions.md +9 -4
- package/messaging/schema/web-auth-operation-definitions.md +15 -0
- package/messaging/schema/web-event.reference.json +1 -0
- package/messaging/schema/web-event.schema.json +1 -2
- package/messaging/schema/web-map-command-definitions.md +433 -53
- package/messaging/schema/web-tasks-operation-definitions.md +2 -2
- package/package.json +3 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -75,12 +75,36 @@ export declare class AuthCommands extends CommandRegistry {
|
|
|
75
75
|
* indicates whether or not the map should be reloaded when the sign-in is
|
|
76
76
|
* complete. This argument is optional and only supported by VertiGIS Studio
|
|
77
77
|
* Mobile. Default is true.
|
|
78
|
+
*
|
|
79
|
+
* **Example:** Reload the map after signing in.
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
* [
|
|
83
|
+
* {
|
|
84
|
+
* name: "auth.sign-in",
|
|
85
|
+
* arguments: true,
|
|
86
|
+
* },
|
|
87
|
+
* ];
|
|
88
|
+
* ```
|
|
78
89
|
*/
|
|
79
90
|
get signIn(): Command<boolean | void>;
|
|
80
91
|
/**
|
|
81
92
|
* Signs the user out. The argument indicates whether or not the map should
|
|
82
93
|
* be reloaded when the sign-out is complete. This argument is optional and
|
|
83
94
|
* only supported by VertiGIS Studio Mobile. Default is true.
|
|
95
|
+
*
|
|
96
|
+
* **Example:** Reload the map after signing out.
|
|
97
|
+
*
|
|
98
|
+
* ```
|
|
99
|
+
* [
|
|
100
|
+
* {
|
|
101
|
+
* name: "auth.sign-out",
|
|
102
|
+
* arguments: true,
|
|
103
|
+
* },
|
|
104
|
+
* ];
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @mobileOnly
|
|
84
108
|
*/
|
|
85
109
|
get signOut(): Command<boolean | void>;
|
|
86
110
|
}
|
|
@@ -88,6 +112,21 @@ export declare class AuthOperations extends OperationRegistry {
|
|
|
88
112
|
protected readonly _prefix = "auth";
|
|
89
113
|
/**
|
|
90
114
|
* Gets the user that is currently signed into the application.
|
|
115
|
+
*
|
|
116
|
+
* **Example:** Display a notification after obtaining the current user.
|
|
117
|
+
*
|
|
118
|
+
* ```
|
|
119
|
+
* [
|
|
120
|
+
* "auth.get-current-user",
|
|
121
|
+
* {
|
|
122
|
+
* name: "ui.display-notification",
|
|
123
|
+
* arguments: {
|
|
124
|
+
* message: "Signed in as a portal user.",
|
|
125
|
+
* category: "info",
|
|
126
|
+
* },
|
|
127
|
+
* },
|
|
128
|
+
* ];
|
|
129
|
+
* ```
|
|
91
130
|
*/
|
|
92
131
|
get getCurrentUser(): Operation<void, Principal>;
|
|
93
132
|
/**
|