Skip to content

Commit

Permalink
updated readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
rfreitas committed Nov 28, 2016
1 parent 11f4d28 commit 862a517
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Breaking changes result in a different major. UI changes that might break custom
### Changed
- Public: document and face callback are now passed only their respective capture, instead of both their captures.
- Public: document and face callback are now only called after the user has confirmed the capture
- Public: document, face and complete callback can be called multiple times, if the conditions that trigger them are met more than once (eg. if the user goes back to redo the capture steps)
- Public: document, face and complete callback can be called multiple times, if the condition that triggers them is met more than once (eg. if the user goes back to redo the capture steps)
- Internal: callbacks' returned value now have no impact on the event dispatcher.

### Fixed
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ Onfido.init({
onReady: function() {
// callback that fires when successfully authorised
},
onDocumentCapture: function(event) {
onDocumentCapture: function(capture) {
// callback for when the document has captured successfully
},
onFaceCapture: function(event) {
onFaceCapture: function(capture) {
// callback for when the face capture was successful
},
onComplete: function(event) {
onComplete: function(capturesHash) {
// callback for when everything is complete
},
steps: [
Expand Down Expand Up @@ -183,15 +183,15 @@ A breakdown of the options and methods available to the SDK.

- **`onDocumentCapture {Function} optional`**

Callback that fires when the document has successfully captured. It returns an event object that contains your document capture.
Callback that fires when the document has been successfully captured and confirmed by the user. It returns an object that contains the document capture.

- **`onFaceCapture {Function} optional`**

Callback that fires when the face has successfully captured. It returns an event object that contains your face capture.
Callback that fires when the face has been successfully captured and confirmed by the user. It returns an object that contains the face capture.

- **`onComplete {Function} optional`**

Callback that fires when both the document and face have successfully captured. It returns an object that contains the captures. This event data should sent to your backend where the full API request will be made.
Callback that fires when both the document and face have successfully been captured. It returns an object that contains both captures. This event data should sent to your backend where the full API requests will be made.

- **`steps {List} optional`**

Expand Down

0 comments on commit 862a517

Please sign in to comment.