parse-community/docs

Parse Platform docs

docs's Issues

Document that _User and _Installation are not supported by custom webhooks

The UI does not allow the creation of custom webhooks for these classes. This should be covered in the documentation for Webhooks: https://github.com/ParsePlatform/Docs/blob/master/en/common/cloud-code-advanced.mdown

Copying @stanleyw who was discussing this earlier with Min-Young.

Update examples to use Swift 2.0

Notes:

• println is now print

Add note: setTimeout not supported in Cloud Code

Since setTimeout is not allowed, the current example of async methods is wrong. Remove it or find another way.

Restore Tasks Section in Unity Guide

The Task section of the Unity SDK Docs is missing:
https://parse.com/docs/unity/guide#tasks

Express docs are gone

linked to from https://parse.com/docs/js/guide#cloud-code-modules is this https://parse.com/docs/js/api/classes/express.html which no longer exists.

At min, need to know which version of express is hosted to find the corresponding docs.

PHP docs gives 500 Error

https://parse.com/docs/php/guide
https://www.parse.com/docs/android/guide

and every other guides on the docs returns a 500 internal server error.

Update Installation appVersion documentation

appVersion isn't guaranteed to always be up-to-date since we try to prevent your app from DDOSing yourself when releasing app updates, since app updates and new app runs occur around the same time for all users and it would cause a spike that may lead you to run over your req/s limit.

https://parse.com/docs/android/guide#push-notifications-installations
parse-community/Parse-SDK-Android#24

User-scoped requests in the REST API

The REST API guide can be improved with a note on how to scope a request to a specific user.

Passing a session token in a X-Parse-Session-Token header will tell the backend to process the request in the scope of a specific user session.

A section or call out that explicitly documents the use of this header can go a long way towards helping developers understand how to use the REST API in their apps.

Update Express automatic generation command

Running parse generate express, as documented in /en/common/hosting.mdown, results in the following error under version 2.2.1 of the parse-cli:

$ parse generate express
unexpected arguments:[express]

Generates a sample express app in the current project directory.

Usage: 
  parse generate [flags]

Flags:
  -h, --help=false: help for generate
  -t, --type="express-ejs": Type of templates to use for generation.

The docs should be updated to reflect the new parse-cli syntax:

parse generate -t="express-ejs"

Add a note to Cloud Code Guide on compatibility with Node.js and npm

Cloud Code is V8 JavaScript, and Node.js is V8 JavaScript. Cloud Code is not Node.js. With the prevalent use of Node.js as a server side solution, it is understandable how a developer might confuse Cloud Code for a Node.js environment.

This distinction should be clearly called out in the Cloud Code section of the Documentation. I would suggest using one of the callouts already used in the right side of the docs throughout the documentation.

Furthermore, given that Cloud Code is not Node.js, one cannot simply import a npm and expect it to work without any modification. This has been brought up several times in Parse's developer forums.

A section documenting the necessary steps to adapt a npm module should be added to the Cloud Code guide, perhaps under the Modules section.

In general, you can follow this advice to adapt a npm for Cloud Code:

1. Install the module locally using npm, which will create a node_modules directory.
2. Copy the module's directory to your cloud/ directory.
3. Inspect the module's source for any require() method calls. If you find any, make sure these are turned into absolute paths (e.g. require('cloud/your_module_dependency.js');). You might need to download additional modules if the required file is not yet present in your cloud/ directory.
4. Import the module into your main.js file using require('cloud/your_module.js');

Cloud Code Section Of Platform Docs Has Disappeared

The Cloud Code section seems to have disappeared from the docs, ex: https://www.parse.com/docs/ios/guide#cloud-code now points to nowhere.

I was looking at it just a day or two ago and the examples are useful. (https://www.parse.com/docs/cloudcode/guide does not show examples for how to call cloud code from iOS.)

Broken links to Express API Reference

e.g. Both links in the following excerpt from https://parse.com/docs/js/guide#hosting-dynamic-websites give 404:

You can find details about Express and Cloud Code in our Express API docs.

Express can help you get your app up and running quickly, but if you prefer a lower-level Node.js-like HTTP interface, we have that too. For more details, please see our HTTP interface API docs.

404 error with blank javascript/HTML5 project

The page https://www.parse.com/downloads/javascript/parse-js-blank/latest gives a 404 error. This is linked to from this page https://www.parse.com/apps/quickstart?app_id=idebate#social/web/new and this one: https://www.parse.com/docs/downloads.

Expand JSON payload in the REST API curl examples

The previous version of the Docs presented the curl commands in a readable format that seems to have been lost in the transition to open source.

Currently, our examples look like this:

curl -X GET \
  -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
  -H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
  -G \
  --data-urlencode 'where={"playerName":{"$nin":["Jonathan Walsh","Dario Wunsch","Shawn Simon"]}}' \
  https://api.parse.com/1/classes/GameScore

They would be better laid out like this:

curl -X GET \
  -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
  -H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
  -G \
  --data-urlencode 'where={
  "playerName": {
    "$nin": [
      "Jonathan Walsh",
      "Dario Wunsch",
      "Shawn Simon"
    ]
  }
}' \
  https://api.parse.com/1/classes/GameScore

Swift sample code missing for various sections

Some of the files in the iOS guide are missing Swift examples (search for "no swift example"):

Docs/en/ios/handling-errors.mdown
Docs/en/ios/in-app-purchases.mdown
Docs/en/ios/local-datastore.mdown
Docs/en/ios/push-notifications.mdown
Docs/en/ios/queries.mdown
Docs/en/ios/user-interface.mdown

Add JavaScript, Java, and C# examples to Relations Guide

The Relations Guide only has Objective-C examples. We'll need JavaScript, Java, and .NET examples to be added.

Document all keys

We need one place to properly document each of the keys:

• Client Key
• JavaScript Key
• .NET Key
• REST Key
• Master Key
• Webhook Key

Add C# Examples to Performance Guide

The query examples are missing from the performance guidance for Parse.com and Unity:

GitHub: Docs / en / common / performance.mdown
Page: https://parse.com/docs/unity/guide#performance

"Not Equal To
For example, let's say you're tracking high scores for a game in a GameScore class. Now say you want to retrieve the scores for all players except a certain one. You could create this query:

This query can't take advantage of indexes. The database has to look at all the objects in the GameScore class to satisfy the constraint and retrieve the results. As the number of entries in the class grows, the query takes longer to run."

Regards,

Yuri

Parse.jar not found in the Parse-1.10.3.zip

I downloaded the Android SDK as mentioned in the documentation. When I unzip it, the parse.jar file is not found. It was present for earlier versions I used. However when I tried for 1.10.3 the parse.jar file was missing.

Update Express Project Generation Instructions

https://www.parse.com/docs/js/guide#hosting-creating-a-web-app

After you get Parse Hosting set up, you can generate a starter web app by typing the following inside your parse project folder.

$ parse generate express

λ →  parse version   
2.0.12
λ →  parse generate express
unexpected arguments:[express]

Generates a sample app in the current project directory

Usage: 
  parse generate [flags]
Flags:
  -t, --type="express-ejs": Type of templates to use for generation.

Global Flags:
  -h, --help=false: help for generate

订阅channels时程序会死掉

在按照文中给的方法（ PushService.subscribe(this, "Giants", YourActivity.class);
）来订阅channels时，程序会报如下错误：PushService.subscribe, PushService.unsubscribe, and PushService.setDefaultPushCallback methods cannot be used in conjunction with ParsePushBroadcastReceiver. See ParsePush.subscribe and ParsePush.unsubscribe.查看API可以看出subscribe是废弃方法，可以使用：ParsePush.subscribeInBackground("Giants");来解决这个问题，困扰了我很久，今天终于找到原因了，希望能更正文档，谢谢！

Missed linking frameworks in manual

Hey. There 2 missed frameworks in manual: https://www.parse.com/apps/quickstart#parse_data/mobile/ios/native/existing

Social.framework
Accounts.framework

Please add them, without these libs project fails build attempts.

More info on SO:
http://stackoverflow.com/a/23966142/1698467

Document all error codes

You can find a list of most error codes in each SDK's header file, but this is not easily discoverable.

Reference:

• iOS Error Codes

PFUser logOutInBackgroundWithBlock: documentation typo

Its says:

Asynchronously logs out the currenlt logged in user.

currently*

editing/creating custom fields - swift

I would like to edit a custom field in my parse app using parse iOS sdk, however, the suggested way does not seem to work.

var user = PFUser()
// other fields can be set just like with PFObject
user["phone"] = "415-392-0202" //ERROR: cannot assign a value of type string to a value of type any object?

Android documentation is missing ParseUI configuration instructions

Now that ParseQueryAdapter has been moved to the ParseUI library, the documentation needs to be expanded to include instructions on how to properly set this dependency up.

Expand Cloud Module Guide with instructions on importing newer versions

Parse's built-in Cloud Modules were provided as a one stop solution to importing select third party JavaScript SDKs into a Cloud Code environment.

Most of these modules are essentially snapshots of a particular provider's JavaScript SDK. Since these modules are not versioned, they have not been updated to avoid breaking existing Cloud Code applications. In the three years since these modules were launched, there have been several updates to most, if not all, of the JavaScript SDKs on which these modules were based originally. The moment module, for example, is based on a prerelease version.

Given that the original modules were adapted from existing JavaScript SDKs, it is quite straightforward to adapt the most recent version of one of these SDKs to work in Cloud Code as a third party Cloud Module. Most of these modules provide useful abstractions that warrant a full guide to importing these modules into Cloud Code successfully.

We should expand the Cloud Modules section of our guide to include instructions on importing the most up to date version of each of these third party Cloud Modules:

• Mailgun
• Mandrill
• Moment
• SendGrid
• Stripe
• Twilio
• Underscore

Android version of the Push Notification troubleshooting guide

Most of the content at https://www.parse.com/docs/ios/guide#push-notifications-troubleshooting applies to Android as well, with small code sample updates.

Link to API headers were applicable

The SDK's API Reference list all the methods available to the user, which may or may not be covered in the guide itself. We should link to the reference as needed. Some sections come to mind:

1. Queries section. We get a lot of questions that could be answered by performing a cursory search over https://parse.com/docs/ios/api/Classes/PFQuery.html to learn about all the methods that can be used with a query.

Cloud Code Modules API Reference Missing

The links to the API reference for Cloud code modules don't work anymore (On the JavaScript documentation). Ex "Stripe", "Apps Links".
Then i didn't found any reference of the cloud modules in the API reference page of the javascript SDK.

Facebook login crash

When I try to login user via Facebook, after confirmation I get

2015-06-04 00:02:56.853 XYZ[13805:4903239] 13805: CFNetwork internal error (0xc01a:/SourceCache/CFNetwork/CFNetwork-711.3.18/Foundation/NSURLRequest.mm:798)
2015-06-04 00:02:56.857 XYZ[13805:4903338] 13805: CFNetwork internal error (0xc01a:/SourceCache/CFNetwork/CFNetwork-711.3.18/HTTP/HTTPRequestParserClient.h:28)

and app crashes.

It passes The user authenticates via Facebook, and your app receives a callback using handleOpenURL.

And crash somewhere at Our SDK receives the user's Facebook access data and saves it to a PFUser. If no PFUser exists with the same Facebook ID, then a new PFUser is created.

Add missing Swift examples to PFQueryTableViewController Docs

When reviewing the docs for this section, selecting "Swift' as the language on a code window causes all code examples to disappear completely. Reproduced in Edge, Google Chrome, IE and Firefox (on Windows 10).

Expand Cloud Module Guide with instructions on importing newer versions

Parse's built-in Cloud Modules were provided as a one stop solution to importing select third party JavaScript SDKs into a Cloud Code environment.

Most of these modules are essentially snapshots of a particular provider's JavaScript SDK. Since these modules are not versioned, they have not been updated to avoid breaking existing Cloud Code applications. In the three years since these modules were launched, there have been several updates to most, if not all, of the JavaScript SDKs on which these modules were based originally. The moment module, for example, is based on a prerelease version.

Given that the original modules were adapted from existing JavaScript SDKs, it is quite straightforward to adapt the most recent version of one of these SDKs to work in Cloud Code as a third party Cloud Module. Most of these modules provide useful abstractions that warrant a full guide to importing these modules into Cloud Code successfully.

We should expand the Cloud Modules section of our guide to include instructions on importing the most up to date version of each of these third party Cloud Modules:

• Mailgun
• Mandrill
• Moment
• SendGrid
• Stripe
• Twilio
• Underscore

Add Querying subsection to Roles sections

It looks like there are no examples of how a PFRole should be queried. It just needs something similar to Users > Querying.

Express Documentation

None of the Express Middleware links work and the API Ref. here: https://parse.com/docs/js/api/ doesn't have any of the info anymore either. Does anyone know where to find any docs on this stuff?

Broken Link — JavaScript Blank Project

I'm trying to do the JavaScript quick start:

https://www.parse.com/apps/quickstart#parse_data/web/new

but the "Download the blank JavaScript/HTML5 project" button is broken (404).

Swift quickstart guides have outdaded parse APIs

The quickstarts for both Analytics and Push don't work, they reference old Parse API that doesnt include blocks, eg PFAnalytics.trackAppOpenedWithRemoteNotificationPayload(userInfo)

and PFAnalytics.trackAppOpenedWithLaunchOptions(launchOptions)

and PFAnalytics.trackEvent("read", dimensions: dimensions)

These all apparently require the usage of blocks now. I just downloaded and got started and had to debug all the quick starts.

iOS One-To-Many Relationships tutorial doesn't exist

https://parse.com/docs/ios/guide#objects-relational-data
The above link brings you here:

parseExpressCookieSession documentation gone

This page does not longer exists: https://parse.com/docs/js/api/classes/parseExpressCookieSession.html.

It is referenced here: https://parse.com/docs/js/guide#hosting-user-session-management (and numerous other places).

Typo in iOS Guide Push Notifications section

"pushType: This field is reserved for directing Parse to the push delivery network to be used. If the devic is registered to receive pushes via GCM, this field will be marked "gcm". If this device is not using GCM, and is using Parse's push notification service, it will be blank (readonly)."

device*

Restore full Security Guide

Some of the sections in the Security guide seem to have been lost in the transition to the new Docs version. Take a look at https://web.archive.org/web/20150422120021/https://parse.com/docs/data where some of the newer sections on CLP/ACL interactions can be seen, which are missing from parse.com/docs/ios/guide#security

Cloud Code JavaScript SDK API Reference Missing

https://github.com/ParsePlatform/Docs/blob/master/en/common/hosting.mdown file, link named "Express API docs" leads nowhere.

Cloude code is out from docs from js documentation

http://parse.com/docs/js/guide

Cloud code docs is missing from the main JS docs page. Please look into it.

Wish I had saved the HTML page when it was available!

Problem in this documentation https://parse.com/apps/quickstart#parse_push/android/native/existing

I am following this documentation https://parse.com/apps/quickstart#parse_push/android/native/existing
but not getting the results i.e the push notification. Can some one fix this? It anything missing in this documentation? Please Clarify Everything step by step.

Parse.Query.get returns Parse.Promise

https://parse.com/docs/js/api/symbols/Parse.Query.html#get

it lacks Returns section.

Translate documentation to Spanish

Incorrect code for PFFile to NSImage conversion in OS X guide

The OS X developers guide shows the following code (in section Files > Images)

PFFile *userImageFile = anotherPhoto[@"imageFile"];
[userImageFile getDataInBackgroundWithBlock:^(NSData *imageData, NSError *error) {
    if (!error) {
        UIImage *image = [UIImage imageWithData:imageData];
    }
}];

for creating an image from PFFile data. This is clearly a copy from the iOS guide as it is using UIImage instead of NSImage and therefore wrong.

The code for creating an NSImage is not so trivial, as there is no simple PNGRepresentation method on NSImage and you need to take retina scaling into account when creating an image from NSData.

Restore Promises Guide

The previous version of the docs had a "Promises" section with information on how to write serial + parallel promises. This seems to have been omitted from the new Docs.

Missing bracket in example

Now I have implementing Parse to my app.
I found missing bracket in source example.
please check this full request.(I'm not good at Git. So I wonder this issuing is good or not.)
#153

Quickstart iOS Guide

The iOS Quckstart Page isn't updated for Swift 2, and I'd love to update it, but I didn't find it on the Github.
The only thing I found was Docs/en/ios/getting-started.mdown, but there's no example code and the links are broken.