organicmaps/api-ios
13
Fork 0
Code Issues Pull requests 1 Projects Releases Wiki Activity Actions

Updated documentation

Browse source
This commit is contained in:
Alex Zolotarev 2013-08-14 22:06:42 +03:00
parent 5440821606
commit ddbf16d845
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -35,6 +35,8 @@ If you want to get results of API calls, please add unique URL scheme to your ap
*capitals-example* folder contains [sample application][linkSample] which demonstrates part of API features.
*NOTE: If you are using Automatic References Counting (ARC) in your project, you can use [this solution][linkFixARC] or simply fix code by yourself.*
### API Calls Overview and HOW TO
* All methods are static for *MWMApi* class, *BOOL* methods return *NO* if call is failed.
@ -115,6 +117,8 @@ Example:
}
}
Note, that you can simply check that *sourceApplication* contains *com.mapswithme.* substring to detect that your app is opened from MapsWithMe.
#### Check that MapsWithMe is installed
Returns NO if MapsWithMe is not installed or outdated version doesn't support API calls:
@ -175,3 +179,4 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
[linkSupport]: mailto:api@mapswith.me "MapsWithMe Support Contact"
[linkAppleCustomUrlSchemes]: http://developer.apple.com/library/ios/#DOCUMENTATION/iPhone/Conceptual/iPhoneOSProgrammingGuide/AdvancedAppTricks/AdvancedAppTricks.html#//apple_ref/doc/uid/TP40007072-CH7-SW50 "Custom URL Scheme Apple documentation"
[linkAppleDelegate]: http://developer.apple.com/library/ios/documentation/uikit/reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/occ/intfm/UIApplicationDelegate/application:openURL:sourceApplication:annotation: "AppDelegate Handle custom URL Schemes"
[linkFixARC]: http://stackoverflow.com/a/6658549/1209392 "How to compile non-ARC code in ARC projects"