From bcac2bd11e72d4f5b4a4307b17719d35d89260db Mon Sep 17 00:00:00 2001 From: Andrew Wilcox Date: Sat, 23 Nov 2013 13:04:58 -0500 Subject: [PATCH] In the docs, refer to the public object as a "session" instead of a "session handle". --- docs/client/api.html | 14 +++++++------- docs/client/api.js | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/client/api.html b/docs/client/api.html index 14304c28ef..c3fb3b9749 100644 --- a/docs/client/api.html +++ b/docs/client/api.html @@ -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:
{{#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}}

Collections

diff --git a/docs/client/api.js b/docs/client/api.js index ca1d73e44c..7dad578ce2 100644 --- a/docs/client/api.js +++ b/docs/client/api.js @@ -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."} ] };