Skip to content

Commit e5d0e5a

Browse files
committed
Mention v1.1.0 requirement for new methods
1 parent 6da892e commit e5d0e5a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,14 @@ Register a user action with Branch.
157157
Create a branch universal object.
158158
**canonicalIdentifier** the unique identifier for the content.
159159
**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).
161161

162162
##### The following methods are available on the resulting branchUniversalObject:
163163

164164
###### <a id='usercompletedaction'></a>[- userCompletedAction(event, state = {}): null](#usercompletedaction)
165165

166+
_Introduced in version 1.1.0_
167+
166168
Report a user action for this Branch Universal Object instance. Create a Branch Universal Object on page load and call `userCompletedAction(RegisterViewEvent)`.
167169

168170
**event** an event name string, either one of the standard events defined by the SDK (as defined [below](#useractions)) or a custom event name.
@@ -202,6 +204,8 @@ universalObject.userCompletedAction(RegisterViewEvent)
202204
The `automaticallyListOnSpotlight` property is ignored on Android.
203205

204206
##### <a id='release'></a>[- release()](#release)
207+
_Introduced in version 1.1.0_
208+
205209
(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.)
206210

207211
##### <a id='useractions'></a>[Register User Actions On An Object](#useractions)

0 commit comments

Comments
 (0)