Skip to content

Commit 43aa383

Browse files
author
Emil Åhsberg
authored
Update README.md
1 parent a42d897 commit 43aa383

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ APIWrapper wrapper = new APIWrapper(context, "YOUR_API_KEY");
4242

4343
## Usage
4444
All API endpoints are available as methods in the APIWrapper object. Each method has the following signature:
45-
### wrapper.endpoint(Map<Operator, String>)
45+
### wrapper.endpoint(Parameters, onSuccessCallback)
4646
__Arguments__
47-
* Operator - An object specifying an operation, ex. expander, filter, ordering etc. These Operations can be found in the API documentation under References: (https://igdb.github.io/api/references/)
48-
* String - The String is the accompaying data for the Operator, ex. game ids "1,2,3,4,5" OR fields "id,name,rating"
47+
* Parameters - An object specifying the operations to be performed, ex. expander, filter, ordering etc. These Operations can be found in the API documentation under References: (https://igdb.github.io/api/references/)
48+
* onSuccessCallback - The callback is used to return to the previous method once the wrapper has retrieved the desired data from the API.
4949

5050
__Example__
5151
* Requesting games from API

0 commit comments

Comments
 (0)