github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

In the docs, refer to the public object as a "session" instead of a

Browse Source 
"session handle".
This commit is contained in:
Andrew Wilcox
2013-11-23 13:04:58 -05:00
committed by Nick Martin
parent f6a5b7734f
commit bcac2bd11e
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/client/api.html
View File

@@ -276,7 +276,7 @@ invocation object, which provides the following:
begin running.
* `userId`: the id of the current user.
* `setUserId`: a function that associates the current client with a user.
* `session`: on the server, a reference to the [session handle](#meteor_onconnection) of the session this method call came in on.
* `session`: on the server, the [session](#meteor_onconnection) this method call came in on.
Calling `methods` on the client defines *stub* functions associated with
server methods of the same name. You don't have to define a stub for
@@ -500,11 +500,11 @@ server.
{{> api_box onConnection}}
`onConnection` returns an object with a single method `stop`. Calling
`stop` unregisters the callback, so that the callback will no longer
`stop` unregisters the callback, so that this callback will no longer
be called on new connections.
The callback is called with a single argument, a `SessionHandle`.
The `SessionHandle` is an object containing the following fields:
The callback is called with a single argument, the `session`.
The session is an object containing the following fields:
<dl class="objdesc">
{{#dtdd name="id" type="String"}}
@@ -537,9 +537,9 @@ called again.
The client closing the connection won't cause the session to close
right away because the client might reconnect; instead the session
will close after a timeout. Once the session has been closed
(including when the session handle `close` method is called), a
reconnect from the client attempting to reuse the session will receive
a new session.
(including when the session `close` method is called), a reconnect
from the client attempting to reuse the session will receive a new
session instead.
{{/note}}
<h2 id="collections"><span>Collections</span></h2>

2
docs/client/api.js
View File

@@ -487,7 +487,7 @@ Template.api.onConnection = {
args: [
{name: "callback",
type: "function",
descr: "The function to call when a new DDP connection is received."}
descr: "The function to call with the session when a new DDP connection is established."}
]
};