This repository has been archived by the owner on Mar 9, 2021. It is now read-only.
/
README.html
186 lines (130 loc) · 10.7 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<meta name="Format" content="complete" />
</head>
<body>
<h1 id="welcome">Welcome!</h1>
<p>Thanks for checking out the Pocket SDK. With a few lines of code, your app can quickly add support for saving URLs to users’ Pocket lists.</p>
<h2 id="installingthepocketsdk">Installing the Pocket SDK</h2>
<p>The Pocket SDK is the fastest way to add Pocket integration to any iOS or Mac application. Adding the Pocket SDK to your app is incredibly easy. Follow the steps below and you can be saving urls to Pocket from your app within 15 minutes.</p>
<h3 id="step1:downloadthepocketsdk">Step 1: Download the Pocket SDK</h3>
<p>You can download the SDK at: <a href="http://getpocket.com/api/v3/pocket-objc-sdk.zip">http://getpocket.com/api/v3/pocket-objc-sdk.zip</a></p>
<p>You can also watch/checkout the SDK from GitHub at: <a href="http://github.com/pocketco/Pocket-ObjC-SDK">http://github.com/pocketco/Pocket-ObjC-SDK</a>. If you use recommend adding the Pocket SDK as a git submodule of your project by running <code>git submodule add git://github.com/Pocket/Pocket-ObjC-SDK.git <path></code> from the root directory of your repository, replacing the <code><path></code> with the path you'd like it installed to.</p>
<p>If you use <a href="http://cocoapods.org/">CocoaPods</a>, you can add the <code>PocketAPI</code> pod to your Podfile. Then run <code>pod install</code>, and the Pocket SDK will be available in your project. See the documentation on the CocoaPods website if you want to set up a new or existing project.</p>
<p>The project download includes the SDK and an example project.</p>
<h3 id="step2:addthepocketsdktoyourproject">Step 2: Add the Pocket SDK to your project</h3>
<ul>
<li>Open your existing project. </li>
<li>Drag the SDK folder from the example project into your Xcode project.</li>
<li>Make sure the “Copy items into destination group’s folder (if needed)” checkbox is checked.</li>
<li>Select your Xcode project in the Project Navigator, select your application target, select “Build Phases”, and add Security.framework to your “Link Binary With Libraries” phase.</li>
</ul>
<p>The SDK includes all necessary source files and does not have any other dependencies.</p>
<p><img id="" src="https://s3.amazonaws.com/pocket-assets/adding-sdk.png" alt="" title="Dragging the SDK to your XCode project" /></p>
<p><img id="" src="https://s3.amazonaws.com/pocket-assets/adding-security-framework.png" alt="" title="Security.framework is in the Link Binary With Libraries Build Phase" /></p>
<h3 id="step3:obtainaplatformconsumerkey">Step 3: Obtain a platform consumer key</h3>
<p>When you register your app with Pocket, it will provide you with a platform consumer key. This key identifies your app to Pocket’s API.</p>
<p>If you have not obtained a consumer key yet, you can register one at <a href="http://getpocket.com/api/signup">http://getpocket.com/api/signup</a></p>
<h3 id="step4:addthepocketurl-scheme">Step 4: Add the Pocket URL scheme</h3>
<p>Once you have the consumer key for the platform you are supporting, the application must register a URL scheme to receive login callbacks. By default, this is “pocketapp” plus your application’s ID (which you can find at the beginning of the consumer key before the hyphen). So if your consumer key is 42-abcdef, your app ID is 42, and your URL scheme will be “pocketapp42”. </p>
<p>If there are already URL schemes in your app’s Info.plist, you can either add the new URL scheme, or use an existing scheme by calling <code>[[PocketAPI sharedAPI] setURLScheme:@"YOUR-URL-SCHEME-HERE"]</code>. To add a URL Scheme, create a block like the one below in your Info.plist, updating it with the app’s scheme:</p>
<pre><code>▾ URL Types (Array)
▾ Item 0 (Dictionary)
URL Identifier (String) com.getpocket.sdk
▾ URL Schemes (Array) (1 item)
Item 0 (String) [YOUR URL SCHEME, like "pocketapp42"]
</code></pre>
<p>Or you can copy and paste the following into the XML Source for the Info.plist:</p>
<pre><code><key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>com.readitlater</string>
<key>CFBundleURLSchemes</key>
<array>
<string>pocketapp9553</string>
</array>
</dict>
</array>
</code></pre>
<h3 id="step5:configureyourappdelegate">Step 5: Configure your App Delegate</h3>
<p>The final steps to set up the Pocket SDK requires adding a few lines of code to your main app delegate. This is the class where you include iOS required methods like applicationDidFinishLaunching.</p>
<h4 id="importthepocketapiheader">Import the PocketAPI Header</h4>
<p>At the top of your app delegate source file (and anywhere you call the PocketAPI object), you’ll need to include the PocketAPI header. At the top of your class you’ll probably see other imports already. Simply add this line:</p>
<pre><code>#import “PocketAPI.h”
</code></pre>
<h4 id="setyourplatformconsumerkey">Set Your Platform Consumer Key</h4>
<p>The Pocket SDK requires your consumer key in order to make any requests to the API. Call this method with your registered consumer key when launching your app:</p>
<pre><code>[[PocketAPI sharedAPI] setConsumerKey:@"Your Consumer Key Here"];
</code></pre>
<h4 id="addamethodforthepocketurl-scheme">Add a method for the Pocket url-scheme</h4>
<p>The final step is to give the SDK an opportunity to handle incoming URLs. If you do not already implement this method on your app delegate, simply add the following method:</p>
<pre><code>-(BOOL)application:(UIApplication *)application
openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication
annotation:(id)annotation{
if([[PocketAPI sharedAPI] handleOpenURL:url]){
return YES;
}else{
// if you handle your own custom url-schemes, do it here
return NO;
}
}
</code></pre>
<h3 id="step6:startsavingtopocket">Step 6: Start Saving to Pocket!</h3>
<p>At this point you’ve properly installed the SDK and can now start making requests and saving urls to Pocket. Here is a two line example:</p>
<pre><code>NSURL *url = [NSURL URLWithString:@”http://google.com”];
[[PocketAPI sharedAPI] saveURL:url handler: ^(PocketAPI *API, NSURL *URL, NSError *error){
if(error){
// there was an issue connecting to Pocket
// present some UI to notify if necessary
}else{
// the URL was saved successfully
}
}];
</code></pre>
<p>The example above uses blocks which requires iOS 4.0 or greater. If you have a need to support iOS 3.0, you can use the [linkto:delegate or operation based methods].</p>
<h2 id="managingaccountshandlinguserlogins">Managing Accounts / Handling User Logins</h2>
<p>Following Pocket’s API best practices, you’ll want to provide a way for the user to manage what account they are logged into. This is most commonly handled by adding a setting in your app’s option screen that lets the user configure their Pocket account. When the user taps this, you can simply call one line of code which will handle the entire authorization process:</p>
<pre><code>[[PocketAPI sharedAPI] loginWithHandler: ^(PocketAPI *API, NSError *error){
if (error != nil)
{
// There was an error when authorizing the user. The most common error is that the user denied access to your application.
// The error object will contain a human readable error message that you should display to the user
// Ex: Show an UIAlertView with the message from error.localizedDescription
}
else
{
// The user logged in successfully, your app can now make requests.
// [API username] will return the logged-in user’s username and API.loggedIn will == YES
}
}];
</code></pre>
<p>It is also recommended to observe changes to the PocketAPI’s username and loggedIn properties to determine when the logged-in user changes. If iOS terminates your application while it is in the background (e.g. due to memory constraints), any pending login attempts are automatically saved and restored at launch if needed. Therefore, your delegate/block responses may not get called. If you need to update UI when the logged in user changes, register for observers on PocketAPI at application launch.</p>
<h3 id="callingotherpocketapis">Calling Other Pocket APIs</h3>
<p>To call other arbitrary APIs, pass the API’s method name, the HTTP method name, and an NSDictionary of arguments. An NSDictionary with the response from the API will be passed to the handler.</p>
<pre><code>NSString *apiMethod = ...;
PocketAPIHTTPmethod httpMethod = ...; // usually PocketAPIHTTPMethodPOST
NSDictionary *arguments = ...;
[[PocketAPI sharedAPI] callAPIMethod:apiMethod
withHTTPMethod:httpMethod
arguments:arguments
handler: ^(PocketAPI *api, NSString *apiMethod, NSDictionary *response, NSError *error){
// handle the response here
}];
</code></pre>
<h1 id="acknowledgements">Acknowledgements</h1>
<p>The Pocket SDK uses the following open source software:</p>
<ul>
<li><a href="https://github.com/ldandersen/scifihifi-iphone/tree/master/security">SFHFKeychainUtils</a> for saving user credentials securely to the keychain.</li>
<li><a href="https://github.com/erica/uidevice-extension">UIDevice-Hardware</a> for creating a user agent</li>
</ul>
<h1 id="license">License</h1>
<p>Copyright (c) 2012 Read It Later, Inc.</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</body>
</html>