-
Notifications
You must be signed in to change notification settings - Fork 0
/
FireEagleAuth.html
executable file
·864 lines (855 loc) · 50.8 KB
/
FireEagleAuth.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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="FireEagleAuth,net.yahoo.fireeagle.FireEagleAuth,OAUTH_TOKEN_PARAM,OAUTH_TOKEN_SECRET_PARAM,_accessKey,_accessSecret,_requestKey,_requestSecret,accessKey,accessSecret,authorizationUrl,requestKey,requestSecret,accessTokenSuccess,convertToAccessToken,getMobileAuthorizationUrl,newRequestToken,requestTokenSuccess" name="keywords">
<title>net.yahoo.fireeagle.FireEagleAuth</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
asdocTitle = 'FireEagleAuth - Fire Eagle API AS3 library';
var baseRef = '../../../';
window.onload = configPage;
--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Fire Eagle API AS3 library</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a> | <a href="../../../index.html?net/yahoo/fireeagle/FireEagleAuth.html&net/yahoo/fireeagle/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class FireEagleAuth</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a> | <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2"> </td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class FireEagleAuth"); titleBar_setSubNav(true,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">net.yahoo.fireeagle</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class FireEagleAuth</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">FireEagleAuth <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="FireEagleMethod.html">FireEagleMethod</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
A utility class for working with Fire Eagle API authorization:
<ul>
<li>getting a new request token (<code>newRequestToken</code>)
<li>getting auth url (either <code>getMobileAuthorizationUrl</code>, <code>authorizationUrl</code>)
<li>or converting that request token to an access token (<code>convertToAccessToken</code>)
</ul>
<p></p>
<br>
<span class="label">Example</span>
<br>
<div class='listing'><pre>
var fea:FireEagleAuth = new FireEagleAuth(consumerKey, consumerSecret);
// Note, no error handling shown
fea.addEventListener(FireEagleEvent.REQUEST_TOKEN_SUCCESS, handleNewRequestTokenSuccess);
fea.newRequestToken();
function handleNewRequestTokenSuccess(e:FireEagleEvent):void
{
trace("Received new request token");
// prompt user for app authorization using fea.authorizationUrl
}
function onUserDoneAuthorizingApp():void
{
fea.addEventListener(FireEagleEvent.ACCESS_TOKEN_SUCCESS, handleConvertAccessTokenSuccess);
fea.convertToAccessToken();
}
function handleConvertAccessTokenSuccess(e:FireEagleEvent):void
{
// use new fea.accessKey and fea.accessSecret to update user's location
var fe:FireEagleMethod = new FireEagleMethod(consumerKey, consumerSecret, fea.accessKey, fea.accessSecret);
fa.update({postal:"94107"});
}
</pre></div>
<p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#accessKey">accessKey</a> : String<div class="summaryTableDescription">[read-only]
Gets the access key from the result of a call to <code>convertToAccessToken</code>.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#accessSecret">accessSecret</a> : String<div class="summaryTableDescription">[read-only]
Gets the access secret from the result of a call to <code>convertToAccessToken</code>.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#args">args</a> : String<div class="summaryTableDescription">
The set of http POST args for the method call.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#authorizationUrl">authorizationUrl</a> : String<div class="summaryTableDescription">[read-only]
Gets a authorization url for the current request key.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#connection">connection</a> : <a href="oauth/OAuthConnection.html">OAuthConnection</a>
<div class="summaryTableDescription">
The OAuthConnection being used.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#fireRequestAutomatically">fireRequestAutomatically</a> : Boolean<div class="summaryTableDescription">
Whether or not to automatically fire API method requests when calling <code>FireEagleMethod</code> class methods.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#format">format</a> : String<div class="summaryTableDescription">
The REST request result data format name.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#formatClass">formatClass</a> : Class<div class="summaryTableDescription">
The REST request result data format class.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#parseResult">parseResult</a> : Boolean<div class="summaryTableDescription">
Whether or not method result String is parsed (to an XML object or deserialized JSON AS Object depending on <code>format</code>).</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#requestKey">requestKey</a> : String<div class="summaryTableDescription">[read-only]
Gets the request key from the result of a call to <code>newRequestToken</code>.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#requestSecret">requestSecret</a> : String<div class="summaryTableDescription">[read-only]
Gets the request secret from the result of a call to <code>newRequestToken</code>.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#signatureMethod">signatureMethod</a> : IOAuthSignatureMethod<div class="summaryTableDescription">
Set OAuth signature method implementation.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#url">url</a> : String<div class="summaryTableDescription">
The url for the method call, including all url args and OAuth args.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
</table>
</div>
<a name="protectedPropertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty">
<a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a>
</div>
<div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty">
<a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a>
</div>
</div>
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_accessKey">_accessKey</a> : String<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_accessSecret">_accessSecret</a> : String<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedProtectedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#_connection">_connection</a> : <a href="oauth/OAuthConnection.html">OAuthConnection</a>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#_fireRequestAutomatically">_fireRequestAutomatically</a> : Boolean = true<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#_formatClass">_formatClass</a> : Class<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedProperty">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="FireEagleMethod.html#_parseResult">_parseResult</a> : Boolean = true<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_requestKey">_requestKey</a> : String<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_requestSecret">_requestSecret</a> : String<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#FireEagleAuth()">FireEagleAuth</a>(consumerKey:String, consumerSecret:String)</div>
<div class="summaryTableDescription">
Class constructor.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#asyncRequest()">asyncRequest</a>():void</div>
<div class="summaryTableDescription">
Fire a previously setup Fire Eagle API method.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#clone()">clone</a>():<a href="../fireeagle/FireEagleMethod.html">FireEagleMethod</a>
</div>
<div class="summaryTableDescription">
Create a new <code>FireEagleMethod</code> object with the same properties as this one..</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#convertToAccessToken()">convertToAccessToken</a>():void</div>
<div class="summaryTableDescription">
Converts the currect request key + secret to an access key + secret.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getMobileAuthorizationUrl()">getMobileAuthorizationUrl</a>(appId:String):String</div>
<div class="summaryTableDescription">
Gets a mobile authorization url for the <code>appId</code> app
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#lookup()">lookup</a>(args:Object):void</div>
<div class="summaryTableDescription">
Setup and potentially fire a Fire Eagle <code>lookup</code> API method call to disambiguate potential
values for update query.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#newRequestToken()">newRequestToken</a>():void</div>
<div class="summaryTableDescription">
Gets a new request token from the auth server.</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#recent()">recent</a>(args:Object):void</div>
<div class="summaryTableDescription">
Setup and potentially fire a Fire Eagle <code>recent</code> API method call to retreive recent user updates
for the app.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#update()">update</a>(args:Object):void</div>
<div class="summaryTableDescription">
Setup and potentially fire a Fire Eagle <code>update</code> API method call to update the current
location of the user.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#user()">user</a>():void</div>
<div class="summaryTableDescription">
Setup and potentially fire a Fire Eagle <code>user</code> API method call to retreive the current
location of the user.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#within()">within</a>(args:Object):void</div>
<div class="summaryTableDescription">
Setup and potentially fire a Fire Eagle <code>within</code> API method call to retreive the app users within
given location bounds.</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
</table>
</div>
<a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<div class="showHideLinks">
<div class="hideInheritedProtectedMethod" id="hideInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(false,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Methods</a>
</div>
<div class="showInheritedProtectedMethod" id="showInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(true,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Methods</a>
</div>
</div>
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#accessTokenSuccess()">accessTokenSuccess</a>(e:<a href="FireEagleEvent.html">FireEagleEvent</a>):void</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#getRequest()">getRequest</a>(url:String, methodName:String, args:Object = null, success:Function = null, failure:Function = null, security:Function = null):void</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#getResponseStatusOk()">getResponseStatusOk</a>(status:int):Boolean</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#makeCallbackObject()">makeCallbackObject</a>(methodName:String, success:Function = null, failure:Function = null, security:Function = null):Object</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#postRequest()">postRequest</a>(url:String, methodName:String, args:Object = null, success:Function = null, failure:Function = null, security:Function = null):void</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#requestTokenSuccess()">requestTokenSuccess</a>(e:<a href="FireEagleEvent.html">FireEagleEvent</a>):void</div>
<div class="summaryTableDescription">
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<div class="showHideLinks">
<div class="hideInheritedEvent" id="hideInheritedEvent">
<a onclick="javascript:setInheritedVisible(false,'Event');" href="#eventSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Events</a>
</div>
<div class="showInheritedEvent" id="showInheritedEvent">
<a onclick="javascript:setInheritedVisible(true,'Event');" href="#eventSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Events</a>
</div>
</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:accessTokenFailure">accessTokenFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>convertToAccessToken</code> request fails.</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:accessTokenSuccess">accessTokenSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>convertToAccessToken</code> request succeeds.</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:lookupFailure">lookupFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>lookup</code> request fails.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:lookupSuccess">lookupSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>lookup</code> request succeeds.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:recentFailure">recentFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>recent</code> request fails.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:recentSuccess">recentSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>recent</code> request succeeds.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:requestTokenFailure">requestTokenFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>newRequestToken</code> request fails.</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:requestTokenSuccess">requestTokenSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>newRequestToken</code> request succeeds.</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:securityError">securityError</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a request fails due to a security error.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:updateFailure">updateFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>update</code> request fails.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:updateSuccess">updateSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>update</code> request succeeds.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:userFailure">userFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>user</code> request fails.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:userSuccess">userSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>user</code> request succeeds.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:withinFailure">withinFailure</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>within</code> request fails.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
<tr class="hideInheritedEvent">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="FireEagleMethod.html#event:withinSuccess">withinSuccess</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Dispatched when a <code>within</code> request succeeds.</td><td class="summaryTableOwnerCol"><a href="FireEagleMethod.html">FireEagleMethod</a></td>
</tr>
</table>
</div>
<a name="constantSummary"></a><a name="protectedConstantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Constants</div>
<table id="summaryTableProtectedConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#OAUTH_TOKEN_PARAM">OAUTH_TOKEN_PARAM</a> : String = "oauth_token"<div class="summaryTableDescription">[static]
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#OAUTH_TOKEN_SECRET_PARAM">OAUTH_TOKEN_SECRET_PARAM</a> : String = "oauth_token_secret"<div class="summaryTableDescription">[static]
</div>
</td><td class="summaryTableOwnerCol">FireEagleAuth</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="_accessKey"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">_accessKey</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>protected var _accessKey:String</code><p>
</p></div>
<a name="accessKey"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">accessKey</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>accessKey:String</code> [read-only]<p>
Gets the access key from the result of a call to <code>convertToAccessToken</code>.
</p><span class="label">Implementation</span>
<br>
<code> public function get accessKey():String</code>
<br>
</div>
<a name="_accessSecret"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">_accessSecret</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>protected var _accessSecret:String</code><p>
</p></div>
<a name="accessSecret"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">accessSecret</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>accessSecret:String</code> [read-only]<p>
Gets the access secret from the result of a call to <code>convertToAccessToken</code>.
</p><span class="label">Implementation</span>
<br>
<code> public function get accessSecret():String</code>
<br>
</div>
<a name="authorizationUrl"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">authorizationUrl</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>authorizationUrl:String</code> [read-only]<p>
Gets a authorization url for the current request key. <code>newRequestToken</code> must be called
and had a successful result event prior to calling.
</p><span class="label">Implementation</span>
<br>
<code> public function get authorizationUrl():String</code>
<br>
</div>
<a name="_requestKey"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">_requestKey</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>protected var _requestKey:String</code><p>
</p></div>
<a name="requestKey"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestKey</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>requestKey:String</code> [read-only]<p>
Gets the request key from the result of a call to <code>newRequestToken</code>.
</p><span class="label">Implementation</span>
<br>
<code> public function get requestKey():String</code>
<br>
</div>
<a name="_requestSecret"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">_requestSecret</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>protected var _requestSecret:String</code><p>
</p></div>
<a name="requestSecret"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestSecret</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>requestSecret:String</code> [read-only]<p>
Gets the request secret from the result of a call to <code>newRequestToken</code>.
</p><span class="label">Implementation</span>
<br>
<code> public function get requestSecret():String</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="FireEagleAuth()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FireEagleAuth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function FireEagleAuth(consumerKey:String, consumerSecret:String)</code><p>
Class constructor.
Creates a new FireEagleAuth object for the provided credentials.
</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">consumerKey</span>:String</code> — The OAuth consumer key string to use for this connection.
</td>
</tr>
<tr>
<td class="paramSpacer"> </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">consumerSecret</span>:String</code> — The OAuth consumer secret string to use for this connection.
</td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="accessTokenSuccess()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">accessTokenSuccess</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>protected function accessTokenSuccess(e:<a href="FireEagleEvent.html">FireEagleEvent</a>):void</code><p>
</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">e</span>:<a href="FireEagleEvent.html">FireEagleEvent</a></code></td>
</tr>
</table>
</div>
<a name="convertToAccessToken()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">convertToAccessToken</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>public function convertToAccessToken():void</code><p>
Converts the currect request key + secret to an access key + secret. The user must have authorized the
application using one of the authorization urls. Success or failure returns asynchronously
via <code>FireEagleEvent</code>.
</p></div>
<a name="getMobileAuthorizationUrl()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getMobileAuthorizationUrl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>public function getMobileAuthorizationUrl(appId:String):String</code><p>
Gets a mobile authorization url for the <code>appId</code> app
</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">appId</span>:String</code> — The application id of the application you wish the user to authorize
</td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> — The url for the user to hit to authorize the app usage
</td>
</tr>
</table>
</div>
<a name="newRequestToken()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">newRequestToken</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>public function newRequestToken():void</code><p>
Gets a new request token from the auth server. Success or failure returns asynchronously
via <code>FireEagleEvent</code>.
</p></div>
<a name="requestTokenSuccess()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestTokenSuccess</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>protected function requestTokenSuccess(e:<a href="FireEagleEvent.html">FireEagleEvent</a>):void</code><p>
</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">e</span>:<a href="FireEagleEvent.html">FireEagleEvent</a></code></td>
</tr>
</table>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:accessTokenFailure"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">accessTokenFailure</td><td class="detailHeaderType">event </td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="FireEagleEvent.html"><code>FireEagleEvent</code></a>
<br>
<p></p><p>
Dispatched when a <code>convertToAccessToken</code> request fails.
</p></div>
<a name="event:accessTokenSuccess"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">accessTokenSuccess</td><td class="detailHeaderType">event </td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="FireEagleEvent.html"><code>FireEagleEvent</code></a>
<br>
<p></p><p>
Dispatched when a <code>convertToAccessToken</code> request succeeds.
</p></div>
<a name="event:requestTokenFailure"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestTokenFailure</td><td class="detailHeaderType">event </td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="FireEagleEvent.html"><code>FireEagleEvent</code></a>
<br>
<p></p><p>
Dispatched when a <code>newRequestToken</code> request fails.
</p></div>
<a name="event:requestTokenSuccess"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestTokenSuccess</td><td class="detailHeaderType">event </td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="FireEagleEvent.html"><code>FireEagleEvent</code></a>
<br>
<p></p><p>
Dispatched when a <code>newRequestToken</code> request succeeds.
</p></div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="OAUTH_TOKEN_PARAM"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OAUTH_TOKEN_PARAM</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>protected static const OAUTH_TOKEN_PARAM:String = "oauth_token"</code><p>
</p></div>
<a name="OAUTH_TOKEN_SECRET_PARAM"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OAUTH_TOKEN_SECRET_PARAM</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule"> </td>
</tr>
</table>
<div class="detailBody">
<code>protected static const OAUTH_TOKEN_SECRET_PARAM:String = "oauth_token_secret"</code><p>
</p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">
</center>
</div>
</body>
</html>
<!-- -->