api.md

API

Reactive variables

These variables can be used inside getMeteorData or createContainer. They will be populated into your component if they change.

• Meteor.subscribe()
• Meteor.collection(collectionName, options)
  • .find(selector, options)
  • .findOne(selector, options)
• Meteor.user()
• Meteor.userId()
• Meteor.status()
• Meteor.loggingIn()
• ReactiveDict()

Additionals collection methods

These methods (except update) work offline. That means that elements are correctly updated offline, and when you reconnect to ddp, Meteor calls are taken care of.

• Meteor.collection(collectionName, options)
  • .insert(doc, callback)
  • .update(id, modifier, [options], [callback])
  • .remove(id, callback(err, countRemoved))

ListView Components

MeteorListView Component

Same as ListView Component but does not need dataSource and accepts three arguments :

• collection string required
• selector [string / object]
• options object
• listViewRef [string / function] ref to ListView component.

Example usage

<MeteorListView
  collection="todos"
  selector={{ done: true }}
  options={{ sort: { createdAt: -1 } }}
  renderRow={this.renderItem}
  //...other listview props
/>

MeteorComplexListView Component

Same as ListView Component but does not need dataSource and accepts one argument. You may need it if you make complex requests combining multiples collections.

• elements function required : a reactive function which returns an array of elements.
• listViewRef [string / function] ref to ListView component.

Example usage

<MeteorComplexListView
  elements={() => {
    return Meteor.collection('todos').find();
  }}
  renderRow={this.renderItem}
  //...other listview props
/>

Meteor Collections

Meteor.subscribe

Meteor.subscribe() returns an handle. If the component which called subscribe is unmounted, the subscription is automatically canceled.

Meteor.collection(collectionName, options)

You need pass the cursoredFind option when you get your collection if you want to use cursor-like method:

Meteor.collection("collectionName", { cursoredFind: true })

Or you can simply use find() to get an array of documents. The option default to false for backward compatibility. Cursor methods are available to share code more easily between a react-native app and a standard Meteor app.

Meteor DDP connection

Meteor.connect(endpoint, options)

Connect to a DDP server. You only have to do this once in your app.

Arguments

• url string required
• options object Available options are :
  • autoConnect boolean [true] whether to establish the connection to the server upon instantiation. When false, one can manually establish the connection with the Meteor.ddp.connect method.
  • autoReconnect boolean [true] whether to try to reconnect to the server when the socket connection closes, unless the closing was initiated by a call to the disconnect method.
  • reconnectInterval number [10000] the interval in ms between reconnection attempts.

Meteor.disconnect()

Disconnect from the DDP server.

Meteor methods

• Meteor.call
• Meteor.loginWithPassword (Please note that user is auto-resigned in - like in Meteor Web applications - thanks to React Native AsyncStorage.)
• Meteor.logout
• Meteor.logoutOtherClients

Availables packages

Convenience packages

Example import { composeWithTracker } from 'react-native-meteor';

• EJSON
• Tracker
• composeWithTracker: If you want to use react-komposer, you can use react-native-meteor compatible composeWithTracker
• Accounts (see below)

ReactiveDict

See documentation.

Meteor.Accounts

import { Accounts } from 'react-native-meteor';

• Accounts.createUser
• Accounts.changePassword
• Accounts.forgotPassword
• Accounts.resetPassword
• Accounts.onLogin
• Accounts.onLoginFailure

FSCollection

• Meteor.FSCollection(collectionName) : Helper for Meteor-CollectionFS. Full documentation here
• This plugin also exposes a FSCollectionImagesPreloader component which helps you preload every image you want in CollectionFS (only available on ios)

import { FSCollectionImagesPreloader } from 'react-native-meteor';

<FSCollectionImagesPreloader
  collection="imagesFiles"
  selector={{metadata.owner: XXX}}
/>

Meteor.ddp

Once connected to the ddp server, you can access every method available in ddp.js.

• Meteor.ddp.on('connected')
• Meteor.ddp.on('added')
• Meteor.ddp.on('changed')
• ...