-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
286 changed files
with
6,181 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
|
|
||
| # event.didComplete | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [Boolean][api.type.Boolean] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, didComplete | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.showDialog()][plugin.facebook-v4a.showDialog] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.response][plugin.facebook-v4a.event.fbconnect.response] | ||
| > [event.isError][plugin.facebook-v4a.event.fbconnect.isError] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| Boolean value of `true` if the operation completed, `false` otherwise. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
|
|
||
| # event.expiration | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [Number][api.type.Number] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, expiration | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.login()][plugin.facebook-v4a.login] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.token][plugin.facebook-v4a.event.fbconnect.token] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| Returns a number that corresponds to the date/time when the Facebook login token expires. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
|
|
||
| # fbconnect | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [Event][api.type.event] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect | ||
| > __See also__ [facebook.init()][plugin.facebook-v4a.init] | ||
| > [facebook.setFBConnectListener()][plugin.facebook-v4a.setFBConnectListener] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| This event is sent to the listener specified in [facebook.init()][plugin.facebook-v4a.init], [facebook.setFBConnectListener()][plugin.facebook-v4a.setFBConnectListener], or [facebook.login()][plugin.facebook-v4a.login] when various Facebook connection states change. | ||
|
|
||
| ## Properties | ||
|
|
||
| #### [event.didComplete][plugin.facebook-v4a.event.fbconnect.didComplete] | ||
|
|
||
| #### [event.expiration][plugin.facebook-v4a.event.fbconnect.expiration] | ||
|
|
||
| #### [event.isError][plugin.facebook-v4a.event.fbconnect.isError] | ||
|
|
||
| #### [event.name][plugin.facebook-v4a.event.fbconnect.name] | ||
|
|
||
| #### [event.phase][plugin.facebook-v4a.event.fbconnect.phase] | ||
|
|
||
| #### [event.response][plugin.facebook-v4a.event.fbconnect.response] | ||
|
|
||
| #### [event.token][plugin.facebook-v4a.event.fbconnect.token] | ||
|
|
||
| #### [event.type][plugin.facebook-v4a.event.fbconnect.type] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
|
|
||
| # event.isError | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [Boolean][api.type.Boolean] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, isError | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.request()][plugin.facebook-v4a.request] | ||
| > [facebook.showDialog()][plugin.facebook-v4a.showDialog] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.response][plugin.facebook-v4a.event.fbconnect.response] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| If an error occurred, this is `true`, otherwise `nil` (which evaluates to `false` in logical expressions). If `true` is returned, [event.response][plugin.facebook-v4a.event.fbconnect.response] contains the cause of the error. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
|
|
||
| # event.name | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, name | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| String value of `"fbconnect"`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
|
|
||
| # event.phase | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, phase | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.login()][plugin.facebook-v4a.login] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.token][plugin.facebook-v4a.event.fbconnect.token] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| This property is only present when [event.type][plugin.facebook-v4a.event.fbconnect.type] is `"session"`. It takes on the following values: | ||
|
|
||
| * `"login"` | ||
| * `"loginFailed"` | ||
| * `"loginCancelled"` | ||
| * `"logout"` | ||
|
|
||
| Note that if the user is already logged in, `event.phase` returns `"login"`. When it is of another type, the property is `nil`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
|
|
||
| # event.response | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.String] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, response | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.request()][plugin.facebook-v4a.request] | ||
| > [facebook.showDialog()][plugin.facebook-v4a.showDialog] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.isError][plugin.facebook-v4a.event.fbconnect.isError] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| The response from the Facebook server. For [facebook.request()][plugin.facebook-v4a.request], it will return a <nobr>JSON-encoded</nobr> string. For [facebook.showDialog()][plugin.facebook-v4a.showDialog], it will return a URL string. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
|
|
||
| # event.token | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, token | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.login()][plugin.facebook-v4a.login] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > [event.phase][plugin.facebook-v4a.event.fbconnect.phase] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| This is the access token needed for certain Facebook API calls. It is only present when the [event.phase][plugin.facebook-v4a.event.fbconnect.phase] is `"login"` (`nil` otherwise). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
|
|
||
| # event.type | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbconnect, type | ||
| > __See also__ [fbconnect][plugin.facebook-v4a.event.fbconnect] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| This property determines what type of [fbconnect][plugin.facebook-v4a.event.fbconnect] event is happening. It takes on the following values depending on the action: | ||
|
|
||
| * `"session"` in response to [facebook.login()][plugin.facebook-v4a.login] or [facebook.logout()][plugin.facebook-v4a.logout]. | ||
| * `"request"` in response to [facebook.request()][plugin.facebook-v4a.request]. | ||
| * `"dialog"` in response to [facebook.showDialog()][plugin.facebook-v4a.showDialog]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
|
|
||
| # fbinit | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [Event][api.type.event] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbinit | ||
| > __See also__ [facebook.init()][plugin.facebook-v4a.init] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| This event is sent to the listener specified in [facebook.init()][plugin.facebook-v4a.init] when initialization is complete. It signals that the Facebook SDK has been initialized and is ready. | ||
|
|
||
| ## Properties | ||
|
|
||
| #### [event.name][plugin.facebook-v4a.event.fbinit.name] | ||
|
|
||
| #### [event.phase][plugin.facebook-v4a.event.fbinit.phase] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
|
|
||
| # event.name | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbinit][plugin.facebook-v4a.event.fbinit] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbinit, name | ||
| > __See also__ [fbinit][plugin.facebook-v4a.event.fbinit] | ||
| > [facebook.init()][plugin.facebook-v4a.init] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| String value of `"fbinit"`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
|
|
||
| # event.phase | ||
|
|
||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| > __Type__ [String][api.type.string] | ||
| > __Event__ [fbinit][plugin.facebook-v4a.event.fbinit] | ||
| > __Revision__ [REVISION_LABEL](REVISION_URL) | ||
| > __Keywords__ Facebook, fbinit, phase | ||
| > __See also__ [fbinit][plugin.facebook-v4a.event.fbinit] | ||
| > [facebook.init()][plugin.facebook-v4a.init] | ||
| > [facebook.*][plugin.facebook-v4a] | ||
| > --------------------- ------------------------------------------------------------------------------------------ | ||
| ## Overview | ||
|
|
||
| String value of `"initialized"`. |
Oops, something went wrong.