| Current File : /home/c/i/d/cideo/www/wp-includesVIp/js/crop/images/README.md.tar |
home/cideo/www/wp-includesVIp/sodium_compat/src/Core/Curve25519/README.md 0000666 00000000332 15125473742 0021563 0 ustar 00 # Curve25519 Data Structures
These are PHP implementation of the [structs used in the ref10 curve25519 code](https://github.com/jedisct1/libsodium/blob/master/src/libsodium/include/sodium/private/curve25519_ref10.h).
home/cideo/www/wp-includesVIp/sodium_compat/src/Core32/Curve25519/README.md 0000666 00000000332 15125535134 0021722 0 ustar 00 # Curve25519 Data Structures
These are PHP implementation of the [structs used in the ref10 curve25519 code](https://github.com/jedisct1/libsodium/blob/master/src/libsodium/include/sodium/private/curve25519_ref10.h).
home/cideo/www/wp-contentVIp/plugins/js_composer/assets/lib/bower/progress-circle/README.md 0000666 00000006636 15126335264 0025722 0 ustar 00 ProgressCircle.js
=================
### A progress indicator in HTML5 canvas ###
homepage: http://qiao.github.com/ProgressCircle.js/
## Usage ##
Download the file and include it in your page.
```html
<script type="text/javascript" src="ProgressCircle.js"></script>
```
You should first create the canvas element in either HTML or Javascript,
and specify its width and height.
```html
<canvas id="my_canvas" width="100" height="40"></canvas>
```
**Note**: you should NOT specify the size of the canvas in CSS.
Then proceed with codes like the following ones.
```javascript
var myCanvas = document.getElementById('my_canvas');
var circle = new ProgressCircle({
canvas: myCanvas,
});
circle.addEntry({
fillColor: 'rgba(255, 255, 0, 0.5)',
progressListener: function() {
return THE_PROGRESS_VARIABLE_TO_LISTEN; // between 0 and 1
},
});
```
You can add multiple progress indicators:
```javascript
circle.addEntry({
fillColor: 'rgba(102, 255, 0, 0.5)',
progressListener: function() {return p1;},
}).addEntry({
fillColor: 'rgba(255, 255, 0, 0.5)',
progressListener: function() {return p2;},
}).addEntry({
fillColor: 'rgba(0, 0, 255, 0.5)',
progressListener: function() {return p3;},
});
```
The call `start` to start the animation.
```javascript
circle.start(33); // 33 is the interval(ms) between each update
```
If you want to stop the animation, call the `stop` method.
```javascript
circle.stop();
```
## Optional Parameters ##
```javascript
var circle = new ProgressCircle({
canvas: myCanvas,
minRadius: 10, // Inner radius of the innermost circle
arcWidth: 3, // Width of each circle
gapWidth: 2, // Space between adjacent circles
centerX: 20, // X coordinate of the circle center
centerY: 20, // Y coordinate of the circle center
infoLineLength: 200, // Length of the info line
horizLineLength: 50, // Length of the horizontal info line
infoLineBaseAngle: Math.PI / 6, // Start angle of the info line
infoLineAngleInterval: Math.PI / 8, // Angle between info lines
});
circle.addEntry({
fillColor: 'rgba(255, 255, 0, 0.5)',
outlineColor: 'rgba(255, 255, 255, 0.5)' // (Optional)
progressListener: function() {return p1;},
infoListener: function() {return text1;},// (Optional)
});
```
## License ##
[MIT License](http://www.opensource.org/licenses/mit-license.php)
© 2011-2013 Xueqiao Xu <xueqiaoxu@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
home/cideo/www/wp-contentVIp/plugins/js_composer/assets/lib/bower/chartjs/README.md 0000666 00000002170 15126335757 0024251 0 ustar 00 # Chart.js
[](https://travis-ci.org/nnnick/Chart.js) [](https://codeclimate.com/github/nnnick/Chart.js)
*Simple HTML5 Charts using the canvas element* [chartjs.org](http://www.chartjs.org)
## Documentation
You can find documentation at [chartjs.org/docs](http://www.chartjs.org/docs/). The markdown files that build the site are available under `/docs`. Please note - in some of the json examples of configuration you might notice some liquid tags - this is just for the generating the site html, please disregard.
## Bugs, issues and contributing
Before submitting an issue or a pull request to the project, please take a moment to look over the [contributing guidelines](https://github.com/nnnick/Chart.js/blob/master/CONTRIBUTING.md) first.
For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chartjs).
## License
Chart.js is available under the [MIT license](http://opensource.org/licenses/MIT).
home/cideo/www/wp-contentVIp/plugins/js_composer/assets/lib/bower/skrollr/README.md 0000666 00000075270 15126337743 0024313 0 ustar 00 [](http://travis-ci.org/Prinzhorn/skrollr)
skrollr 0.6.30
==============
Stand-alone **parallax scrolling** JavaScript library for **mobile (Android, iOS, etc.) and desktop** in about 12k minified.
Designer friendly. No JavaScript skills needed. Just plain CSS and HTML.
_Actually, skrollr is much more than "just" **parallax scrolling**. It's a full-fledged scrolling animation library. In fact, you can use it and still have no parallax scrolling at all. But I wanted to sound hip and use some buzz-words. By the way, skrollr leverages HTML5 and CSS3 ;-)_
Resources
=====
Plugins
-----
### Official
* [skrollr-menu](https://github.com/Prinzhorn/skrollr-menu) - Hash navigation
* [skrollr-ie](https://github.com/Prinzhorn/skrollr-ie) - IE < 9 CSS fixes
* [skrollr-stylesheets](https://github.com/Prinzhorn/skrollr-stylesheets) - Keyframes inside CSS files
### Third party
* [skrollr-colors](https://github.com/FezVrasta/skrollr-colors) - Mix and match hex, rgb and hsl colors.
* [skrollr-decks](https://github.com/TrySound/skrollr-decks) - Fullpage presentation decks.
In the wild
-----
Check out the [wiki page](https://github.com/Prinzhorn/skrollr/wiki/In-the-wild) for websites using skrollr and feel free to add your own website :). You can also shamelessly add yourself to the list [here](https://github.com/Prinzhorn/skrollr/wiki/Agencies-and-freelancers) if you are offering paid skrollr support.
Further resources (tutorials etc.)
-----
Moved to the [wiki](https://github.com/Prinzhorn/skrollr/wiki/Resources).
Documentation
=====
First of all: look at the [examples and read the source ;-)](https://github.com/Prinzhorn/skrollr/tree/master/examples). This might give you a feeling of how stuff works and you can see how some patterns can be implemented.
Abstract
------
skrollr allows you to animate any CSS property of any element depending on the horizontal scrollbar position. All you need to do is define key frames for each element at certain points in top scroll offset.
Other libraries require you to write JavaScript in order to define your animations. This introduces two main problems:
* Animation and element are not at one place. In order to find out if any animations are defined for a given element, you have to scroll through many (sometimes thousands) of lines of JavaScript.
* You have to learn a new syntax which is often very verbose and limited at the same time.
With skrollr, you put the definition of your key frames right where they belong (to the element) using a syntax you already know (plain CSS).
If you would rather have the keyframes inside a separate file, take a look at [skrollr-stylesheets](https://github.com/Prinzhorn/skrollr-stylesheets).
If you prefer to use JavaScript to define your animations make sure to take a look at [ScrollMagic](https://github.com/janpaepke/ScrollMagic). It depends on both jQuery and the Greensock Animation Platform (GSAP) and gives you full control over every detail of your animations.
Let's get serious
------
First of all you want to include the `skrollr.min.js` file at the bottom of your document (right before the closing `</body>`) and then call `skrollr.init()`. Or you can place it inside the `<head>` if you want to, but make sure to call `init()` once the document has been loaded (e.g. jQuery's `ready` event or even `window.onload`).
```html
<script type="text/javascript" src="skrollr.min.js"></script>
<script type="text/javascript">
var s = skrollr.init();
</script>
</body>
```
If you are using require.js to structure your project, you can use skrollr as a module as well.
```javascript
require(['skrollr'], function(skrollr){
var s = skrollr.init();
});
```
If you're familiar with CSS, you already know the `style` attribute. In order to create an animation you would need several, at least two, of them. That's what skrollr does. You use the HTML5 `data-` attributes to define multiple sets of styles (we call each of them **keyframe**) and skrollr interpolates between them.
#### Let's change the background-color of a `div` starting at `#00f` when the scrollbar is at the top and ending with `#f00` when the user scrolled 500 pixels down
```html
<div data-0="background-color:rgb(0,0,255);" data-500="background-color:rgb(255,0,0);">WOOOT</div>
```
[View in browser](http://prinzhorn.github.io/skrollr/examples/docu/1.html)
##### Lessons learned
* Skrollr ensures that you can actually scroll down 500 pixels or more, even if there's not enough content. You can suppress this by using the `forceHeight` option.
* You can't use `#00f` or `#0000ff`. You need to use `rgb` or `hsl` and explicitly decide which color space you want because they result in different animations (HSL is much cooler most of the time). Don't worry, the IE plugin teaches IE < 9 to display `rgb` and `hsl` correctly.
#### Now let's do a barrel roll at the same time
```html
<div data-0="background-color:rgb(0,0,255);transform:rotate(0deg);" data-500="background-color:rgb(255,0,0);transform:rotate(360deg);">WOOOT</div>
```
[View in browser](http://prinzhorn.github.io/skrollr/examples/docu/2.html)
##### Lessons learned
* Skrollr handles all these nasty CSS prefixes for you. Just -moz-relax and get yourself a cup of -webkit-coffee.
#### Now let the rotation bounce like it were a hip-hop video
```html
<div data-0="background-color:rgb(0,0,255);transform[bounce]:rotate(0deg);" data-500="background-color:rgb(255,0,0);transform[bounce]:rotate(360deg);">WOOOT</div>
```
[View in browser](http://prinzhorn.github.io/skrollr/examples/docu/3.html)
#### Lessons learned
* Skrollr allows non-linear animations. The so called *easing functions* can be used per-property by putting them in square brackets behind the property. There's a built-in list of easing functions (see below in the [JavaScript](#javascript) section) and you can use your own functions by using the `easings` options.
Now you may have noticed that using `500` as a keyframe position is kind of random and the look depends on your browser size.
#### Let's have the animation end when the top of the element reaches the top of the viewport (element leaves the viewport)
```html
<div data-0="background-color:rgb(0,0,255);transform[bounce]:rotate(0deg);" data-top="background-color:rgb(255,0,0);transform[bounce]:rotate(360deg);">WOOOT</div>
```
[View in browser](http://prinzhorn.github.io/skrollr/examples/docu/4.html)
##### Lessons learned
* Skrollr keyframes can either be [absolute](#absolute-mode-or-document-mode) or [relative](#relative-mode-or-viewport-mode).
That's the end of this short intro. The following sections will explain some more things in detail.
If you're not a fan of `data-attributes` or if you're planning a big website where you want a better and more flexible structure, take a look at [skrollr-stylesheets](https://github.com/Prinzhorn/skrollr-stylesheets).
Mobile support
-----
Starting with version 0.5.0 skrollr officially supports mobile browsers including Android and iOS. Furthermore, mobile support has been rewritten from scratch for skrollr 0.6.0.
### The Problem with mobile and the solution
(If you're not interested in the details, just scroll down a bit to see what you need to do for mobile support.)
Some words on why this is an important milestone and why others failed: Mobile browsers try to save battery wherever they can. That's why mobile browsers delay the execution of JavaScript while you are scrolling. iOS in particular does this very aggressively and completely stops JavaScript. In short, that's the reason why many scrolling libraries either don't work on mobile devices or they come with their own scrollbar which is a usability nightmare on desktop. It was an important requirement while I developed skrollr that I don't force you to scroll the way I want it. skrollr on desktop uses a native scrollbar and you can scroll the way you want to (keyboard, mouse, etc.).
You just told me it doesn't work on mobile, but why does it? The answer is simple. When using skrollr on mobile you don't actually scroll. When detecting a mobile browser, skrollr disables native scrolling and instead listens for touch events and moves the content (more specific the `#skrollr-body` element) using CSS transforms.
### What you need in order to support mobile browsers
Starting with skrollr 0.6.0 there's just one thing you need to do: Include an element on your page with the id `skrollr-body`. That's the element we move in order to fake scrolling. The only case where you don't need a `#skrollr-body` is when using `position:fixed` exclusively. In fact, the skrollr website doesn't include a `#skrollr-body` element. If you need both fixed and non-fixed (i.e. static) elements, put the static ones inside the `#skrollr-body` element.
Or to put it differently: On mobile the `skrollr-body` element is moved using CSS transforms. You can't have `position:fixed` or `background-attachment:fixed` inside elements which use CSS transforms as per CSS spec (http://meyerweb.com/eric/thoughts/2011/09/12/un-fixing-fixed-elements-with-css-transforms/). That's why those elements need to be **outside** of the `skrollr-body` element.
The `skrollr-body` element might be configured within the [init-options](#skrollrinitoptions).
AMD
---
Starting with `0.6.22` there's experimental AMD support. Please note that only skrollr core has AMD support so far. We will update the plugins in the future.
```js
require(['skrollr'], function(skrollr){
skrollr.init();
});
```
Absolute vs relative mode
-----
Being only able to define key frames in absolute values is simply insufficient for some cases. For example, if you don't know exactly where an element will be in the document. That's why there are two modes for key frames, namely `absolute` and `relative` mode.
### absolute mode (or document mode)
The key frames are defined as absolute values describing how much the **document** has been scrolled down.
The syntax is `data-[offset]-[anchor]`, where `offset` can be any integer (0 is default) and `anchor` can be either `start` (default) or `end`. Either `offset` or `anchor` can be omitted in some situations. Here are some examples of key frames and their meaning.
* `data-0` = `data-start` = `data-0-start`: When the scroll top is 0.
* `data-100` = `data-100-start`: When the scroll top is 100.
* `data--100` = `data--100-start`: When the scroll top is -100 (sounds like nonsense, but keep in mind that interpolation will be relative to this point).
* `data-end` = `data-0-end`: When offset is 0, but counting from the bottom of the document instead of from the top. In short: when you reach the bottom of the page.
* `data-100-end`: 100px before we reach the bottom.
* `data--100-end`: 100px after we reach the bottom (again, it's up to you whether you need it).
### relative mode (or viewport mode)
Instead of defining key frames relative to the **document** (i.e. absolute), we are able to define them depending on the position of any element in relation to the **viewport**.
The syntax is `data-[offset]-(viewport-anchor)-[element-anchor]`, where `offset` can again be any integer and defaults to 0. Both `viewport-anchor` (mandatory) and `element-anchor` (optional) can be one of `top`, `center` or `bottom`. If `element-anchor` is omitted, the value of `viewport-anchor` will be taken (just like with background-position). Here are some examples of key frames and their meaning.
* `data-top` = `data-0-top` = `data-top-top` = `data-0-top-top`: When the element's top is aligned with the top of the viewport.
* `data-100-top` = `data-100-top-top`: When the element's top is 100px above the top of the viewport.
* `data--100-top` = `data--100-top-top`: When the element's top is 100px below the top of the viewport.
* `data-top-bottom `= `data-0-top-bottom`: When the bottom of the element is at the top of the viewport (it's just not visible).
* `data-center-center` = `data-0-center-center`: When the element is at the center of the viewport.
* `data-bottom-center` = `data-0-bottom-center`: When the element's center is at the bottom of the viewport, thus the upper half of the element is visible.
By default the keyframes are triggered by the position of the element where the keyframes are described. However there are times when the position of a second element should trigger the first element's keyframes. The `data-anchor-target` attribute can be used in these cases. The `data-anchor-target` attribute accepts any CSS selector and the position of the first element on the page matching the selector will be used to trigger keyframes on the element where the attribute is defined. `data-anchor-target` requires IE 8 or greater.
Examples: `<div `data-anchor-target="#foo"`>` will have it's keyframes tiggered by the position of the `#foo element`. Any CSS selector can be used, i.e `data-anchor-target=".bar:not(.bacon) ~ span > a[href]"`
**Note**: If you need to support IE 7, then you may only use IDs as `anchor-target`s, i.e. `#foo`. The IE plugin maps `querySelector` to `getElementById`.
Here's an infographic for better understanding of anchors (click to open PDF):
[](https://raw.github.com/Prinzhorn/skrollr/master/guide/anchor-position-guide.pdf)
**Important**: All those values will be calculated up-front and transformed to `absolute` mode. So if either the element's box height changes (height, padding, border) or the elements position within the document, you probably need to call `refresh()` (see documentation in JavaScript section below). **Window resizing is handled by skrollr.**
Percentage offsets
------------------
All offsets shown above are given in absolute pixel values, e.g. `data-300` for `300px` from the top or `data-13-top-bottom` for a `13px` offset to the `top-bottom` anchor. As of skrollr `0.6.13` you can also have offsets as percentages of the viewport by appending a `p` to the number. For example `data-75p` for when you scrolled down `75%` of the viewport or `data-10p-center` to have a `10%` offset from the `center` anchor.
Hash navigation
-----
Check out the [skrollr-menu](https://github.com/Prinzhorn/skrollr-menu) plugin.
Working with constants
-----
I was lying to you. The syntax for absolute mode is not `data-[offset]-[anchor]` and for relative mode it's not `data-[offset]-(viewport-anchor)-[element-anchor]`. In both cases, `offset` can be preceded by a constant which can be passed to the `init` method. The name of the constant needs to be preceded with an underscore.
Example:
```js
skrollr.init({
constants: {
foobar: 1337
}
});
```
```html
<div data-_foobar="left:0%;" data-_foobar--100="left:50%;" data-_foobar-100="left:100%;"></div>
<!--Equal to-->
<div data-1337="left:0%;" data-1237="left:50%;" data-1437="left:100%;"></div>
```
Valid characters for a constant are `[a-z0-9_]`.
Dynamic constants
-----------------
Starting with skrollr `0.6.19` the word "constants" doesn't quite fit anymore, but who cares.
You can now use functions and percentages as constants. They are automatically evaluated when the window is resized or if you call `refresh`.
```js
skrollr.init({
constants: {
foo: function() {
//Note: you can access the skrollr instance with `this` for things like `this.relativeToAbsolute`
return Math.random() * 100;//trolololol
},
vh: '100p'
}
});
```
CSS classes
-----
skrollr will add a `skrollr` class to the `HTML` element when calling `init` and will remove a `no-skrollr` class if present. Additionally, it will add a `skrollr-desktop` or `skrollr-mobile` class depending on which it detects. This allows fallback CSS rules to create a good user experience on unsupported devices or when JavaScript or skrollr are disabled.
All elements under skrollr's control (elements with appropriate data-attributes) will get the `skrollable` class. In addition, we add either the `skrollable-before`, `skrollable-between` **or** `skrollable-after` class, depending on whether the current scroll position is before, between or after the first/last (smallest/largest) keyframe of an element.
Animating attributes
--------------------
Starting with skrollr 0.6.24 you can also animate attribute and not just style properties. This is especially a big thing because in the SVG world many properties are implemented as attributes and not in CSS. Animating an attribute couldn't be simplier, just prefix the property with an `@` symbol!
```html
<polygon
points='426,720 -200,720 -200,0 955,0'
data-0="@points:426,720 -200,720 -200,0 955,0"
data-500="@points:380,720 -200,720 -200,0 1302,0">
</polygon>
```
Note: as always, skrollr doesn't do any magic. It doesn't understand what a polygon or points are. It's only interpolating numbers, that's it. So make sure you have the same number of numbers in your keyframes (8 in this case).
Filling missing values
-----
Imagine the following animation
```html
<div data-100="left:0%;" data-200="top:0%;" data-300="left:50%;" data-400="top:50%;"></div>
```
One could expect `left` to have a value of `25%` at keyframe `200`. That is **not** the case. By design, skrollr only interpolates values between key frames which are direct **neighbors**. What actually happens is that skrollr internally fills out all holes once from left and then from right. So the above is equivalent to
```html
<div data-100="left:0%;top:0%;" data-200="left:0%;top:0%;" data-300="left:50%;top:0%;" data-400="left:50%;top:50%;"></div>
```
Preventing interpolation
-----
The reason why skrollr is so lightweight and powerful is because it literally interpolates **every** number it can find. If you want to prevent some side effect, you can suppress interpolation for a specific value by prepending an exclamation point.
Example:
```html
<!-- This will get your image url f***** up because there's no "kitten1.4561799.jpg" and the like -->
<div data-0="background-image:url(kitten1.jpg);" data-100="background-image:url(kitten2.jpg)"></div>
<!-- Better -->
<div data-0="background-image:!url(kitten1.jpg);" data-100="background-image:!url(kitten2.jpg)"></div>
```
**Note:** The values for both keyframes (if they contain a number) need to be prefixed if you want to avoid skrollr throwing an exception at you!
Limitations
-----
There are some limitations of skrollr you should be aware of.
* All numeric values have to have the same unit, even `0` needs a unit. It's not possible to animate from `5%` to `100px`. skrollr won't complain, but results are undefined.
* Animations between values which are composed of multiple numeric values like `margin:0 0 0 0;` are only possible for the same number of values. `margin:0px 0px 0px 0px;` to `margin:0px 100px 50px 3px;` is fine, but not `margin:10px;` to `margin:5px 10px;`.
* Animations between CSS transforms only work when they use the same functions in same order. From `rotate(0deg) scale(1)` to `rotate(1000deg) scale(5)` is fine.
* Color animations don't support named values like "red" or hex values like "#ff0000". Instead, you have to use `rgb()`, `rgba()`, `hsl()` and `hsla()`. Don't worry, there's a skrollr plugin for IE < 9 to support `hsl()` (without "a"!) and to fall rgba back to rgb.
* Color animations only work for same color functions. `hsl()` to `hsl()` or `hsla()` is fine, but not `rgb()` to `hsl()`. Which makes sense, because animating from the same colors in rgb space and in hsl space results in different animations (hsl gives you the nice rainbow stuff).
But feel free to send in a pull request to fix any of them. Just keep in mind that keeping skrollr as lightweight as possible has high priority.
JavaScript
====
On the JavaScript part there's not much to do (you can, if you want to!). So if you only know CSS and HTML, perfect.
skrollr.init([options])
-----
All there is to do is to call `skrollr.init([options]);` which returns an instance of the singleton skrollr class. Subsequent calls to `init()` will just return the same skrollr instance again.
Possible options for `init()` are
### smoothScrolling=true
Smooth scrolling smoothens your animations. When you scroll down 50 pixels, the animations will transition instead of jumping to the new position.
The global setting can be overridden per element by setting `data-smooth-scrolling` to `on` or `off`.
### smoothScrollingDuration=200
The number of milliseconds the animations run after the scroll position changed the last time.
### constants={}
An object containing integers as values. The keys can contain `[a-z0-9_]`. They *do not* need a leading underscore.
Example: `data-_myconst-200` and `skrollr.init({constants: {myconst: 300}})` result in `data-500`.
### scale=1
By default, skrollr uses the largest key frame and makes document height + viewport height this high, thus the max possible scroll top offset. If your animation runs too fast or too slow, just adjust the scale value.
`scale` only affects keyframes in absolute mode.
When `forceHeight` is set to false, `scale` is ignored.
`scale` affects `constants` as well.
`scale` does only affect key frames in absolute mode, e.g. `data-500` but not `data-top`.
###forceHeight=true
`true`: Make sure the document is high enough that all key frames fit inside. Example: You use `data-1000`, but the content only makes the document 500px high. skrollr will ensure that you can scroll down the whole 1000px. Or if you use relative mode, e.g. `data-top-bottom`, skrollr will make sure the bottom of the element can actually reach the top of the viewport.
`false`: Don't manipulate the document and just keep the natural scrollbar.
###mobileCheck=function() {...}
This option allows you to pass a function to skrollr overwriting the check for mobile devices. The function should return `true` when mobile scrolling should be used and `false` if not.
The default looks like this
```js
function() {
return (/Android|iPhone|iPad|iPod|BlackBerry/i).test(navigator.userAgent || navigator.vendor || window.opera);
}
```
### mobileDeceleration=0.004
The amount of deceleration for momentum scrolling on mobile devices. This options tells skrollr how fast or slow you want the scrolling to stop after the user lifted his finger.
Set it to `1` to disable momentum scrolling.
### skrollrBody='skrollr-body'
This option allows you to override the default id-selector used for supporting mobile browsers. It might come in handy when the element in question already has a assigned id or if you would like to define more then one skrollrBody depending on preceding JavaScript-logic.
### edgeStrategy='set'
This option specifies how to handle animations when the scroll position is outside the range on the keyframes (i.e. before the first or after the last keyframe).
One of three options are possible
* `set` _(default)_: When before/after the first/last keyframe, apply the styles of the first/last keyframe to the element.
* `ease`: Same as set, but the values will be transformed using the given easing function.
* `reset`: When before/after the first/last keyframe, apply the styles which the element had before skrollr did anything. This means resetting the class attribute as well as removing all styles which have been applied to the `style` property. This means the element won't have any `skrollable-*` CSS classes.
Example:
Given the following element with two keyframes
```html
<div data-1000="left:0%;top:0%;" data-2000="left:50%;top:100%;" style="left:-100%;" class="section"></div>
```
and the following easing function which always returns `0.5` (I know it's pointless, but it's just an example. A real world example would be an easing function that represents a curve and starts somewhere between `0` and `1`, but not at `1`)
```js
function(p) {
return 0.5;
}
```
and imagine the scrollbar is at `237`, which is below the first keyframe which is at `1000`.
* `set` will result in `<div style="left:0%;top:0%;" class="section skrollable skrollable-before"></div>` which is plain `data-1000`.
* `ease` will result in `<div style="left:25%;top:50%;" class="section skrollable skrollable-before"></div>` which is `0.5 * data-1000`.
* `reset` will result in `<div style="left:-100%;" class="section"></div>` which is what the element originally had. Note how `top` is missing.
### beforerender
A listener function that gets called each time right before we render everything. The function will be passed an object with the following properties:
```js
{
curTop: 10, //the current scroll top offset
lastTop: 0, //the top value of last time
maxTop: 100, //the max value you can scroll to. curTop/maxTop will give you the current progress.
direction: 'down' //either up or down
}
```
Returning `false` will prevent rendering.
### render
A listener function that gets called right after we finished rendering everything. The function will be passed with the same parameters as `beforerender`.
Example
```js
skrollr.init({
render: function(data) {
//Log the current scroll position.
console.log(data.curTop);
}
});
```
### keyframe
**Experimental**
In order to receive `keyframe` events from an element, add the `data-emit-events` attribute to the element. The keyframe function will be called with three arguments
1. The `element` that passed the keyframe.
2. The `name` of the keyframe, camel-cased (see example).
3. The `direction` the user is scrolling.
Example:
```html
<div
data-500="..."
data-top-bottom="..."
data-_offset-center="..."
data-emit-events
>
Some content
</div>
```
```js
skrollr.init({
keyframe: function(element, name, direction) {
//name will be one of data500, dataTopBottom, data_offsetCenter
}
});
```
Note: this is experimental, expect the API to change! Originally I wanted to emit the events right on the element, so you could do this
```js
//Wouldn't this be nice?
document.querySelector('#foo').addEventListener('skrollr.dataTopBottom.up', function() {
//#foo just passed the data-top-bottom keyframe while scrolling up
}, false)
```
but IE.
### easing
An object defining new easing functions or overwriting existing ones. Easing functions get just one argument, which is a value between 0 and 1 (the percentage of how much of the animation is done). The function should return a value between 0 and 1 as well, but for some easings a value less than 0 or greater than 1 is just fine.
An easing function basically transforms the timeline for an animation. When the animation should be 50% done, you can transform it to be 90% done or whatever your function does.
Example:
```js
skrollr.init({
easing: {
//This easing will sure drive you crazy
wtf: Math.random,
inverted: function(p) {
return 1 - p;
}
}
});
```
You can now use the easing functions like any other.
skrollr ships with some built in functions:
* linear: The default. Doesn't need to be specified.
* quadratic: To the power of two. So 50% looks like 25%.
* cubic: To the power of three. So 50% looks like 12.5%
* begin/end: They always return 0 or 1 respectively. No animation.
* swing: Slow at the beginning and accelerates at the end. So 25% -> 14.6%, 50% -> 50%, 75% -> 85.3%
* sqrt: Square root. Starts fast, slows down at the end.
* outCubic
* bounce: Bounces like a ball. See https://www.desmos.com/calculator/tbr20s8vd2 for a graphical representation.
**Custom easing**
* Use [this](http://www.timotheegroleau.com/Flash/experiments/easing_function_generator.htm) generator
* Insert the given polynomial coeficients instead of t, t2, t3, t4 and t5
```
t5*(p*p*p*p*p) + t4*(p*p*p*p) + t3*(p*p*p) + t2*(p*p) + t*p
```
Example shown with the values for easeOutElasticBig
```
easeOutElasticBig: function(p) {
return 56*(p*p*p*p*p) - 175*(p*p*p*p) + 200*(p*p*p) - 100*(p*p) + 20*p;
}
```
skrollr.get()
-----
Returns the skrollr instance if `init()` has been called before or `undefined`.
Public API
-----
Calling `init()` returns an instance of skrollr which exposes a public api.
### refresh([elements])
Reparses all given `elements`. You can pass a single element or an array-like element (Array, NodeList or jQuery object)
Useful when
* Elements in `relative` mode change and need to be updated.
* Data-attributes are manipulated dynamically.
* New elements are added to the DOM and should be controlled by skrollr.
When no `elements` are given, all elements in the document will be parsed again. In fact, when calling `skrollr.init()` skrollr uses `refresh()` without parameters internally.
Time consuming operations, should not be called on every rendering.
### relativeToAbsolute(element, viewportAnchor, elementAnchor)
Returns an integer which represents the absolute scroll position which correlates to the relative anchor.
`element` must be a DOM element.
`viewportAnchor` and `elementAnchor` must be one of `top`, `center` or `bottom`
Example:
```js
var offset = s.relativeToAbsolute(document.getElementById('foo'), 'top', 'bottom');
//offset contains the scroll position at which #foo's bottom is at the top of the viewport.
//If you now use setScrollTop(offset) or animateTo(offset) #foo's bottom will be perfectly aligned with the top of the viewport. Yay.
```
### getScrollTop()
Returns the current scroll offset in pixels. Normalizes different browser quirks and handles mobile scrolling.
### getMaxScrollTop()
Returns the number of pixels that can be scrolled down in total. If `forceHeight` is true, that's usually the largest keyframe. Otherwise it's the height of the document minus the viewport height.
### setScrollTop(top[, force = false])
Sets the top offset using `window.scrollTo(0, top)` on desktop or updating the internal state in case of mobile scrolling.
When `force` is set to `true`, skrollr will jump to the new position without any kind of transition. By default, the global `smoothScrolling` setting applies.
### isMobile()
Returns if skrollr runs in mobile mode (see also `mobileCheck` option).
### animateTo(top[, options])
Animates the scroll position from current position to `top`. Possible `options` are
#### duration
How long the animation should run in milliseconds. The default is `1000` or one second.
#### easing
The name of an easing function. The same functions can be used as for property animations. Default is `linear` .
#### done
A function to be called after the animation finished. When you pass a `top` value, which is the same as the current, then the function will be called immediately. The function gets a boolean argument `interrupted` which indicates if the animation was interrupted by `stopAnimateTo` or finished to the end.
### stopAnimateTo()
Stops the animation and calls the `done` callback passing `true` as `interrupted` arguments.
### isAnimatingTo()
Returns if an animation caused by animateTo is running.
### on(name, fn)
Set a listener function for one of the events described in the options section (beforerender, render, keyframe). Only one listener can be attached at a given time. This method overwrites the current listener, if any.
### off(name)
Removes the listener for the given event.
### destroy()
Destroys skrollr. All `class` and `style` attributes will be set to the values they had before.
Changelog
=====
See [HISTORY.md](https://github.com/Prinzhorn/skrollr/blob/master/HISTORY.md).
home/cideo/www/wp-contentVIp/plugins/js_composer/vendor/mmihey/PHP-Instagram-effects/README.md 0000666 00000000756 15126371772 0026206 0 ustar 00 PHP-Instagram-effects
=====================
PHP class for photo effects similar to Instagram
## Usage
```php
require 'src/Image/Filter.php';
$image = imagecreatefromjpeg("/path/to/image.jpg");
$filter = (new vcImageFilter($image))->aqua();
header('Content-type: image/jpeg');
imagejpeg($filter->getImage());
```
Examples of usage are in the `examples` directory. To generate example images, this bash snippet may be helpful:
```shell
for f in *.php; do php $f > ${f%.php}.png; done
```
home/cideo/www/wp-contentVIp/plugins/gravityforms/includes/webapi/v2/README.md 0000666 00000143557 15126373556 0023260 0 ustar 00 Gravity Forms REST API v2
=========================
## Upgrading to Version 2
The API is intended to feel as familiar as possible to developers who have worked with the WordPres REST API.
The endpoints are largely the same as version 1, however, the responses are slightly different and authentication
is no longer handled by Gravity Forms.
The following breaking changes are required by clients to consume version 2:
### Authentication
If you're using cookie authentication, WordPress supports cookie authentication out of the box so you'll just need
to change the way the nonce is created and sent. Create the nonce using wp_create_nonce( 'wp_rest' ) and send it
in the \_wpnonce data parameter (either POST data or in the query for GET requests), or via the X-WP-Nonce header.
If you're using signature authentication then you'll need to implement either Basic or OAuth authentication. Further details here:
* [WordPress REST API authentication documentation](http://v2.wp-api.org/guide/authentication/)
* [WP REST API: Setting Up and Using Basic Authentication](https://code.tutsplus.com/tutorials/wp-rest-api-setting-up-and-using-basic-authentication--cms-24762)
* [WP REST API: Setting Up and Using OAuth 1.0a Authentication](https://code.tutsplus.com/tutorials/wp-rest-api-setting-up-and-using-oauth-10a-authentication--cms-24797)
### Specify the Content Type when appropriate
The content-type application/json must be specified when sending JSON.
#### Example
```bash
curl --data [EXAMPLE_DATA] --header "Content-Type: application/json" https://localhost/wp-json/gf/v2
```
### No Response Envelope
The response will not be enveloped by default. This means that the response will not be a JSON string containing the
"status" and "response" - the body will contain the response and the HTTP code will contain the status.
The WP-API will envelope the response if the \_envelope param is included in the request.
#### Example
**Standard response:**
```json
{
"3": "Drop Down First Choice",
"created_by": "1",
"currency": "USD",
"date_created": "2016-10-10 18:06:12",
"form_id": "1",
"id": "1",
"ip": "127.0.0.1",
"is_fulfilled": null,
"is_read": 0,
"is_starred": 0,
"payment_amount": null,
"payment_date": null,
"payment_method": null,
"payment_status": null,
"post_id": null,
"source_url": "http://localhost?gf_page=preview&id=1",
"status": "active",
"transaction_id": null,
"transaction_type": null,
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36"
}
```
**Response with _envelope parameter:**
```json
{
"body": {
"3": "Drop Down First Choice",
"created_by": "1",
"currency": "USD",
"date_created": "2016-10-10 18:06:12",
"form_id": "1",
"id": "1",
"ip": "127.0.0.1",
"is_fulfilled": null,
"is_read": 0,
"is_starred": 0,
"payment_amount": null,
"payment_date": null,
"payment_method": null,
"payment_status": null,
"post_id": null,
"source_url": "http://localhost?gf_page=preview&id=1",
"status": "active",
"transaction_id": null,
"transaction_type": null,
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36"
},
"headers": {
"Allow": "GET, POST, PUT, PATCH, DELETE"
},
"status": 200
}
```
### Form Submissions
The Form Submissions endpoint now accepts application/json, application/x-www-form-urlencoded and multipart/form-data
content types. With the introduction of support for multipart/form-data now files can be sent to single file upload fields.
Request values should be sent all together instead of in separate elements for input_values, field_values, target_page
and source_page.
#### Example
**Example body of a JSON request:**
```json
{
"input_1": "test",
"field_values": "",
"source_page": 1,
"target_page": 0
}
```
### POST Single Resources
In order to maintain consistency with the WP API, the POST /entries and POST /forms endpoints no longer accept
collections. This means that it's no longer possible to create multiple entries or forms in a single request.
### DELETE now trashes
Sending DELETE requests will send the resource to the trash instead of deleting it permanently.
Repeating the DELETE request will not delete the resource permanently but it will generate a 401 (Gone) response code.
Use the 'force' parameter to delete the entry or form permanently.
### DELETE, POST and PUT responses
Successful DELETE, POST and PUT requests now return the deleted, updated or created entry or form instead of a confirmation message.
## Unit Tests
The unit tests can be installed from the terminal using:
```bash
bash tests/bin/install.sh [DB_NAME] [DB_USER] [DB_PASSWORD] [DB_HOST]
```
If you're using [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) you can use this command:
```bash
bash tests/bin/install.sh wordpress_unit_tests root root localhost
```
# API Documentation
## Authentication
Authentication can be performed using the same methods as the WordPress REST API. For further information on
WordPress' authentication, the following resources are available:
* [WordPress REST API authentication documentation](http://v2.wp-api.org/guide/authentication/)
* [WP REST API: Setting Up and Using Basic Authentication](https://code.tutsplus.com/tutorials/wp-rest-api-setting-up-and-using-basic-authentication--cms-24762)
* [WP REST API: Setting Up and Using OAuth 1.0a Authentication](https://code.tutsplus.com/tutorials/wp-rest-api-setting-up-and-using-oauth-10a-authentication--cms-24797)
## API Path
The API can be accessed as route from the WordPress REST API. This should look something like this:
https://localhost/wp-json/gf/v2/
For example, to obtain the Gravity Forms entry with ID 5, your request would be made to the following:
https://localhost/wp-json/gf/v2/entries/5
## Sending Requests
### PHP
```php
// Define the URL that will be accessed.
$url = rest_url( 'gf/v2/entries' );
// Example using Basic Authentication
$args = array(
'Authorization' => 'Basic ' . base64_encode( 'admin' . ':' . '12345' ),
'headers' => array( 'Content-type' => 'application/json' ),
);
// Make the request to the API.
$response = wp_remote_get( $url, $args );
// Check the response code.
if ( wp_remote_retrieve_response_code( $response ) != 200 || ( empty( wp_remote_retrieve_body( $response ) ) ) ){
// If not a 200, HTTP request failed.
die( 'There was an error attempting to access the API.' );
}
// Result is in the response body and is json encoded.
$body = json_decode( wp_remote_retrieve_body( $response ), true );
// Check the response body.
if( $body['status'] > 202 ){
die( "Could not retrieve forms." );
}
// Entries retrieved successfully.
$entries = $body['response'];
```
In this example, the *$entries* variable contains the response from the API request.
## Endpoints
### GET /entries
Gets all entries.
#### Path
https://localhost/wp-json/gf/v2/entries
#### Response *[json]*
The response will contain a JSON object which contains the entry details. An example can be found below:
**Example Response**
```json
{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": ""
}
```
#### Optional Arguments
* **_labels** *[int]*
Enabled the inclusion of field labels in the results.
* **Usage**
https://localhost/wp-json/gf/v2/entries?_labels=1
* **Example Response**
```json
[{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": "",
"_labels": {
"1": "Single Line Text",
"2": "Paragraph Text",
"13": "File",
"3": "Drop Down",
"4": "Multi Select",
"5": "Number",
"6": {
"6.1": "Checkboxes First Choice",
"6.2": "Checkboxes Second Choice",
"6.3": "Checkboxes Third Choice"
}
}
}]
```
* **include** *[int]*
An array of entries to include in the response.
* **Usage**
https://localhost/wp-json/gf/v2/entries?include[0]=1&include[1]=3
* **Example Response**
```json
[{
"date_created": "2016-11-28 18:12:17",
"1": "Text",
"6.1": "first",
"6.2": "second",
"6.3": "third"
}]
```
* **_field_ids** *[int]*
A comma separated list of fields to include in the response.
* **Usage**
https://localhost/wp-json/gf/v2/entries/5?_field_ids=1,6.1,6.2,6.3,date_created
* **Example Response**
```json
[{
"date_created": "2016-11-28 18:12:17",
"1": "Text",
"6.1": "first",
"6.2": "second",
"6.3": "third"
}]
```
* **search** *[json]*
The search criteria.
* **Properties**
* **field_filters** *[array]*
An array of filters to search by.
* **key** *[int|float]*
The field ID.
* **value** *[string]*
The value to search for.
* **operator** *[string]*
The comparison operator to use.
* **Usage**
```json
{
"field_filters": [{
"key": 1,
"value": "Field Value",
"operator": "contains"
}]
}
```
* **paging** *[array]*
The paging criteria.
* **Properties**
* **page_size** *[int]*
The number of results per page.
* **current_page** *[int]*
The current page to pull details from.
* **offset** *[int]*
The offset to begin with.
* **Usage**
https://localhost/wp-json/gf/v2/entries?paging[page_size]=20&paging[current_page]=2&paging[offset]=30
* **sorting** *[array]*
The sorting criteria.
* **Properties**
* **key** *[string|int]*
The key to sort by.
* **direction** *[string]*
The direction. Either *ASC* or *DESC*.
* **is_numeric** *[bool]*
If the key is numeric.
* **Usage**
https://localhost/wp-json/gf/v2/entries?sorting[key]=id&sorting[direction]=ASC&sorting[is_numeric]=true
* **form_ids** *[array]*
The form IDs to be included in the search.
* **Usage**
https://localhost/wp-json/gf/v2/entries?form_ids[0]=1&form_ids[1]=2
------------------------------------------------------------------------------------------------------------------------
### POST /entries
Creates an entry.
#### Path
https://localhost/wp-json/gf/v2/entries
#### Response *[json]*
When creating an entry, the response body will contain the complete new entry.
#### Optional Arguments
* **created_by** *[string]*
The user ID of the entry submitter.
* **Example**
Sets the entry submitter as the user with user ID *1*.
created_by=1
* **date_created** *[string]*
The date the entry was created, in UTC.
* **Example**
Sets the date created as *2016-11-28 18:12:17*.
date_created=2016-11-28+18%3A12%3A17
* **ip** *[string]*
The IP address of the entry creator.
* **Example**
Sets the entry IP as *127.0.0.1*.
ip=127.0.0.1
* **is_fulfilled** *[bool]*
Whether the transaction has been fulfilled, if applicable.
* **Example**
Sets the entry as fulfilled.
is_fulfilled=1
* **is_read** *[bool]*
Whether the entry has been read.
* **Example**
Marks the entry as read.
is_read=1
* **is_starred** *[bool]*
Whether the entry is starred.
* **Example**
Stars the entry.
is_starred=1
* **source_url** *[string]*
The URL where the form was embedded.
* **Examples**
Set the source URL as *http://localhost/pagename*:
source_url=http%3A%2F%2Flocalhost%2Fpagename
* **status** *[string]*
The status of the entry.
* **Examples**
Sets the status to *active*:
status=active
* **user_agent** *[string]*
The user agent string for the browser used to submit the entry.
* **Examples**
Sets the user agent as *Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.87 Safari/537.36*
user_agent=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F54.0.2840.87+Safari%2F537.36``
#### Payment Arguments
* **payment_amount** *[int]*
The amount of the payment, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Examples**
Sets the payment amount of *$2500*.
payment_amount=2500
* **payment_date** *[string]*
The date of the payment, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Example**
Sets the payment date as *2016-11-28 18:12:17*.
payment_date=2016-11-28+18%3A12%3A17
* **payment_method** *[string]*
The payment method for the payment, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Example**
Sets the payment method as *Stripe*.
payment_method=Stripe
* **payment_status** *[string]*
The status of the payment, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Example**
Sets the payment status as *Paid*.
payment_status=Paid
* **transaction_id** *[string]*
The transaction ID for the payment, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Example**
Sets the transaction ID as *1234*.
transaction_id=1234
* **transaction_type** *[string]*
The type of the transaction, if applicable.
* **Limitations**
Only applies when payment fields are present.
* **Example**
Sets the *Subscription* transaction type.
transaction_type=Subscription
------------------------------------------------------------------------------------------------------------------------
### GET /entries/[ENTRY_ID]
Gets an entry based on the entry ID.
#### Path
https://localhost/wp-json/gf/v2/entries/1
#### Response *[json]*
The response will contain a JSON object which contains the entry details. An example can be found below:
* **Example**
```json
{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": ""
}
```
#### Optional Arguments
* **_labels** *[int]*
Whether to include the labels.
* **Usage**
https://localhost/wp-json/gf/v2/entries/5?_labels=1
* **Example Response**
```json
{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": "",
"labels": {
"1": "Single Line Text",
"2": "Paragraph Text",
"13": "File",
"3": "Drop Down",
"4": "Multi Select",
"5": "Number",
"6": {
"6.1": "Checkboxes First Choice",
"6.2": "Checkboxes Second Choice",
"6.3": "Checkboxes Third Choice"
}
}
}
```
* **_field_ids** *[int]*
A comma separated list of fields to include in the response.
* **Usage**
https://localhost/wp-json/gf/v2/entries/5?_field_ids=1,6.1,6.2,6.3,date_created
* **Example Response**
```json
{
"date_created": "2016-11-28 18:12:17",
"1": "Text",
"6.1": "first",
"6.2": "second",
"6.3": "third"
}
```
------------------------------------------------------------------------------------------------------------------------
### PUT /entries/[ENTRY_ID]
Updates an entry based on the specified entry ID.
#### Path
https://localhost/wp-json/gf/v2/entries/1
#### Response *[json]*
When updating an entry, the response body will contain the complete updated entry.
#### Optional Arguments
* **created_by** *[string]*
The user ID of the entry submitter.
* **Example**
Sets the entry submitter as the user with user ID *1*.
created_by=1
* **date_created** *[string]*
The date the entry was created, in UTC.
* **Example**
Sets the date created as *2016-11-28 18:12:17*.
date_created=2016-11-28+18%3A12%3A17
* **ip** *[string]*
The IP address of the entry creator.
* **Example**
Sets the entry IP as *127.0.0.1*.
ip=127.0.0.1
* **is_fulfilled** *[bool]*
Whether the transaction has been fulfilled, if applicable.
* **Example**
Sets the entry as fulfilled.
is_fulfilled=1
* **is_read** *[bool]*
Whether the entry has been read.
* **Example**
Marks the entry as read.
is_read=1
* **is_starred** *[bool]*
Whether the entry is starred.
* **Example**
Stars the entry.
is_starred=1
* **source_url** *[string]*
The URL where the form was embedded.
* **Example**
Sets the source URL as *http://localhost/pagename*.
source_url=http%3A%2F%2Flocalhost%2Fpagename
* **status** *[string]*
The status of the entry.
* **Example**
Sets the status to *active*.
status=active
* **user_agent** *[string]*
The user agent string for the browser used to submit the entry.
* **Example**
Sets the user agent as *Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.87 Safari/537.36*
user_agent=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F54.0.2840.87+Safari%2F537.36``
#### Payment Arguments
* **payment_amount** *[int]*
The amount of the payment, if applicable.
* **Example**
Sets the payment amount of *$2500*.
payment_amount=2500
* **payment_date** *[string]*
The date of the payment, if applicable.
* **Example**
Sets the payment date as *2016-11-28 18:12:17*.
payment_date=2016-11-28+18%3A12%3A17
* **payment_method** *[string]*
The payment method for the payment, if applicable.
* **Example**
Sets the payment method as *Stripe*.
payment_method=Stripe
* **payment_status** *[string]*
The status of the payment, if applicable.
* **Example**
Sets the payment status as *Paid*.
payment_status=Paid
* **transaction_id** *[string]*
The transaction ID for the payment, if applicable.
* **Example**
Sets the transaction ID as *1234*.
transaction_id=1234
* **transaction_type** *[string]*
The type of the transaction, if applicable.
* **Example**
Sets the *Subscription* transaction type.
transaction_type=Subscription
------------------------------------------------------------------------------------------------------------------------
### POST /entries/[ENTRY_ID]/notifications
Sends the notifications for the given entry.
#### Path
https://localhost/wp-json/gf/v2/entries/1/notifications
#### Response *[json]*
* **Success** *[json]*
An array of notification IDs passed to WordPres for sending.
#### Optional Arguments
* **_notifications** *[array]*
Limit the notifications to specific IDs.
* **Example**
Sets the entry submitter as the user with user ID *1*.
https://localhost/wp-json/gf/v2/entries/1/notifications?_notifications=574ff8257d864,596e543d90b46
* **_event** *[string]*
The event to trigger. Default: form_submission.
* **Example**
Sets the date created as *2016-11-28 18:12:17*.
https://localhost/wp-json/gf/v2/entries/1/notifications?_event=form_submission
------------------------------------------------------------------------------------------------------------------------
### DELETE /entries/[ENTRY_ID]
Sends the specified entry to the trash. If the entry is already in the trash then repeating this request will not delete
the entry permanently but the response code will be 410 (Gone). Use the 'force' parameter to delete the entry permanently.
#### Path
https://localhost/wp-json/gf/v2/entries/1
https://localhost/wp-json/gf/v2/entries/1?force=1
#### Response *[json]*
* **Success** *[json]*
The trashed or deleted entry.
* **Failure** *[json]*
```json
{
"code": "gf_cannot_delete",
"message": "Invalid entry id: 71",
"data": {
"status": 500
}
}
```
------------------------------------------------------------------------------------------------------------------------
### GET /forms
Gets the details of all forms.
#### Path
https://localhost/wp-json/gf/v2/forms
#### Response *[json]*
```json
{
"4": {
"id": "4",
"title": "Multi-Page Form",
"entries": "2"
},
"1": {
"id": "1",
"title": "Test Form",
"entries": "60"
},
"5": {
"id": "5",
"title": "Test Form 2",
"entries": "2"
},
"6": {
"id": "6",
"title": "Test Form 3",
"entries": "2"
}
}
```
#### Optional Arguments
* **include** *[array]*
Limit the forms to specific IDs.
* **Example**
Returns the forms with IDs *1* and *2*.
https://localhost/wp-json/gf/v2/forms?include[0]=1&include[1]=2
------------------------------------------------------------------------------------------------------------------------
### POST /forms
Creates a form.
#### Path
https://localhost/wp-json/gf/v2/forms
#### Response
* **Success** *[json]*
The newly created form.
* **Failure** *[json]*
```json
{
"code": "missing_form_json",
"message": "The Form object must be sent as a JSON string in the request body with the content-type header set to application\/json.",
"data": {
"status": 400
}
}
```
#### Required Arguments
* **title** *[string]*
The form title.
* **Example**
Sets the form title as *Form Title*
```json
{
"title": "Form Title"
}
```
------------------------------------------------------------------------------------------------------------------------
### PUT /forms
Updates a form.
#### Path
https://localhost/wp-json/gf/v2/forms
#### Response
* **Success** *[json]*
The updated form.
* **Failure** *[json]*
```json
{
"code": "missing_form_json",
"message": "The Form object must be sent as a JSON string in the request body with the content-type header set to application\/json.",
"data": {
"status": 400
}
}
```
#### Required Arguments
* **title** *[string]*
The form title.
* **Example**
Sets the form title as *Form Title*
```json
{
"title": "Form Title"
}
```
------------------------------------------------------------------------------------------------------------------------
### DELETE /forms
Sends the specified form to the trash. If the form is already in the trash then repeating this request will not delete
the form permanently but the response code will be 410 (Gone). Use the 'force' parameter to delete the entry permanently.
#### Path
https://localhost/wp-json/gf/v2/forms
#### Response
* **Success** *[json]*
The deleted form.
* **Failure** *[json]*
```json
{
"code": "gf_form_invalid_id",
"message": "Invalid form id.",
"data": {
"status": 404
}
}
```
#### Required Arguments
* **title** *[string]*
The form title.
* **Example**
Sets the form title as *Form Title*
```json
{
"title": "Form Title"
}
```
------------------------------------------------------------------------------------------------------------------------
### GET /forms/[FORM_ID]
Gets the details of a form based on the specified form ID.
#### Path
https://localhost/wp-json/gf/v2/forms/1
#### Response
```json
{
"title": "Test Form",
"description": "",
"labelPlacement": "top_label",
"descriptionPlacement": "below",
"button": {
"type": "text",
"text": "Submit",
"imageUrl": ""
},
"fields": [
{
"type": "text",
"id": 1,
"label": "Single Line Text",
"adminLabel": "",
"isRequired": false,
"size": "medium",
"errorMessage": "",
"inputs": null,
"formId": 1,
"description": "",
"allowsPrepopulate": false,
"inputMask": false,
"inputMaskValue": "",
"inputType": "",
"labelPlacement": "",
"descriptionPlacement": "",
"subLabelPlacement": "",
"placeholder": "",
"cssClass": "",
"inputName": "",
"noDuplicates": false,
"defaultValue": "",
"choices": "",
"conditionalLogic": "",
"failed_validation": "",
"productField": "",
"enablePasswordInput": "",
"maxLength": "",
"pageNumber": 1,
"displayOnly": "",
"multipleFiles": false,
"maxFiles": "",
"calculationFormula": "",
"calculationRounding": "",
"enableCalculation": "",
"disableQuantity": false,
"displayAllCategories": false,
"useRichTextEditor": false,
"visibility": "visible"
},
{
"type": "radio",
"id": 7,
"label": "Radio Buttons",
"adminLabel": "",
"isRequired": false,
"size": "medium",
"errorMessage": "",
"inputs": null,
"choices": [
{
"text": "Radio Buttons First Choice",
"value": "Radio Buttons First Choice",
"isSelected": false,
"price": ""
},
{
"text": "Radio Buttons Second Choice",
"value": "Radio Buttons Second Choice",
"isSelected": false,
"price": ""
},
{
"text": "Radio Buttons Third Choice",
"value": "Radio Buttons Third Choice",
"isSelected": false,
"price": ""
}
],
"formId": 1,
"description": "",
"allowsPrepopulate": false,
"inputMask": false,
"inputMaskValue": "",
"inputType": "",
"labelPlacement": "",
"descriptionPlacement": "",
"subLabelPlacement": "",
"placeholder": "",
"cssClass": "",
"inputName": "",
"noDuplicates": false,
"defaultValue": "",
"conditionalLogic": "",
"failed_validation": "",
"productField": "",
"enableOtherChoice": "",
"enablePrice": "",
"pageNumber": 1,
"displayOnly": "",
"multipleFiles": false,
"maxFiles": "",
"calculationFormula": "",
"calculationRounding": "",
"enableCalculation": "",
"disableQuantity": false,
"displayAllCategories": false,
"useRichTextEditor": false,
"visibility": "visible"
},
{
"type": "product",
"id": 22,
"label": "Product Name",
"adminLabel": "",
"isRequired": false,
"size": "medium",
"errorMessage": "",
"inputs": [
{
"id": "22.1",
"label": "Name",
"name": ""
},
{
"id": "22.2",
"label": "Price",
"name": ""
},
{
"id": "22.3",
"label": "Quantity",
"name": ""
}
],
"inputType": "singleproduct",
"enablePrice": null,
"formId": 1,
"description": "",
"allowsPrepopulate": false,
"inputMask": false,
"inputMaskValue": "",
"labelPlacement": "",
"descriptionPlacement": "",
"subLabelPlacement": "",
"placeholder": "",
"cssClass": "",
"inputName": "",
"visibility": "visible",
"noDuplicates": false,
"defaultValue": "",
"choices": "",
"conditionalLogic": "",
"failed_validation": "",
"productField": "",
"basePrice": "$200.00",
"disableQuantity": false,
"pageNumber": 1,
"displayOnly": "",
"multipleFiles": false,
"maxFiles": "",
"calculationFormula": "",
"calculationRounding": "",
"enableCalculation": "",
"displayAllCategories": false,
"useRichTextEditor": false
}
],
"version": "2.1.1.11",
"id": 1,
"useCurrentUserAsAuthor": true,
"postContentTemplateEnabled": false,
"postTitleTemplateEnabled": false,
"postTitleTemplate": "",
"postContentTemplate": "",
"lastPageButton": null,
"pagination": null,
"firstPageCssClass": null,
"postAuthor": "1",
"postCategory": "1",
"postFormat": "0",
"postStatus": "draft",
"subLabelPlacement": "below",
"cssClass": "",
"enableHoneypot": false,
"enableAnimation": false,
"save": {
"enabled": true,
"button": {
"type": "link",
"text": "Save and Continue Later"
}
},
"limitEntries": false,
"limitEntriesCount": "",
"limitEntriesPeriod": "",
"limitEntriesMessage": "",
"scheduleForm": false,
"scheduleStart": "",
"scheduleStartHour": "",
"scheduleStartMinute": "",
"scheduleStartAmpm": "",
"scheduleEnd": "",
"scheduleEndHour": "",
"scheduleEndMinute": "",
"scheduleEndAmpm": "",
"schedulePendingMessage": "",
"scheduleMessage": "",
"requireLogin": false,
"requireLoginMessage": "",
"notifications": {
"57f6965a0b2e0": {
"id": "57f6965a0b2e0",
"to": "{admin_email}",
"name": "Admin Notification",
"event": "form_submission",
"toType": "email",
"subject": "New submission from {form_title}",
"message": "{all_fields}"
}
},
"confirmations": {
"57f6965a0bcd0": {
"id": "57f6965a0bcd0",
"name": "Default Confirmation",
"isDefault": true,
"type": "page",
"message": "",
"url": "",
"pageId": 2,
"queryString": "",
"disableAutoformat": false,
"conditionalLogic": [],
"gppcmtEnable": true
}
},
"is_active": "1",
"date_created": "2016-10-06 18:22:18",
"is_trash": "0"
}
```
------------------------------------------------------------------------------------------------------------------------
### GET /forms/[FORM_ID]/entries
Gets entries associated with a specific form.
#### Path
https://localhost/wp-json/gf/v2/forms/1/entries
#### Response *[json]*
The response will contain a JSON object which contains the entry details. An example can be found below:
**Example Response**
```json
{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": ""
}
```
#### Optional Arguments
* **_labels** *[int]*
Whether to include the labels.
* **Usage**
https://localhost/wp-json/gf/v2/forms/1/entries?_labels=1
* **Example Response**
```json
{
"id": "71",
"form_id": "1",
"date_created": "2016-11-28 18:12:17",
"is_starred": 0,
"is_read": 0,
"ip": "127.0.0.1",
"source_url": "http:\/\/localhost\/pagename",
"post_id": null,
"created_by": "2",
"user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/54.0.2840.87 Safari\/537.36",
"status": "active",
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"6.1": "",
"6.2": "",
"6.3": "",
"labels": {
"1": "Single Line Text",
"2": "Paragraph Text",
"13": "File",
"3": "Drop Down",
"4": "Multi Select",
"5": "Number",
"6": {
"6.1": "Checkboxes First Choice",
"6.2": "Checkboxes Second Choice",
"6.3": "Checkboxes Third Choice"
}
}
}
```
* **_field_ids** *[int]*
A comma separated list of fields to include in the response.
* **Usage**
https://localhost/wp-json/gf/v2/entries/5?_field_ids=1,6.1,6.2,6.3,date_created
* **Example Response**
```json
{
"date_created": "2016-11-28 18:12:17",
"1": "Text",
"6.1": "first",
"6.2": "second",
"6.3": "third"
}
```
* **search** *[json]*
The search criteria.
* **Usage**
* **field_filters** *array*
An array of filters to search by.
* **key** *int|float*
The field ID.
* **value** *string*
The value to search for.
* **operator** *string*
The comparison operator to use.
```json
{
"field_filters": [{
"key": 1,
"value": "Field Value",
"operator": "contains"
}]
}
```
* **paging** *[array]*
The paging criteria.
* **Parameters**
* **page_size** *[int]*
The number of results per page.
* **current_page** *[int]*
The current page to pull details from.
* **offset** *[int]*
The offset to begin with.
* **Usage**
https://localhost/wp-json/gf/v2/forms/1/entries?paging[page_size]=20&paging[current_page]=2&paging[offset]=30
* **sorting** *[array]*
The sorting criteria.
* **Parameters**
* **key** *[string|int]*
The key to sort by.
* **direction** *[string]*
The direction. Either *ASC* or *DESC*.
* **is_numeric** *[bool]*
If the key is numeric.
* **Usage**
https://localhost/wp-json/gf/v2/forms/1/entries?sorting[key]=id&sorting[direction]=ASC&sorting[is_numeric]=true
------------------------------------------------------------------------------------------------------------------------
### POST /forms/[FORM_ID]/entries
Creates an entry based on the specified form ID.
#### Path
https://localhost/wp-json/gf/v2/forms/1/entries
#### Response *[json]*
When creating an entry, the response body will contain the new entry.
#### Optional Arguments
* **created_by** *[string]*
The user ID of the entry submitter.
* **Example**
Sets the entry submitter as the user with user ID *1*.
created_by=1
* **date_created** *[string]*
The date the entry was created, in UTC.
* **Example**
Sets the date created as *2016-11-28 18:12:17*.
date_created=2016-11-28+18%3A12%3A17
* **ip** *[string]*
The IP address of the entry creator.
* **Example**
Sets the entry IP as *127.0.0.1*.
ip=127.0.0.1
* **is_fulfilled** *[bool]*
Whether the transaction has been fulfilled, if applicable.
* **Example**
Sets the entry as fulfilled.
is_fulfilled=1
* **is_read** *[bool]*
Whether the entry has been read.
* **Example**
Marks the entry as read.
is_read=1
* **is_starred** *[bool]*
Whether the entry is starred.
* **Example**
Stars the entry.
is_starred=1
* **source_url** *[string]*
The URL where the form was embedded.
* **Example**
Sets the source URL as *http://localhost/pagename*.
source_url=http%3A%2F%2Flocalhost%2Fpagename
* **status** *[string]*
The status of the entry.
* **Example**
Sets the status to *active*.
status=active
* **user_agent** *[string]*
The user agent string for the browser used to submit the entry.
* **Example**
Sets the user agent as:
*Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.87 Safari/537.36*
user_agent=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F54.0.2840.87+Safari%2F537.36``
#### Payment Arguments
* **payment_amount** *[int]*
The amount of the payment, if applicable.
* **Example**
Sets the payment amount of *$2500*.
payment_amount=2500
* **payment_date** *[string]*
The date of the payment, if applicable.
* **Example**
Sets the payment date as *2016-11-28 18:12:17*.
payment_date=2016-11-28+18%3A12%3A17
* **payment_method** *[string]*
The payment method for the payment, if applicable.
* **Example**
Sets the payment method as *Stripe*.
payment_method=Stripe
* **payment_status** *[string]*
The status of the payment, if applicable.
* **Example**
Sets the payment status as *Paid*.
payment_status=Paid
* **transaction_id** *[string]*
The transaction ID for the payment, if applicable.
* **Example**
Sets the transaction ID as *1234*.
transaction_id=1234
* **transaction_type** *[string]*
The type of the transaction, if applicable.
* **Example**
Sets the *Subscription* transaction type.
transaction_type=Subscription
------------------------------------------------------------------------------------------------------------------------
### GET /forms/[FORM_ID]/results
Gets form details, including entry details.
#### Path
https://localhost/wp-json/gf/v2/forms/1/results
#### Response
```json
{
"entry_count": "60",
"field_data": {
"1": 29,
"2": 7,
"13": 12,
"3": {
"Drop Down First Choice": 52,
"Drop Down Second Choice": 0,
"Drop Down Third Choice": 0
},
"4": {
"Multi Select First Choice": 2,
"Multi Select Second Choice": 0,
"Multi Select Third Choice": 0
},
"5": 2,
"6": {
"Checkboxes First Choice": 2,
"Checkboxes Second Choice": 0,
"Checkboxes Third Choice": 0
},
"7": {
"Radio Buttons First Choice": 0,
"Radio Buttons Second Choice": 0,
"Radio Buttons Third Choice": 0
},
"8": 0,
"9": 0,
"10": 0,
"14": 6,
"15": 3,
"16": 0,
"17": 2,
"18": 0,
"19": 0,
"20": 0,
"21": 0,
"22": 8,
"23": 1,
"24": 0
},
"status": "complete",
"timestamp": 1480536695,
"_labels": {
"1": "Single Line Text",
"2": "Paragraph Text",
"13": "File",
"3": {
"label": "Drop Down",
"choices": {
"Drop Down First Choice": "Drop Down First Choice",
"Drop Down Second Choice": "Drop Down Second Choice",
"Drop Down Third Choice": "Drop Down Third Choice"
}
},
"4": {
"label": "Multi Select",
"choices": {
"Multi Select First Choice": "Multi Select First Choice",
"Multi Select Second Choice": "Multi Select Second Choice",
"Multi Select Third Choice": "Multi Select Third Choice"
}
},
"5": "Number",
"6": {
"label": "Checkboxes",
"choices": {
"Checkboxes First Choice": "Checkboxes First Choice",
"Checkboxes Second Choice": "Checkboxes Second Choice",
"Checkboxes Third Choice": "Checkboxes Third Choice"
}
},
"7": {
"label": "Radio Buttons",
"choices": {
"Radio Buttons First Choice": "Radio Buttons First Choice",
"Radio Buttons Second Choice": "Radio Buttons Second Choice",
"Radio Buttons Third Choice": "Radio Buttons Third Choice"
}
},
"8": "Hidden Field",
"9": "HTML Block",
"10": "Section Break",
"14": "List",
"15": "Date",
"16": "Phone",
"17": "Post Body",
"18": "Name",
"19": "Name",
"20": "Name",
"21": "Email",
"22": "Product Name",
"23": "Total",
"24": "Coupon"
}
}
```
#### Optional Arguments
* **search** *[json]*
The search criteria.
* **Parameters**
* **field_filters** *[array]*
An array of filters to search by.
* **key** *[int|float]*
The field ID.
* **value** *[string]*
The value to search for.
* **operator** *[string]*
The comparison operator to use.
* **Usage**
```json
{
"field_filters": [{
"key": 1,
"value": "Field Value",
"operator": "contains"
}]
}
```
------------------------------------------------------------------------------------------------------------------------
### POST /forms/[FORM_ID]/submissions
Submits the specified form ID with the specified values.
#### Path
https://localhost/wp-json/gf/v2/forms/1/submissions
#### Response
#### Required Arguments
* **input_[FIELD_ID]** *[string]*
The input values. Replace field ID with the input that you want to submit data for.
#### Returns
```json
{
"is_valid": true,
"page_number": 0,
"source_page_number": 1,
"confirmation_message": "<div id='gform_confirmation_wrapper_6' class='gform_confirmation_wrapper '><div id='gform_confirmation_message_6' class='gform_confirmation_message_6 gform_confirmation_message'>Thanks for contacting us! We will get in touch with you shortly.<\/div><\/div>"
}
```
#### Optional Arguments
* **field_values** *[string]*
The field values.
* **source_page** *[string]*
The source page number.
* **target_page** *[string]*
The target page number.
------------------------------------------------------------------------------------------------------------------------
### GET /forms/[FORM_ID]/feeds
Returns the feeds for the specified form ID.
#### Path
https://localhost/wp-json/gf/v2/forms/1/feeds
#### Response
An array of feeds.
#### Optional URL Parameters
* **include** *[array]*
An array of feed IDs to include in the response. e.g. include[0]=1&include[1]=2
* **addon** *[string]*
The slug of a feed add-on.
------------------------------------------------------------------------------------------------------------------------
### POST /forms/[FORM_ID]/feeds
Adds a feed for the specified form ID.
#### Path
https://localhost/wp-json/gf/v2/forms/36/feeds
#### Response
The newly created feed.
#### Arguments
* **meta** *[object]*
The feed meta.
* **addon_slug** *[object]*
The add-on slug for the feed.
#### Optional URL Parameter
* **include** *[array]*
An array of feed IDs to include in the response. e.g. include[0]=1&include[1]=2
**Example Payload**
```json
{
"addon_slug": "gravityformstestaddon",
"meta": {
"textField": "My Value"
}
}
```
**Example Response**
```json
{
"addon_slug": "gravityformstestaddon",
"meta": {
"textField": "My Value"
},
"form_id": 36,
"id": 31
}
```
------------------------------------------------------------------------------------------------------------------------
### GET /feeds
Returns all the feeds optionally filtered by ID and/or add-on slug.
#### Path
https://localhost/wp-json/gf/v2/feeds
#### Response
An array of feeds.
#### Optional URL Parameters
* **include** *[array]*
An array of feed IDs to include in the response. e.g. include[0]=1&include[1]=2
* **addon** *[string]*
The slug of a feed add-on.
**Example Response**
```json
[
{
"id": "31",
"form_id": "36",
"addon_slug": "gravityformstestaddon",
"meta": {
"textField": "My Value"
}
}
]
```
------------------------------------------------------------------------------------------------------------------------
### POST /feeds
Adds a feed.
#### Path
https://localhost/wp-json/gf/v2/feeds
#### Response
The newly created feed.
#### Arguments
* **meta** *[object]*
The feed meta.
* **addon_slug** *[object]*
The add-on slug for the feed.
**Example Payload**
```json
{
"addon_slug": "gravityformstestaddon",
"meta": {
"textField": "My Value"
},
"form_id": 36
}
```
**Example Response**
```json
{
"id": "31",
"form_id": "36",
"addon_slug": "gravityformstestaddon",
"meta": {
"textField": "My Value"
}
}
```
------------------------------------------------------------------------------------------------------------------------
### PUT /feeds/[FEED ID]
Updates a feed.
#### Path
https://localhost/wp-json/gf/v2/feeds/34
#### Response
The updated feed.
#### Arguments
* **meta** *[object]*
The feed meta.
* **addon_slug** *[string]*
The add-on slug for the feed.
* **form_id** *[integer]*
The form ID for the feed.
**Example Payload**
```json
{
"addon_slug": "gravityformstestaddon",
"meta": {
"feedName": "My Value2"
},
"form_id": 36
}
```
**Example Response**
```json
{
"id": "34",
"form_id": "36",
"addon_slug": "gravityformstestaddon",
"meta": {
"feedName": "My Value2"
}
}
```
------------------------------------------------------------------------------------------------------------------------
### DELETE /feeds/[FEED ID]
Deleted a feed.
#### Path
https://localhost/wp-json/gf/v2/feeds/34
#### Response
The result and, if successful, the deleted feed.
**Example Response**
```json
{
"deleted": true,
"previous": {
"id": "34",
"form_id": "36",
"addon_slug": "gravityformstestaddon",
"meta": {
"feedName": "My Value2"
}
}
}
```