|
| 1 | +<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 | + <html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 | + <head> |
| 5 | + <!-- template designed by Marco Von Ballmoos --> |
| 6 | + <title>Docs For Class Services_Zencoder_Accounts</title> |
| 7 | + <link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 | + <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 | + </head> |
| 10 | + <body> |
| 11 | + <div class="page-body"> |
| 12 | +<h2 class="class-name">Class Services_Zencoder_Accounts</h2> |
| 13 | + |
| 14 | +<a name="sec-description"></a> |
| 15 | +<div class="info-box"> |
| 16 | + <div class="info-box-title">Description</div> |
| 17 | + <div class="nav-bar"> |
| 18 | + <span class="disabled">Description</span> | |
| 19 | + <a href="#sec-vars">Vars</a> |
| 20 | + | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 21 | + |
| 22 | + </div> |
| 23 | + <div class="info-box-body"> |
| 24 | + <!-- ========== Info from phpDoc block ========= --> |
| 25 | +<p class="short-description">Zencoder API client interface.</p> |
| 26 | + <ul class="tags"> |
| 27 | + <li><span class="field">author:</span> Michael Christopher <<a href="mailto:m@zencoder.com">m@zencoder.com</a>></li> |
| 28 | + <li><span class="field">version:</span> 2.0</li> |
| 29 | + <li><span class="field">link:</span> <a href="http://github.com/zencoder/zencoder-php">http://github.com/zencoder/zencoder-php</a></li> |
| 30 | + <li><span class="field">license:</span> <a href="http://creativecommons.org/licenses/MIT/MIT">http://creativecommons.org/licenses/MIT/MIT</a></li> |
| 31 | + </ul> |
| 32 | + <p class="notes"> |
| 33 | + Located in <a class="field" href="_Zencoder---Accounts.php.html">/Zencoder/Accounts.php</a> (line <span class="field">13</span>) |
| 34 | + </p> |
| 35 | + |
| 36 | + |
| 37 | + <pre><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a> |
| 38 | + | |
| 39 | + --Services_Zencoder_Accounts</pre> |
| 40 | + |
| 41 | + </div> |
| 42 | +</div> |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + <a name="sec-method-summary"></a> |
| 48 | + <div class="info-box"> |
| 49 | + <div class="info-box-title">Method Summary</span></div> |
| 50 | + <div class="nav-bar"> |
| 51 | + <a href="#sec-description">Description</a> | |
| 52 | + <a href="#sec-vars">Vars</a> |
| 53 | + |
| 54 | + | |
| 55 | + <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 56 | + </div> |
| 57 | + <div class="info-box-body"> |
| 58 | + <div class="method-summary"> |
| 59 | + |
| 60 | + <div class="method-definition"> |
| 61 | + <span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Account.html">Services_Zencoder_Account</a></span> |
| 62 | + <a href="#create" title="details" class="method-name">create</a> |
| 63 | + ([<span class="var-type">array</span> <span class="var-name">$account</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 64 | + </div> |
| 65 | + <div class="method-definition"> |
| 66 | + <span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Account.html">Services_Zencoder_Account</a></span> |
| 67 | + <a href="#details" title="details" class="method-name">details</a> |
| 68 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 69 | + </div> |
| 70 | + <div class="method-definition"> |
| 71 | + <span class="method-result">bool</span> |
| 72 | + <a href="#integration" title="details" class="method-name">integration</a> |
| 73 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 74 | + </div> |
| 75 | + <div class="method-definition"> |
| 76 | + <span class="method-result">bool</span> |
| 77 | + <a href="#live" title="details" class="method-name">live</a> |
| 78 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 79 | + </div> |
| 80 | + </div> |
| 81 | + </div> |
| 82 | + </div> |
| 83 | + |
| 84 | + <a name="sec-vars"></a> |
| 85 | + <div class="info-box"> |
| 86 | + <div class="info-box-title">Variables</div> |
| 87 | + <div class="nav-bar"> |
| 88 | + <a href="#sec-description">Description</a> | |
| 89 | + <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 90 | + |
| 91 | + |
| 92 | + | |
| 93 | + <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 94 | + |
| 95 | + </div> |
| 96 | + <div class="info-box-body"> |
| 97 | + <h4>Inherited Variables</h4> |
| 98 | + <A NAME='inherited_vars'><!-- --></A> |
| 99 | + <p>Inherited from <span class="classname"><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a></span></p> |
| 100 | + <blockquote> |
| 101 | + <span class="var-title"> |
| 102 | + <span class="var-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#var$proxy">Services_Zencoder_Base::$proxy</a></span><br> |
| 103 | + </span> |
| 104 | + </blockquote> |
| 105 | + |
| 106 | + </div> |
| 107 | + </div> |
| 108 | + |
| 109 | + <a name="sec-methods"></a> |
| 110 | + <div class="info-box"> |
| 111 | + <div class="info-box-title">Methods</div> |
| 112 | + <div class="nav-bar"> |
| 113 | + <a href="#sec-description">Description</a> | |
| 114 | + <a href="#sec-vars">Vars</a> |
| 115 | + <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 116 | + |
| 117 | + </div> |
| 118 | + <div class="info-box-body"> |
| 119 | + <A NAME='method_detail'></A> |
| 120 | + |
| 121 | +<a name="methodcreate" id="create"><!-- --></a> |
| 122 | +<div class="evenrow"> |
| 123 | + |
| 124 | + <div class="method-header"> |
| 125 | + <span class="method-title">create</span> (line <span class="line-number">22</span>) |
| 126 | + </div> |
| 127 | + |
| 128 | + <!-- ========== Info from phpDoc block ========= --> |
| 129 | +<p class="short-description">Create a Zencoder account</p> |
| 130 | + <ul class="tags"> |
| 131 | + <li><span class="field">return:</span> The object representation of the resource</li> |
| 132 | + <li><span class="field">access:</span> public</li> |
| 133 | + </ul> |
| 134 | + |
| 135 | + <div class="method-signature"> |
| 136 | + <span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Account.html">Services_Zencoder_Account</a></span> |
| 137 | + <span class="method-name"> |
| 138 | + create |
| 139 | + </span> |
| 140 | + ([<span class="var-type">array</span> <span class="var-name">$account</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 141 | + </div> |
| 142 | + |
| 143 | + <ul class="parameters"> |
| 144 | + <li> |
| 145 | + <span class="var-type">array</span> |
| 146 | + <span class="var-name">$account</span><span class="var-description">: Array of attributes to use when creating the account</span> </li> |
| 147 | + <li> |
| 148 | + <span class="var-type">array</span> |
| 149 | + <span class="var-name">$params</span><span class="var-description">: Optional overrides</span> </li> |
| 150 | + </ul> |
| 151 | + |
| 152 | + |
| 153 | + </div> |
| 154 | +<a name="methoddetails" id="details"><!-- --></a> |
| 155 | +<div class="oddrow"> |
| 156 | + |
| 157 | + <div class="method-header"> |
| 158 | + <span class="method-title">details</span> (line <span class="line-number">41</span>) |
| 159 | + </div> |
| 160 | + |
| 161 | + <!-- ========== Info from phpDoc block ========= --> |
| 162 | +<p class="short-description">Return details of your Zencoder account</p> |
| 163 | + <ul class="tags"> |
| 164 | + <li><span class="field">return:</span> The object representation of the resource</li> |
| 165 | + <li><span class="field">access:</span> public</li> |
| 166 | + </ul> |
| 167 | + |
| 168 | + <div class="method-signature"> |
| 169 | + <span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Account.html">Services_Zencoder_Account</a></span> |
| 170 | + <span class="method-name"> |
| 171 | + details |
| 172 | + </span> |
| 173 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 174 | + </div> |
| 175 | + |
| 176 | + <ul class="parameters"> |
| 177 | + <li> |
| 178 | + <span class="var-type">array</span> |
| 179 | + <span class="var-name">$params</span><span class="var-description">: Optional overrides</span> </li> |
| 180 | + </ul> |
| 181 | + |
| 182 | + |
| 183 | + </div> |
| 184 | +<a name="methodintegration" id="integration"><!-- --></a> |
| 185 | +<div class="evenrow"> |
| 186 | + |
| 187 | + <div class="method-header"> |
| 188 | + <span class="method-title">integration</span> (line <span class="line-number">52</span>) |
| 189 | + </div> |
| 190 | + |
| 191 | + <!-- ========== Info from phpDoc block ========= --> |
| 192 | +<p class="short-description">Put your account into integration mode</p> |
| 193 | + <ul class="tags"> |
| 194 | + <li><span class="field">return:</span> If the operation was successful</li> |
| 195 | + <li><span class="field">access:</span> public</li> |
| 196 | + </ul> |
| 197 | + |
| 198 | + <div class="method-signature"> |
| 199 | + <span class="method-result">bool</span> |
| 200 | + <span class="method-name"> |
| 201 | + integration |
| 202 | + </span> |
| 203 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 204 | + </div> |
| 205 | + |
| 206 | + <ul class="parameters"> |
| 207 | + <li> |
| 208 | + <span class="var-type">array</span> |
| 209 | + <span class="var-name">$params</span><span class="var-description">: Optional overrides</span> </li> |
| 210 | + </ul> |
| 211 | + |
| 212 | + |
| 213 | + </div> |
| 214 | +<a name="methodlive" id="live"><!-- --></a> |
| 215 | +<div class="oddrow"> |
| 216 | + |
| 217 | + <div class="method-header"> |
| 218 | + <span class="method-title">live</span> (line <span class="line-number">63</span>) |
| 219 | + </div> |
| 220 | + |
| 221 | + <!-- ========== Info from phpDoc block ========= --> |
| 222 | +<p class="short-description">Put your account into live mode</p> |
| 223 | + <ul class="tags"> |
| 224 | + <li><span class="field">return:</span> If the operation was successful</li> |
| 225 | + <li><span class="field">access:</span> public</li> |
| 226 | + </ul> |
| 227 | + |
| 228 | + <div class="method-signature"> |
| 229 | + <span class="method-result">bool</span> |
| 230 | + <span class="method-name"> |
| 231 | + live |
| 232 | + </span> |
| 233 | + ([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>]) |
| 234 | + </div> |
| 235 | + |
| 236 | + <ul class="parameters"> |
| 237 | + <li> |
| 238 | + <span class="var-type">array</span> |
| 239 | + <span class="var-name">$params</span><span class="var-description">: Optional overrides</span> </li> |
| 240 | + </ul> |
| 241 | + |
| 242 | + |
| 243 | + </div> |
| 244 | + <h4>Inherited Methods</h4> |
| 245 | + <a name='inherited_methods'><!-- --></a> |
| 246 | + <!-- =========== Summary =========== --> |
| 247 | + <p>Inherited From <span class="classname"><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a></span></p> |
| 248 | + <blockquote> |
| 249 | + <span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#method__construct">Services_Zencoder_Base::__construct()</a></span><br> |
| 250 | + <span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodcreateData">Services_Zencoder_Base::createData()</a></span><br> |
| 251 | + <span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methoddeleteData">Services_Zencoder_Base::deleteData()</a></span><br> |
| 252 | + <span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodretrieveData">Services_Zencoder_Base::retrieveData()</a></span><br> |
| 253 | + <span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodupdateData">Services_Zencoder_Base::updateData()</a></span><br> |
| 254 | + </blockquote> |
| 255 | + |
| 256 | + </div> |
| 257 | + </div> |
| 258 | + |
| 259 | + |
| 260 | + <p class="notes" id="credit"> |
| 261 | + Documentation generated on Mon, 02 Jan 2012 16:55:50 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a> |
| 262 | + </p> |
| 263 | + </div></body> |
| 264 | +</html> |
0 commit comments