You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,12 +157,14 @@ Register a user action with Branch.
157
157
Create a branch universal object.
158
158
**canonicalIdentifier** the unique identifier for the content.
159
159
**universalObjectOptions** options for universal object as defined [below](#universalobjectoptions).
160
-
Returns an object with methods `generateShortUrl`, `registerView`, `listOnSpotlight`, `showShareSheet`, `userCompletedAction` and `release`.
160
+
Returns an object with methods `generateShortUrl`, `registerView`, `listOnSpotlight`, `showShareSheet`, `userCompletedAction`(v1.1.0) and `release` (v1.1.0).
161
161
162
162
##### The following methods are available on the resulting branchUniversalObject:
163
163
164
164
###### <aid='usercompletedaction'></a>[- userCompletedAction(event, state = {}): null](#usercompletedaction)
165
165
166
+
_Introduced in version 1.1.0_
167
+
166
168
Report a user action for this Branch Universal Object instance. Create a Branch Universal Object on page load and call `userCompletedAction(RegisterViewEvent)`.
167
169
168
170
**event** an event name string, either one of the standard events defined by the SDK (as defined [below](#useractions)) or a custom event name.
The `automaticallyListOnSpotlight` property is ignored on Android.
203
205
204
206
##### <aid='release'></a>[- release()](#release)
207
+
_Introduced in version 1.1.0_
208
+
205
209
(Optional) Immediately release native resources used by this Branch Universal Object instance. Those resources will eventually be removed if they are unused for some time, but you can also call `release()` when a BUO is no longer used, e.g. in `componentWillUnmount()`. (See the [testbed](./testbed) apps in this repo.)
206
210
207
211
##### <aid='useractions'></a>[Register User Actions On An Object](#useractions)
0 commit comments