From 414f5e52fbc222b32a26e47ed1bd5dfdaea3ea82 Mon Sep 17 00:00:00 2001 From: Avital Oliver Date: Wed, 23 May 2012 13:22:26 -0700 Subject: [PATCH] Minor doc changes --- docs/client/api.html | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/client/api.html b/docs/client/api.html index c5912686c3..5217bfd632 100644 --- a/docs/client/api.html +++ b/docs/client/api.html @@ -335,16 +335,28 @@ To call methods on another Meteor application or subscribe to its data sets, call `Meteor.connect` with the URL of the application. `Meteor.connect` returns an object which provides: -* `subscribe` -* `methods` (to define stubs) -* `call` -* `apply` -* `status` -* `reconnect` -* `onReconnect` (this can be set to a function that calls methods as the first - step of reconnecting, for example in order to re-establish the proper auth - context) +* `subscribe` - + Subscribe to a record set. See + Meteor.subscribe. +* `call` - + Invoke a method. See Meteor.call. +* `apply` - + Invoke a method with an argument array. See + Meteor.apply. +* `methods` - + Define client-only stubs for methods defined on the remote server. See + Meteor.methods. +* `status` - + Get the current connection status. See + Meteor.status. +* `reconnect` - + See Meteor.reconnect. +* `onReconnect` - Set this to a function to be called as the first step of + reconnecting. This function can call methods which will be executed before + any other outstanding methods. For example, this can be used to re-establish + the appropriate authentication context on the new connection. +By default, clients open a connection to the server from which they're loaded. When you call `Meteor.subscribe`, `Meteor.status`, `Meteor.call`, and `Meteor.apply`, you are using a connection back to that default server.