From e5d0e5a1fce756e6033f5dd6606dbbd7ddb7e45d Mon Sep 17 00:00:00 2001 From: Jimmy Dee Date: Thu, 16 Mar 2017 14:10:26 -0700 Subject: [PATCH] Mention v1.1.0 requirement for new methods --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cb8d7d97..41ff1fc6b 100644 --- a/README.md +++ b/README.md @@ -157,12 +157,14 @@ Register a user action with Branch. Create a branch universal object. **canonicalIdentifier** the unique identifier for the content. **universalObjectOptions** options for universal object as defined [below](#universalobjectoptions). -Returns an object with methods `generateShortUrl`, `registerView`, `listOnSpotlight`, `showShareSheet`, `userCompletedAction` and `release`. +Returns an object with methods `generateShortUrl`, `registerView`, `listOnSpotlight`, `showShareSheet`, `userCompletedAction` (v1.1.0) and `release` (v1.1.0). ##### The following methods are available on the resulting branchUniversalObject: ###### [- userCompletedAction(event, state = {}): null](#usercompletedaction) +_Introduced in version 1.1.0_ + Report a user action for this Branch Universal Object instance. Create a Branch Universal Object on page load and call `userCompletedAction(RegisterViewEvent)`. **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) The `automaticallyListOnSpotlight` property is ignored on Android. ##### [- release()](#release) +_Introduced in version 1.1.0_ + (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.) ##### [Register User Actions On An Object](#useractions)