Blame - docs/apiclient.oauth.html - platform/external/python/google-api-python-client

2010-12-09 16:34:22 -0500

[diff] [blame]

12

<tt>Utilities for OAuth.

13

14

Utilities for making it easier to work with OAuth.</tt>

<big>Modules</big></td></tr>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

23

<a href="httplib2.html">httplib2</a>

24

</td><td width="25%" valign=top><a href="logging.html">logging</a>

25

<a href="oauth2.html">oauth2</a>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

26

</td><td width="25%" valign=top><a href="json.html">json</a>

Joe Gregorio

3b79fa8

2011-02-17 11:47:17 -0500

[diff] [blame]

27

<a href="urllib.html">urllib</a>

28

</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a>

Joe Gregorio

6e53703

2011-02-09 23:04:26 -0500

[diff] [blame]

29

</td></tr></table></td></tr></table>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

<big>Classes</big></td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

37

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

38

</dt><dd>

39

<dl>

40

<dt><a href="apiclient.oauth.html#Error">Error</a>

41

</dt><dd>

42

<dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

43

<dt><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a>

44

</dt><dt><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

45

</dt><dt><a href="apiclient.oauth.html#RequestError">RequestError</a>

</dt></dl>

</dd>

</dl>

</dd>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

50

<dt><a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

51

</dt><dd>

52

<dl>

53

<dt><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a>

54

</dt><dt><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a>

55

</dt></dl>

56

</dd>

57

<dt><a href="oauth2client.client.html#Flow">oauth2client.client.Flow</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

58

</dt><dd>

59

<dl>

60

<dt><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a>

61

</dt></dl>

62

</dd>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

</dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

68

<a name="CredentialsInvalidError">class CredentialsInvalidError</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

69

70

71

<td width="100%"><dl><dt>Method resolution order:</dt>

72

<dd><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a></dd>

73

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

74

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

75

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

76

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

77

</dl>

78

<hr>

79

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

80

<dl><dt>__weakref__</dt>

81

<dd><tt>list of weak references to the object (if defined)</tt></dd>

82

</dl>

83

<hr>

84

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

85

<dl><dt><a name="CredentialsInvalidError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

86

87

<hr>

88

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

89

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#CredentialsInvalidError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

90

91

<hr>

92

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

93

<dl><dt><a name="CredentialsInvalidError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

94

95

<dl><dt><a name="CredentialsInvalidError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

96

97

<dl><dt><a name="CredentialsInvalidError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

98

99

<dl><dt><a name="CredentialsInvalidError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

100

101

Use of negative indices is not supported.</tt></dd></dl>

102

103

<dl><dt><a name="CredentialsInvalidError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="CredentialsInvalidError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

108

109

<dl><dt><a name="CredentialsInvalidError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="CredentialsInvalidError-__unicode__">__unicode__</a>(...)</dt></dl>

114

115

<hr>

116

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

127

<a name="Error">class Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

128

129

130

<td colspan=2><tt>Base error for this module.  </tt></td></tr>

131

132

<td width="100%"><dl><dt>Method resolution order:</dt>

133

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

134

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

135

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

136

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

137

</dl>

138

<hr>

139

Data descriptors defined here:

140

<dl><dt>__weakref__</dt>

141

<dd><tt>list of weak references to the object (if defined)</tt></dd>

142

</dl>

143

<hr>

144

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

145

<dl><dt><a name="Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

146

147

<hr>

148

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

149

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

150

151

<hr>

152

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

153

<dl><dt><a name="Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

154

155

<dl><dt><a name="Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

156

157

<dl><dt><a name="Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

158

159

<dl><dt><a name="Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

160

161

Use of negative indices is not supported.</tt></dd></dl>

162

163

<dl><dt><a name="Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

168

169

<dl><dt><a name="Error-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="Error-__unicode__">__unicode__</a>(...)</dt></dl>

174

175

<hr>

176

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

187

<a name="FlowThreeLegged">class FlowThreeLegged</a>(<a href="oauth2client.client.html#Flow">oauth2client.client.Flow</a>)</td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

188

189

190

<td colspan=2><tt>Does the Three Legged Dance for OAuth 1.0a.  </tt></td></tr>

191

Joe Gregorio

6e53703

2011-02-09 23:04:26 -0500

[diff] [blame]

192

<td width="100%"><dl><dt>Method resolution order:</dt>

193

<dd><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a></dd>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

194

<dd><a href="oauth2client.client.html#Flow">oauth2client.client.Flow</a></dd>

Joe Gregorio

6e53703

2011-02-09 23:04:26 -0500

[diff] [blame]

195

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

196

</dl>

197

<hr>

198

Methods defined here:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

199

<dl><dt><a name="FlowThreeLegged-__init__">__init__</a>(self, discovery, consumer_key, consumer_secret, user_agent, **kwargs)</dt><dd><tt>discovery       - Section of the API discovery document that describes

200

the OAuth endpoints.

201

consumer_key    - OAuth consumer key

202

consumer_secret - OAuth consumer secret

203

user_agent      - The HTTP User-Agent that identifies the application.

204

**kwargs        - The keyword arguments are all optional and required

205

parameters for the OAuth calls.</tt></dd></dl>

206

207

<dl><dt><a name="FlowThreeLegged-step1_get_authorize_url">step1_get_authorize_url</a>(self, oauth_callback='oob')</dt><dd><tt>Returns a URI to redirect to the provider.

208

209

oauth_callback - Either the string 'oob' for a non-web-based application,

210

or a URI that handles the callback from the authorization

211

server.

212

213

If oauth_callback is 'oob' then pass in the

214

generated verification code to step2_exchange,

215

otherwise pass in the query parameters received

216

at the callback uri to step2_exchange.</tt></dd></dl>

217

218

<dl><dt><a name="FlowThreeLegged-step2_exchange">step2_exchange</a>(self, verifier)</dt><dd><tt>Exhanges an authorized request token

219

for <a href="#OAuthCredentials">OAuthCredentials</a>.

220

Joe Gregorio

4258d6b

2011-03-18 10:20:16 -0400

[diff] [blame]

221

Args:

222

verifier: string, dict - either the verifier token, or a dictionary

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

223

of the query parameters to the callback, which contains

Joe Gregorio

4258d6b

2011-03-18 10:20:16 -0400

[diff] [blame]

224

the oauth_verifier.

225

Returns:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

226

The <a href="oauth2client.client.html#Credentials">Credentials</a> object.</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

227

228

<hr>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

229

Data descriptors inherited from <a href="oauth2client.client.html#Flow">oauth2client.client.Flow</a>:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

230

231

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

232

</dl>

233

<dl><dt>__weakref__</dt>

234

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

<a name="MissingParameter">class MissingParameter</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

241

242

243

<td width="100%"><dl><dt>Method resolution order:</dt>

244

<dd><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a></dd>

245

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

246

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

247

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

248

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

249

</dl>

250

<hr>

251

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

252

<dl><dt>__weakref__</dt>

253

<dd><tt>list of weak references to the object (if defined)</tt></dd>

254

</dl>

255

<hr>

256

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

257

<dl><dt><a name="MissingParameter-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

258

259

<hr>

260

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

261

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#MissingParameter-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

262

263

<hr>

264

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

265

<dl><dt><a name="MissingParameter-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

266

267

<dl><dt><a name="MissingParameter-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

268

269

<dl><dt><a name="MissingParameter-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

270

271

<dl><dt><a name="MissingParameter-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

272

273

Use of negative indices is not supported.</tt></dd></dl>

274

275

<dl><dt><a name="MissingParameter-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="MissingParameter-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

280

281

<dl><dt><a name="MissingParameter-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="MissingParameter-__unicode__">__unicode__</a>(...)</dt></dl>

286

287

<hr>

288

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

299

<a name="OAuthCredentials">class OAuthCredentials</a>(<a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>)</td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

300

301

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

302

<td colspan=2><tt><a href="oauth2client.client.html#Credentials">Credentials</a> object for OAuth 1.0a  </tt></td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

303

304

<td width="100%"><dl><dt>Method resolution order:</dt>

305

<dd><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a></dd>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

306

<dd><a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a></dd>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

307

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

308

</dl>

309

<hr>

310

Methods defined here:

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

311

<dl><dt><a name="OAuthCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

312

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

313

<dl><dt><a name="OAuthCredentials-__init__">__init__</a>(self, consumer, token, user_agent)</dt><dd><tt>consumer   - An instance of oauth.Consumer.

314

token      - An instance of oauth.Token constructed with

315

the access token and secret.

316

user_agent - The HTTP User-Agent to provide for this application.</tt></dd></dl>

317

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

318

<dl><dt><a name="OAuthCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the object from being pickled.</tt></dd></dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

319

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

320

<dl><dt><a name="OAuthCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these <a href="oauth2client.client.html#Credentials">Credentials</a>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

321

322

Args:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

323

http - An instance of httplib2.Http

324

or something that acts like it.

325

326

Returns:

327

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#OAuthCredentials-authorize">authorize</a>(h)

333

334

You can't create a new OAuth

335

subclass of httplib2.Authenication because

336

it never gets passed the absolute URI, which is

337

needed for signing. So instead we have to overload

338

'request' with a closure that adds in the

339

Authorization header and then calls the original version

340

of 'request()'.</tt></dd></dl>

341

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

342

<dl><dt><a name="OAuthCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the storage for the credential.

343

344

Args:

345

store: callable, a callable that when passed a Credential

346

will store the credential back to where it came from.

347

This is needed to store the latest access_token if it

348

has been revoked.</tt></dd></dl>

349

350

<hr>

351

Data descriptors defined here:

352

<dl><dt>invalid</dt>

353

<dd><tt>True if the credentials are invalid, such as being revoked.</tt></dd>

354

</dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

355

<hr>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

356

Methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

357

<dl><dt><a name="OAuthCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

358

359

Args:

360

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

361

362

<dl><dt><a name="OAuthCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

363

364

Args:

365

http: httplib2.Http, an http object to be used to make the refresh

366

request.</tt></dd></dl>

367

368

<dl><dt><a name="OAuthCredentials-to_json">to_json</a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="oauth2client.client.html#Credentials">Credentials</a>.

369

370

Returns:

371

string, a JSON representation of this instance, suitable to pass to

Joe Gregorio

2012-04-13 07:50:04 -0400

[diff] [blame^]

372

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

373

374

<hr>

375

Class methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

Joe Gregorio

2012-04-13 07:50:04 -0400

[diff] [blame^]

376

<dl><dt><a name="OAuthCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> object from a JSON description of it. The JSON

377

should have been produced by calling .<a href="#OAuthCredentials-to_json">to_json</a>() on the object.

378

379

Args:

380

data: dict, A deserialized JSON object.

381

382

Returns:

383

An instance of a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass.</tt></dd></dl>

384

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

385

<dl><dt><a name="OAuthCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass from a JSON

386

representation produced by <a href="#OAuthCredentials-to_json">to_json</a>().

387

388

Args:

389

s: string, JSON from <a href="#OAuthCredentials-to_json">to_json</a>().

390

391

Returns:

392

An instance of the subclass of <a href="oauth2client.client.html#Credentials">Credentials</a> that was serialized with

<hr>

Data descriptors inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

397

398

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

399

</dl>

400

<dl><dt>__weakref__</dt>

401

<dd><tt>list of weak references to the object (if defined)</tt></dd>

402

</dl>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

403

<hr>

404

Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

405

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

406

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

</td></tr></table>

<a name="RequestError">class RequestError</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

412

413

414

<td colspan=2><tt><a href="#Error">Error</a> occurred during request.  </tt></td></tr>

415

416

<td width="100%"><dl><dt>Method resolution order:</dt>

417

<dd><a href="apiclient.oauth.html#RequestError">RequestError</a></dd>

418

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

419

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

420

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

421

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

422

</dl>

423

<hr>

424

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

425

<dl><dt>__weakref__</dt>

426

<dd><tt>list of weak references to the object (if defined)</tt></dd>

427

</dl>

428

<hr>

429

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

430

<dl><dt><a name="RequestError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

431

432

<hr>

433

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

434

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#RequestError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

435

436

<hr>

437

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

438

<dl><dt><a name="RequestError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

439

440

<dl><dt><a name="RequestError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

441

442

<dl><dt><a name="RequestError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

443

444

<dl><dt><a name="RequestError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

445

446

Use of negative indices is not supported.</tt></dd></dl>

447

448

<dl><dt><a name="RequestError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="RequestError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

453

454

<dl><dt><a name="RequestError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="RequestError-__unicode__">__unicode__</a>(...)</dt></dl>

459

460

<hr>

461

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

</td></tr></table>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

472

<a name="TwoLeggedOAuthCredentials">class TwoLeggedOAuthCredentials</a>(<a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>)</td></tr>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

473

474

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

475

<td colspan=2><tt>Two Legged <a href="oauth2client.client.html#Credentials">Credentials</a> object for OAuth 1.0a.

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

476

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

477

The Two Legged object is created directly, not from a flow.  Once you

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

478

authorize and httplib2.Http instance you can change the requestor and that

479

change will propogate to the authorized httplib2.Http instance. For example:

480

481

http = httplib2.Http()

482

http = credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(http)

483

484

credentials.requestor = 'foo@example.info'

485

http.request(...)

486

credentials.requestor = 'bar@example.info'

487

http.request(...)  </tt></td></tr>

488

489

<td width="100%"><dl><dt>Method resolution order:</dt>

490

<dd><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a></dd>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

491

<dd><a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a></dd>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

492

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

493

</dl>

494

<hr>

495

Methods defined here:

496

<dl><dt><a name="TwoLeggedOAuthCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

497

498

<dl><dt><a name="TwoLeggedOAuthCredentials-__init__">__init__</a>(self, consumer_key, consumer_secret, user_agent)</dt><dd><tt>Args:

499

consumer_key: string, An OAuth 1.0 consumer key

500

consumer_secret: string, An OAuth 1.0 consumer secret

501

user_agent: string, The HTTP User-Agent to provide for this application.</tt></dd></dl>

502

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

503

<dl><dt><a name="TwoLeggedOAuthCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the object from being pickled.</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

504

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

505

<dl><dt><a name="TwoLeggedOAuthCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these <a href="oauth2client.client.html#Credentials">Credentials</a>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

506

507

Args:

508

http - An instance of httplib2.Http

509

or something that acts like it.

510

511

Returns:

512

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(h)

518

519

You can't create a new OAuth

520

subclass of httplib2.Authenication because

521

it never gets passed the absolute URI, which is

522

needed for signing. So instead we have to overload

523

'request' with a closure that adds in the

524

Authorization header and then calls the original version

525

of 'request()'.</tt></dd></dl>

526

527

<dl><dt><a name="TwoLeggedOAuthCredentials-getrequestor">getrequestor</a>(self)</dt></dl>

528

529

<dl><dt><a name="TwoLeggedOAuthCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the storage for the credential.

530

531

Args:

532

store: callable, a callable that when passed a Credential

533

will store the credential back to where it came from.

534

This is needed to store the latest access_token if it

535

has been revoked.</tt></dd></dl>

536

537

<dl><dt><a name="TwoLeggedOAuthCredentials-setrequestor">setrequestor</a>(self, email)</dt></dl>

538

539

<hr>

540

Data descriptors defined here:

541

<dl><dt>invalid</dt>

542

<dd><tt>True if the credentials are invalid, such as being revoked.

543

544

Always returns False for Two Legged Credentials.</tt></dd>

545

</dl>

546

<dl><dt>requestor</dt>

547

<dd><tt>The email address of the user to act on behalf of</tt></dd>

548

</dl>

549

<hr>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

550

Methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

551

<dl><dt><a name="TwoLeggedOAuthCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

552

553

Args:

554

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

555

556

<dl><dt><a name="TwoLeggedOAuthCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

557

558

Args:

559

http: httplib2.Http, an http object to be used to make the refresh

560

request.</tt></dd></dl>

561

562

<dl><dt><a name="TwoLeggedOAuthCredentials-to_json">to_json</a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="oauth2client.client.html#Credentials">Credentials</a>.

563

564

Returns:

565

string, a JSON representation of this instance, suitable to pass to

Joe Gregorio

2012-04-13 07:50:04 -0400

[diff] [blame^]

566

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

567

568

<hr>

569

Class methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:

Joe Gregorio

2012-04-13 07:50:04 -0400

[diff] [blame^]

570

<dl><dt><a name="TwoLeggedOAuthCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> object from a JSON description of it. The JSON

571

should have been produced by calling .<a href="#TwoLeggedOAuthCredentials-to_json">to_json</a>() on the object.

572

573

Args:

574

data: dict, A deserialized JSON object.

575

576

Returns:

577

An instance of a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass.</tt></dd></dl>

578

Joe Gregorio