GlobalCube
/
analytics


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Interface: TransactionAPI</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Interface: TransactionAPI</h1>

    
<section>

<header>
    
        <h2>TransactionAPI</h2>
        
            <div class="class-description">API class that is used to control transactional behaviour during API usage.</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


            <h3>Example</h3>
            
    <pre class="prettyprint"><code>dashboard.getFeature('Transaction')</code></pre>

        
    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="endTransaction"><span class="type-signature"></span>endTransaction<span class="signature">(transactionToken)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Ends an existing API transaction.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>transactionToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">SetOptions</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


    <h4 class="name" id="getCurrentTransactionList"><span class="type-signature"></span>getCurrentTransactionList<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;SetOptions>}</span></h4>
    

<div class="description">
    Returns the list of currently active transaction tokens.
</div>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Array of all active transaction tokens
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;SetOptions></span>


    </dd>
</dl>

    
    <h4 class="name" id="getTransactionById"><span class="type-signature"></span>getTransactionById<span class="signature">()</span><span class="type-signature"> &rarr; {SetOptions}</span></h4>
    

<div class="description">
    Returns the transaction token from the specified unique transaction identifier.
</div>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    transactionToken
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">SetOptions</span>


    </dd>
</dl>

    
    <h4 class="name" id="isValidTransaction"><span class="type-signature"></span>isValidTransaction<span class="signature">(transactionToken)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Determines whether the token is a valid transaction.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>transactionToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">SetOptions</span>


            </td>

            
            <td class="description last">Transaction token</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


    <h4 class="name" id="registerTransactionHandler"><span class="type-signature"></span>registerTransactionHandler<span class="signature">(transactionToken, handlerId, handler, args)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
    

<div class="description">
    Registers an transaction handler for the existing API transaction.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>transactionToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">SetOptions</span>


            </td>

            
            <td class="description last">Transaction token</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>handlerId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Unique handler identifier</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>handler</code></td>
            

            <td class="type">
            
                
<span class="param-type">TransactionHandler</span>


            </td>

            
            <td class="description last">Handler to be executed when the transaction is complete</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Arguments to be passed to the TransactionHandler</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Returns a promise that is resolved once the handler is executed.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="startTransaction"><span class="type-signature"></span>startTransaction<span class="signature">(transactionToken<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {SetOptions}</span></h4>
    

<div class="description">
    Starts a new API transaction.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>transactionToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">SetOption</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Parent transaction token</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    transactionToken
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">SetOptions</span>


    </dd>
</dl>

    
    <h4 class="name" id="startTransactionById"><span class="type-signature"></span>startTransactionById<span class="signature">(transactionId)</span><span class="type-signature"> &rarr; {SetOptions}</span></h4>
    

<div class="description">
    Starts a new API transaction with the given transactionId.
Use <a href="TransactionAPI.html#startTransaction">TransactionAPI#startTransaction</a> unless a transactionId needs to be reused from a legacy transaction.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>transactionId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Unique transaction identifier</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    transactionToken
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">SetOptions</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AppFactory.html">AppFactory</a></li></ul><h3>Interfaces</h3><ul><li><a href="CanvasAPI.html">CanvasAPI</a></li><li><a href="ContentAPI.html">ContentAPI</a></li><li><a href="ContentStoreAPI.html">ContentStoreAPI</a></li><li><a href="DashboardCoreAPI.html">DashboardCoreAPI</a></li><li><a href="DashboardPreferencesAPI.html">DashboardPreferencesAPI</a></li><li><a href="DashboardSettingsAPI.html">DashboardSettingsAPI</a></li><li><a href="PropertiesAPI.html">PropertiesAPI</a></li><li><a href="RendererAPI.html">RendererAPI</a></li><li><a href="SaveAPI.html">SaveAPI</a></li><li><a href="SerializerAPI.html">SerializerAPI</a></li><li><a href="StateAPI.html">StateAPI</a></li><li><a href="TransactionAPI.html">TransactionAPI</a></li><li><a href="UserProfileAPI.html">UserProfileAPI</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 05 2022 17:56:07 GMT+0000 (UTC)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>