Merge remote-tracking branch 'upstream/gh-pages' into gh-pages

Author: mtrezza

_includes/cloudcode/cloud-code-advanced.md

@@ -8,7 +8,7 @@ A simple GET request would look like:
 
 ```javascript
 Parse.Cloud.httpRequest({
-  url: 'http://www.awesomewebsite.com/'
+  url: 'https://www.awesomewebsite.com/'
 }).then(function(httpResponse) {
   // success
   console.log(httpResponse.text);
@@ -24,7 +24,7 @@ A GET request that specifies the port number would look like:
 
 ```javascript
 Parse.Cloud.httpRequest({
-  url: 'http://www.awesomewebsite.com:8080/'
+  url: 'https://www.awesomewebsite.com:8080/'
 }).then(function(httpResponse) {
   console.log(httpResponse.text);
 }, function(httpResponse) {
@@ -34,6 +34,19 @@ Parse.Cloud.httpRequest({
 
 Valid port numbers are 80, 443, and all numbers from 1025 through 65535.
 
+By default, `Parse.Cloud.httpRequest` does not follow redirects caused by HTTP 3xx response codes, the `followRedirects: true` option can be used to change this.
+
+```javascript
+Parse.Cloud.httpRequest({
+  url: 'https://www.awesomewebsite.com/',
+  followRedirects: true
+}).then(function(httpResponse) {
+  console.log(httpResponse.text);
+}, function(httpResponse) {
+  console.error('Request failed with response code ' + httpResponse.status);
+});
+```
+
 ### Query Parameters
 
 You can specify query parameters to append to the end of the url by setting `params` on the options object.  You can either pass a JSON object of key value pairs like:
@@ -569,3 +582,13 @@ Here's an example of the JSON data that would be sent in the request to this web
 ```
 
 After setting up your webhook in the Dashboard UI, you'll be acurately decrementing comment counts!
+
+# Config
+Parse Config offers a convenient way to configure parameters in Cloud Code.
+
+```javascript
+const config = await Parse.Config.get({useMasterKey: true});
+const privateParam = config.get("privateParam");
+```
+
+By default, Parse Config parameters can be publicly read which may be undesired if the parameter contains sensitive information that should not be exposed to clients. A parameter can be made readable only with the master key by setting the `Requires master key?` property via the Parse Dashboard to `Yes`.

_includes/cloudcode/cloud-code.md

@@ -192,16 +192,6 @@ If the function throws, the `Review` object will not be saved, and the client wi
 
 One useful tip is that even if your mobile app has many different versions, the same version of Cloud Code applies to all of them. Thus, if you launch an application that doesn't correctly check the validity of input data, you can still fix this problem by adding a validation with `beforeSave`.
 
-If you want to use `beforeSave` for a predefined class in the Parse JavaScript SDK (e.g. [Parse.User]({{ site.apis.js }}classes/Parse.User.html)), you should not pass a String for the first argument. Instead, you should pass the class itself:
-
-```javascript
-Parse.Cloud.beforeSave(Parse.User, (request) => {
-  if (!request.object.get("email")) {
-     throw "email is required for signup";
-  }
-});
-```
-
 ## Modifying Objects on Save
 
 In some cases, you don't want to throw out invalid data. You just want to tweak it a bit before saving it. `beforeSave` can handle this case, too. Any adjustment you make to request.object will be saved.
@@ -469,6 +459,44 @@ Parse.Cloud.beforeLogin(async request => {
 - On sign up
 - If the login credentials are incorrect
 
+# LiveQuery Triggers
+
+*Available only on parse-server cloud code starting 2.6.2*
+
+Sometimes you may want to monitor Live Query Events to be used with a 3rd Party such as datadog. The `onLiveQueryEvent` trigger can log events triggered, number of clients connected, number of subscriptions and errors.
+
+```javascript
+Parse.Cloud.onLiveQueryEvent(({
+  event,
+  client,
+  sessionToken,
+  useMasterKey,
+  installationId,
+  clients,
+  subscriptions,
+  error
+}) => {
+  if (event !== 'ws_disconnect') {
+    return;
+  }
+  // Do your magic
+});
+```
+*client, sessionToken, useMasterKey and installationId are available on parse-server cloud code 3.8.0+*
+
+To learn more, read the [Parse LiveQuery Protocol Specification](https://github.com/parse-community/parse-server/wiki/Parse-LiveQuery-Protocol-Specification)
+
+## Events
+
+* connect
+* subscribe
+* unsubscribe
+* ws_connect
+* ws_disconnect
+* ws_disconnect_error
+
+"connect" differs from "ws_connect", the former means that the client completed the connect procedure as defined by Parse Live Query protocol, where "ws_connect" just means that a new websocket was created.
+
 # Using the Master Key in cloud code
 Set `useMasterKey:true` in the requests that require master key.
 

_includes/graphql/getting-started.md

@@ -7,7 +7,7 @@ The easiest way to run the Parse GraphQL Server is using the CLI:
 ```bash
 $ npm install -g parse-server mongodb-runner
 $ mongodb-runner start
-$ parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test --mountGraphQL --mountPlayground
+$ parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test --publicServerURL http://localhost:1337/parse --mountGraphQL --mountPlayground
 ```
 
 Notes:
@@ -32,7 +32,7 @@ $ git clone https://github.com/parse-community/parse-server
 $ cd parse-server
 $ docker build --tag parse-server .
 $ docker run --name my-mongo -d mongo
-$ docker run --name my-parse-server --link my-mongo:mongo -d parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://mongo/test --mountGraphQL --mountPlayground
+$ docker run --name my-parse-server --link my-mongo:mongo -p 1337:1337 -d parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://mongo/test --publicServerURL http://localhost:1337/parse --mountGraphQL --mountPlayground
 ```
 
 After starting the server, you can visit [http://localhost:1337/playground](http://localhost:1337/playground) in your browser to start playing with your GraphQL API.
@@ -41,7 +41,15 @@ After starting the server, you can visit [http://localhost:1337/playground](http
 
 ## Using Express.js
 
-You can also mount the GraphQL API in an Express.js application together with the REST API or solo:
+You can also mount the GraphQL API in an Express.js application together with the REST API or solo. You first need to create a new project and install the required dependencies:
+
+```bash
+$ mkdir my-app
+$ cd my-app
+$ npm install parse-server express --save
+```
+
+Then, create an `index.js` file with the following content:
 
 ```js
 const express = require('express');
@@ -53,7 +61,8 @@ const parseServer = new ParseServer({
   databaseURI: 'mongodb://localhost:27017/test',
   appId: 'APPLICATION_ID',
   masterKey: 'MASTER_KEY',
-  serverURL: 'http://localhost:1337/parse'
+  serverURL: 'http://localhost:1337/parse',
+  publicServerURL: 'http://localhost:1337/parse'
 });
 
 const parseGraphQLServer = new ParseGraphQLServer(
@@ -75,7 +84,14 @@ app.listen(1337, function() {
 });
 ```
 
-After starting the server, you can visit [http://localhost:1337/playground](http://localhost:1337/playground) in your browser to start playing with your GraphQL API.
+And finally start your app:
+
+```bash
+$ npx mongodb-runner start
+$ node index.js
+```
+
+After starting the app, you can visit [http://localhost:1337/playground](http://localhost:1337/playground) in your browser to start playing with your GraphQL API.
 
 ⚠️ Please do not mount the GraphQL Playground in production as anyone could access your API Playground and read or change your application's data. [Parse Dashboard](#running-parse-dashboard) has a built-in GraphQL Playground and it is the recommended option for production apps.