|
| 1 | +/** |
| 2 | + * Defines a Cloud Function. |
| 3 | + * |
| 4 | + * **Available in Cloud Code only.** |
| 5 | + * |
| 6 | + * @method define |
| 7 | + * @name Parse.Cloud.define |
| 8 | + * @param {String} name The name of the Cloud Function |
| 9 | + * @param {Function} data The Cloud Function to register. This function should take two parameters a {@link Parse.Cloud.FunctionRequest} and a {@link Parse.Cloud.FunctionResponse} |
| 10 | + */ |
| 11 | + |
| 12 | +/** |
| 13 | + * Registers an after delete function. |
| 14 | + * |
| 15 | + * **Available in Cloud Code only.** |
| 16 | + * |
| 17 | + * If you want to use afterDelete for a predefined class in the Parse JavaScript SDK (e.g. {@link Parse.User}), you should pass the class itself and not the String for arg1. |
| 18 | + * ``` |
| 19 | + * Parse.Cloud.afterDelete('MyCustomClass', (request) => { |
| 20 | + * // code here |
| 21 | + * }) |
| 22 | + * |
| 23 | + * Parse.Cloud.afterDelete(Parse.User, (request) => { |
| 24 | + * // code here |
| 25 | + * }) |
| 26 | + *``` |
| 27 | + * |
| 28 | + * @method afterDelete |
| 29 | + * @name Parse.Cloud.afterDelete |
| 30 | + * @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after delete function for. This can instead be a String that is the className of the subclass. |
| 31 | + * @param {Function} func The function to run after a delete. This function should take just one parameter, {@link Parse.Cloud.TriggerRequest}. |
| 32 | + */ |
| 33 | + |
| 34 | +/** |
| 35 | + * |
| 36 | + * Registers an after save function. |
| 37 | + * |
| 38 | + * **Available in Cloud Code only.** |
| 39 | + * |
| 40 | + * If you want to use afterSave for a predefined class in the Parse JavaScript SDK (e.g. {@link Parse.User}), you should pass the class itself and not the String for arg1. |
| 41 | + * |
| 42 | + * ``` |
| 43 | + * Parse.Cloud.afterSave('MyCustomClass', function(request) { |
| 44 | + * // code here |
| 45 | + * }) |
| 46 | + * |
| 47 | + * Parse.Cloud.afterSave(Parse.User, function(request) { |
| 48 | + * // code here |
| 49 | + * }) |
| 50 | + * ``` |
| 51 | + * |
| 52 | + * @method afterSave |
| 53 | + * @name Parse.Cloud.afterSave |
| 54 | + * @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after save function for. This can instead be a String that is the className of the subclass. |
| 55 | + * @param {Function} func The function to run after a save. This function should take just one parameter, {@link Parse.Cloud.TriggerRequest}. |
| 56 | + */ |
| 57 | + |
| 58 | +/** |
| 59 | + * Registers an before delete function. |
| 60 | + * |
| 61 | + * **Available in Cloud Code only.** |
| 62 | + * |
| 63 | + * If you want to use beforeDelete for a predefined class in the Parse JavaScript SDK (e.g. {@link Parse.User}), you should pass the class itself and not the String for arg1. |
| 64 | + * ``` |
| 65 | + * Parse.Cloud.beforeDelete('MyCustomClass', (request, response) => { |
| 66 | + * // code here |
| 67 | + * }) |
| 68 | + * |
| 69 | + * Parse.Cloud.beforeDelete(Parse.User, (request, response) => { |
| 70 | + * // code here |
| 71 | + * }) |
| 72 | + *``` |
| 73 | + * |
| 74 | + * @method beforeDelete |
| 75 | + * @name Parse.Cloud.beforeDelete |
| 76 | + * @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the before delete function for. This can instead be a String that is the className of the subclass. |
| 77 | + * @param {Function} func The function to run before a delete. This function should take two parameters a {@link Parse.Cloud.TriggerRequest} and a {@link Parse.Cloud.BeforeDeleteResponse}. |
| 78 | + */ |
| 79 | + |
| 80 | +/** |
| 81 | + * |
| 82 | + * Registers an before save function. |
| 83 | + * |
| 84 | + * **Available in Cloud Code only.** |
| 85 | + * |
| 86 | + * If you want to use beforeSave for a predefined class in the Parse JavaScript SDK (e.g. {@link Parse.User}), you should pass the class itself and not the String for arg1. |
| 87 | + * |
| 88 | + * ``` |
| 89 | + * Parse.Cloud.beforeSave('MyCustomClass', (request, response) => { |
| 90 | + * // code here |
| 91 | + * }) |
| 92 | + * |
| 93 | + * Parse.Cloud.beforeSave(Parse.User, (request, response) => { |
| 94 | + * // code here |
| 95 | + * }) |
| 96 | + * ``` |
| 97 | + * |
| 98 | + * @method beforeSave |
| 99 | + * @name Parse.Cloud.beforeSave |
| 100 | + * @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after save function for. This can instead be a String that is the className of the subclass. |
| 101 | + * @param {Function} func The function to run before a save. This function should take two parameters a {@link Parse.Cloud.TriggerRequest} and a {@link Parse.Cloud.BeforeSaveResponse}. |
| 102 | + */ |
| 103 | + |
| 104 | +/** |
| 105 | + * Makes an HTTP Request. |
| 106 | + * |
| 107 | + * **Available in Cloud Code only.** |
| 108 | + * |
| 109 | + * By default, Parse.Cloud.httpRequest does not follow redirects caused by HTTP 3xx response codes. You can use the followRedirects option in the {@link Parse.Cloud.HTTPOptions} object to change this behavior. |
| 110 | + * |
| 111 | + * Sample request: |
| 112 | + * ``` |
| 113 | + * Parse.Cloud.httpRequest({ |
| 114 | + * url: 'http://www.parse.com/' |
| 115 | + * }).then(function(httpResponse) { |
| 116 | + * // success |
| 117 | + * console.log(httpResponse.text); |
| 118 | + * },function(httpResponse) { |
| 119 | + * // error |
| 120 | + * console.error('Request failed with response code ' + httpResponse.status); |
| 121 | + * }); |
| 122 | + * ``` |
| 123 | + * |
| 124 | + * @method httpRequest |
| 125 | + * @name Parse.Cloud.httpRequest |
| 126 | + * @param {Parse.Cloud.HTTPOptions} options The Parse.Cloud.HTTPOptions object that makes the request. |
| 127 | + * @return {Parse.Promise<Parse.Cloud.HTTPResponse>} A promise that will be resolved with a {@link Parse.Cloud.HTTPResponse} object when the request completes. |
| 128 | + */ |
| 129 | + |
| 130 | +/** |
| 131 | + * Defines a Background Job. |
| 132 | + * |
| 133 | + * **Available in Cloud Code only.** |
| 134 | + * |
| 135 | + * @method job |
| 136 | + * @name Parse.Cloud.job |
| 137 | + * @param {String} name The name of the Background Job |
| 138 | + * @param {Function} func The Background Job to register. This function should take two parameters a {@link Parse.Cloud.JobRequest} and a {@link Parse.Cloud.JobStatus} |
| 139 | + * |
| 140 | + */ |
| 141 | + |
| 142 | +/** |
| 143 | + * @typedef Parse.Cloud.TriggerRequest |
| 144 | + * @property {String} installationId If set, the installationId triggering the request. |
| 145 | + * @property {Boolean} master If true, means the master key was used. |
| 146 | + * @property {Parse.User} user If set, the user that made the request. |
| 147 | + * @property {Parse.Object} object The object triggering the hook. |
| 148 | + * @property {String} ip The IP address of the client making the request. |
| 149 | + * @property {Object} headers The original HTTP headers for the request. |
| 150 | + * @property {String} triggerName The name of the trigger (`beforeSave`, `afterSave`, ...) |
| 151 | + * @property {Object} log The current logger inside Parse Server. |
| 152 | + * @property {Parse.Object} original If set, the object, as currently stored. |
| 153 | + */ |
| 154 | + |
| 155 | +/** |
| 156 | + * @typedef Parse.Cloud.FunctionRequest |
| 157 | + * @property {String} installationId If set, the installationId triggering the request. |
| 158 | + * @property {Boolean} master If true, means the master key was used. |
| 159 | + * @property {Parse.User} user If set, the user that made the request. |
| 160 | + * @property {Object} params The params passed to the cloud function. |
| 161 | + */ |
| 162 | + |
| 163 | +/** |
| 164 | + * @typedef Parse.Cloud.JobRequest |
| 165 | + * @property {Object} params The params passed to the background job. |
| 166 | + */ |
| 167 | + |
| 168 | + /** |
| 169 | + * @typedef Parse.Cloud.JobStatus |
| 170 | + * @property {function} error If error is called, will end the job unsuccessfully with an optional completion message to be stored in the job status. |
| 171 | + * @property {function} message If message is called with a string argument, will update the current message to be stored in the job status. |
| 172 | + * @property {function} success If success is called, will end the job successfullly with the optional completion message to be stored in the job status. |
| 173 | + */ |
| 174 | + |
| 175 | +/** |
| 176 | + * @typedef Parse.Cloud.BeforeSaveResponse |
| 177 | + * @property {function} success If called, will allow the save to happen. If a Parse.Object is passed in, then the passed in object will be saved instead. |
| 178 | + * @property {function} error If called, will reject the save. An optional error message may be passed in. |
| 179 | + */ |
| 180 | + |
| 181 | +/** |
| 182 | + * @typedef Parse.Cloud.BeforeDeleteResponse |
| 183 | + * @property {function} success If called, will allow the delete to happen. |
| 184 | + * @property {function} error If called, will reject the save. An optional error message may be passed in. |
| 185 | + */ |
| 186 | + |
| 187 | +/** |
| 188 | + * @typedef Parse.Cloud.FunctionResponse |
| 189 | + * @property {function} success If success is called, will return a successful response with the optional argument to the caller. |
| 190 | + * @property {function} error If error is called, will return an error response with an optionally passed message. |
| 191 | + */ |
| 192 | + |
| 193 | +/** |
| 194 | + * @typedef Parse.Cloud.HTTPOptions |
| 195 | + * @property {String|Object} body The body of the request. If it is a JSON object, then the Content-Type set in the headers must be application/x-www-form-urlencoded or application/json. You can also set this to a {@link Buffer} object to send raw bytes. If you use a Buffer, you should also set the Content-Type header explicitly to describe what these bytes represent. |
| 196 | + * @property {function} error The function that is called when the request fails. It will be passed a Parse.Cloud.HTTPResponse object. |
| 197 | + * @property {Boolean} followRedirects Whether to follow redirects caused by HTTP 3xx responses. Defaults to false. |
| 198 | + * @property {Object} headers The headers for the request. |
| 199 | + * @property {String} method The method of the request. GET, POST, PUT, DELETE, HEAD, and OPTIONS are supported. Will default to GET if not specified. |
| 200 | + * @property {String|Object} params The query portion of the url. You can pass a JSON object of key value pairs like params: {q : 'Sean Plott'} or a raw string like params:q=Sean Plott. |
| 201 | + * @property {function} success The function that is called when the request successfully completes. It will be passed a Parse.Cloud.HTTPResponse object. |
| 202 | + * @property {string} url The url to send the request to. |
| 203 | + */ |
| 204 | + |
| 205 | +/** |
| 206 | + * @typedef Parse.Cloud.HTTPResponse |
| 207 | + * @property {Buffer} buffer The raw byte representation of the response body. Use this to receive binary data. See Buffer for more details. |
| 208 | + * @property {Object} cookies The cookies sent by the server. The keys in this object are the names of the cookies. The values are Parse.Cloud.Cookie objects. |
| 209 | + * @property {Object} data The parsed response body as a JavaScript object. This is only available when the response Content-Type is application/x-www-form-urlencoded or application/json. |
| 210 | + * @property {Object} headers The headers sent by the server. The keys in this object are the names of the headers. We do not support multiple response headers with the same name. In the common case of Set-Cookie headers, please use the cookies field instead. |
| 211 | + * @property {Number} status The status code. |
| 212 | + * @property {String} text The raw text representation of the response body. |
| 213 | + */ |
0 commit comments