A subscription handle. More...

Static Public Member Functions
static implicit	operator Coroutine (Subscription sub)

static Subscription	Subscribe (string name, params object[] args)
	Subscribe to a record set. Returns a handle that provides a ready property. You must call More...

Public Attributes
string	name
	The name of the subscription. Corresponds to your More...

string	requestId
	A unique identifier for the request used to fulfill this subscription. You generally will not need this. More...

object[]	args
	The arguments used in this subscription. More...

Properties
bool	ready `[get, set]`
	Gets a value specifying whether or not this subscription is ready (all the documents on the first request have been received). More...

Detailed Description

A subscription handle.

Member Function Documentation

static Subscription Meteor.Subscription.Subscribe	(	string	name,
		params object[]	args
	)

inlinestatic

Subscribe to a record set. Returns a handle that provides a ready property. You must call

yield return (Coroutine)subscribeInstance; in an IEnumerator/Coroutine to actually execute the subscription.

Example:

var subscriptionInstance = Meteor.Subscription.Subscribe("PublishName");

yield return (Coroutine)subscriptionInstance;

Parameters

name	Name. Corresponds to your Meteor.publish(name, ...) statement in your Meteor code.
args	Arguments. Corresponds to the arguments in the function provided to your Meteor.publish call.

object [] Meteor.Subscription.args

The arguments used in this subscription.

string Meteor.Subscription.name

The name of the subscription. Corresponds to your

Meteor.publish(name, ...) statement in your Meteor code.

string Meteor.Subscription.requestId

A unique identifier for the request used to fulfill this subscription. You generally will not need this.

bool Meteor.Subscription.ready

getset

Gets a value specifying whether or not this subscription is ready (all the documents on the first request have been received).

true if ready; otherwise, false.

The documentation for this class was generated from the following file: