markgojs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GoOneDrive | GoCloudStorage API</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../../assets/css/bootstrap.min.css"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header>  <nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top"> <div class="container-fluid"> <div class="navbar-header"> <div class="navheader-container"> <div class="navheader-collapse" data-toggle="collapse" data-target="#navbar"> <a id="toplogo" class="navbar-brand" href="../../../index.html">GoJS</a> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> </div> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="../../../index.html">Home</a></li> <li><a href="../../../learn/index.html">Learn</a></li> <li><a href="../../../samples/index.html">Samples</a></li> <li><a href="../../../intro/index.html">Intro</a></li> <li><a href="../../../api/index.html" target="api">API</a></li> <li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li> <li><a href="../../../download.html">Download</a></li> <li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li> <li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li> <li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li> <li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li> </ul> </div> </div> </nav> <div class="tsd-page-header"> <div class="tsd-page-toolbar"> <div class="container-fluid plr15"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">GoCloudStorage API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container-fluid plr15"> <div class="top-copyright">  GoCloudStorage<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a> </div> <div> <h1>Class GoOneDrive</h1> </div> </div> </div> </div> </header> <div class="container-fluid container-main plr15"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="GoCloudStorage.html" class="tsd-signature-type">GoCloudStorage</a> <ul class="tsd-hierarchy"> <li> <span class="target">GoOneDrive</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>Class for saving / loading GoJS <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagram</a> <a href="https://gojs.net/latest/api/symbols/Model.html">models</a> to / from Microsoft One Drive. As with all <a href="GoCloudStorage.html">GoCloudStorage</a> subclasses (with the exception of <a href="GoLocalStorage.html">GoLocalStorage</a>, any page using GoDropBox must be served on a web server.</p> <p><b>Note</b>: Makes use of <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">OneDrive FilePicker for JavaScript v7.2</a>. Any page using GoOneDrive must include a script tag with src set to <a href="https://js.live.net/v7.2/OneDrive.js">https://js.live.net/v7.2/OneDrive.js</a>. </p> </div> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#className" class="tsd-kind-icon">class<wbr>Name</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#currentDiagramFile" class="tsd-kind-icon">current<wbr>Diagram<wbr>File</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#defaultModel" class="tsd-kind-icon">default<wbr>Model</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#iconsRelativeDirectory" class="tsd-kind-icon">icons<wbr>Relative<wbr>Directory</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#isAutoSaving" class="tsd-kind-icon">is<wbr>Auto<wbr>Saving</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#managedDiagrams" class="tsd-kind-icon">managed<wbr>Diagrams</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="GoOneDrive.html#oauthToken" class="tsd-kind-icon">oauth<wbr>Token</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="GoOneDrive.html#oneDriveFilepicker" class="tsd-kind-icon">one<wbr>Drive<wbr>Filepicker</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#serviceName" class="tsd-kind-icon">service<wbr>Name</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#ui" class="tsd-kind-icon">ui</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#authorize" class="tsd-kind-icon">authorize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#checkFileExists" class="tsd-kind-icon">check<wbr>File<wbr>Exists</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#create" class="tsd-kind-icon">create</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="GoOneDrive.html#generateGraphUrl" class="tsd-kind-icon">generate<wbr>Graph<wbr>Url</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#getFile" class="tsd-kind-icon">get<wbr>File</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#getUserInfo" class="tsd-kind-icon">get<wbr>User<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GoOneDrive.html#hideUI" class="tsd-kind-icon">hideUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#load" class="tsd-kind-icon">load</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#loadWithUI" class="tsd-kind-icon">load<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#remove" class="tsd-kind-icon">remove</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#removeWithUI" class="tsd-kind-icon">remove<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#save" class="tsd-kind-icon">save</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#saveWithUI" class="tsd-kind-icon">save<wbr>WithUI</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GoOneDrive.html#showUI" class="tsd-kind-icon">showUI</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3> constructor </h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>GoOne<wbr>Drive<span class="tsd-signature-symbol">(</span>managedDiagrams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span>, clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultModel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, iconsRelativeDirectory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GoOneDrive.html" class="tsd-signature-type">GoOneDrive</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>managedDiagrams: <span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>An array of GoJS <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagrams</a> whose model(s) will be saved to / loaded from OneDrive. Can also be a single Diagram.</p> </div> </li> <li> <h5>clientId: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The client ID of the application in use (given by Microsoft in Microsoft Dev Center)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultModel: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>String representation of the default model data for new diagrams. If this is null, default new diagrams will be empty. Usually a value given by calling <a href="https://gojs.net/latest/api/symbols/Model.html#toJson">.toJson()</a> on a GoJS Diagram's Model.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> iconsRelativeDirectory: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The directory path relative to the page in which this instance of GoOneDrive exists, in which the storage service brand icons can be found. The default value is "../goCloudStorageIcons/".</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="GoOneDrive.html" class="tsd-signature-type">GoOneDrive</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="className" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> class<wbr>Name <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the name of the class; i.e. "GoDropbox"</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="clientId" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> client<wbr>Id <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the clientId for the app using the cloud storage service. This is usually given by the cloud storage provider's dev console or similar. Set with a parameter during construction.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="currentDiagramFile" class="tsd-anchor"></a> <h3> current<wbr>Diagram<wbr>File <span class="tsd-signature-symbol">: </span><a href="DiagramFile.html" class="tsd-signature-type">DiagramFile</a> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get or set the currently open <a href="DiagramFile.html">DiagramFile</a>. By default, currentDiagramFile is set when a file is loaded from storage, saved to storage (if saved to a different path from the currentDiagramFile.path), or deleted from storage (if the deleted file is the currently open one). The default value is a <a href="DiagramFile.html">DiagramFile</a> with null id, name, and path values.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="defaultModel" class="tsd-anchor"></a> <h3> default<wbr>Model <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set the defaultModel data for the app used by an instance of GoCloudStorage. defaultModel is used when creating new diagrams. See <a href="GoOneDrive.html#create">create</a>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="iconsRelativeDirectory" class="tsd-anchor"></a> <h3> icons<wbr>Relative<wbr>Directory <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set iconsRelativeDirectory, the directory path relative to the page in which this instance of GoCloudStorage exists, in which the storage service brand icons can be found. The default value is "../goCloudStorageIcons/".</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="isAutoSaving" class="tsd-anchor"></a> <h3> is<wbr>Auto<wbr>Saving <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get or set isAutoSaving property. If true, the <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a> will be saved to storage after every <a href="https://gojs.net/latest/api/symbols/Transaction.html"> Transaction</a> (only if <a href="GoOneDrive.html#currentDiagramFile">currentDiagramFile</a> holds a non-null path value). Additionally, if isAutoSaving is true, users will be prompted to save newly created diagrams when created with <a href="GoOneDrive.html#create">create</a>. The default value for isAutoSaving is <code>true</code>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="managedDiagrams" class="tsd-anchor"></a> <h3> managed<wbr>Diagrams <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Diagram</span><span class="tsd-signature-symbol">[]</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set the GoJS <a href="https://gojs.net/latest/api/symbols/Diagram.html">Diagram</a>s associated with this instance of GoCloudStorage. Set with a parameter during construction.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="oauthToken" class="tsd-anchor"></a> <h3> oauth<wbr>Token <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get / set the global oauthToken. Only used to authorize requests in <a href="GoOneDrive.html#load">load</a>, <a href="GoOneDrive.html#save">save</a>, and <a href="GoOneDrive.html#remove">remove</a> when the <a href="GoOneDrive.html#oneDriveFilepicker">oneDriveFilepicker</a> property is not used. Not needed when the oneDriveFilePicker is used, as action-specific tokens (issued by the Microsoft-provided <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">OneDrive Filepicker</a>) are issued then. oauthToken is null after construction, but can be set or refreshed with calls to <a href="GoOneDrive.html#authorize">authorize</a>.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="oneDriveFilepicker" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> one<wbr>Drive<wbr>Filepicker <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">OneDrive Filepicker</a> object. Used to display a Microsoft user's OneDrive files.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="serviceName" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> service<wbr>Name <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the name of the cloud storage service being used; i.e. "Dropbox"</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="ui" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagReadOnly">Read-only</span> ui <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the UI element associated with this instance of GoCloudStorage. This is a custom filepicker window for <a href="GoDropBox.html">GoDropBox</a> and <a href="GoLocalStorage.html">GoLocalStorage</a>. It is a save prompt for <a href="GoOneDrive.html">GoOneDrive</a> and <a href="GoGoogleDrive.html">GoGoogleDrive</a> (both these classes use third party UI for storage navigation, provided by Microsoft and Google, respectively). The UI element is created during construction.</p> </div> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="authorize" class="tsd-anchor"></a> <h3> authorize </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">authorize<span class="tsd-signature-symbol">(</span>refreshToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get OAuth 2.0 token for Microsoft OneDrive API requests with a specific Microsoft account. Sets <a href="GoOneDrive.html#oauthToken">oauthToken</a>.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> refreshToken: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>Whether to get a new access token (triggers a page redirect) (true) or try to find / use the one in the browser window URI (no redirect) (false)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a boolean stating whether authorization was succesful (true) or failed (false).</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="checkFileExists" class="tsd-anchor"></a> <h3> check<wbr>File<wbr>Exists </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">check<wbr>File<wbr>Exists<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Check whether a file exists at a given path.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid MS OneDrive filepath to save current diagram model to Path must be of the form: /drive/root:/{item-path}</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a boolean stating whether a file exists at a given path</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="create" class="tsd-anchor"></a> <h3> create </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Set each of <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a>' .model to <a href="GoOneDrive.html#defaultModel">defaultModel</a> (if defaultModel is null, each model will be set to a new <a href="https://gojs.net/latest/api/symbols/GraphLinksModel.html">GraphLinksModel</a> by default). If <a href="GoOneDrive.html#isAutoSaving">isAutoSaving</a> is true and no path parameter is supplied, users will be immediately prompted to save their new diagrams to cloud storage.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>If a valid filepath is supplied, save each of <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a>' model data to this path. No UI of any sort appears. What is meant by "valid filepath" varies from subclass to subclass. Rules for valid filepaths by subclass:</p> <ul> <li><a href="GoLocalStorage.html">GoLocalStorage</a>: Just the filename (the key in local storage); i.e. <code>example.diagram</code></li> <li><a href="GoDropBox.html">GoDropBox</a>: <code>/{path-to-file}/{filename}</code>; i.e. <code>/Public/example.diagram</code></li> <li><a href="GoGoogleDrive.html">GoGoogleDrive</a>: Use Google Drive-given file IDs. Parameter is still called 'path' in GoGoogleDrive methods to preserve system nomenclature.</li> <li><a href="GoOneDrive.html">GoOneDrive</a>: <code>/drive/root:/{path-to-file}/{filename}</code>; i.e. <code>/drive/root:/Documents/example.diagram</code></li> </ul> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the newly created file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="generateGraphUrl" class="tsd-anchor"></a> <h3> generate<wbr>Graph<wbr>Url </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">generate<wbr>Graph<wbr>Url<span class="tsd-signature-symbol">(</span>driveItem<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span>, targetParentFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, itemRelativeApiPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Generate and return a Microsoft Graph URL for a target item</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>driveItem: <span class="tsd-signature-type">Object</span></h5> <div class="tsd-comment tsd-typography"> <p>The item to generate the URL for</p> </div> </li> <li> <h5>targetParentFolder: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>Indicates whether to target the parent folder + filename instead of the item itself</p> </div> </li> <li> <h5>itemRelativeApiPath: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>Indicates whether to append /content to the item URL</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>Returns a Microsoft Graph URL for a target item</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="getFile" class="tsd-anchor"></a> <h3> get<wbr>File </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">get<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get the OneDrive file reference object at a given path. Properties of particular note include:</p> <ul> <li>name: The name of the file in OneDrive</li> <li>id: The OneDrive-given file ID<li> <li>parentReference <ul> <li>path: The path of the parent folder of the file at the provided path</li> </ul> </li> <ul> <p><b>Note:</b> Name, ID, and path are requisite for creating valid <a href="DiagramFile.html">DiagramFile</a>s. A path can be constructed by concatenating the parentReference.path with name. DiagramFiles optionally also contain parentReference and token values (both used exclusively by GoOneDrive and its methods).</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid MS OneDrive filepath to save current diagram model to Path must be of the form: /drive/root:/{item-path}</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Optional: A token received by OneDrive filepicker (loadDiagramWithUI) to allow for its file to be loaded. If no token is given, use global oauthToken</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a OneDrive file reference object at a given path</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="getUserInfo" class="tsd-anchor"></a> <h3> get<wbr>User<wbr>Info </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Get information about the currently logged in Microsoft user. Some fields of particular note include:</p> <p><ul> <li>displayName</li> <li>givenName</li> <li>id</li> <li>jobTitle</li> <li>userPrincipalName (email)</li> </ul></p> <p><b>Note:</b> If <a href="GoOneDrive.html#oauthToken">oauthToken</a> is not valid or has expired, a page redirect to the Microsoft Account sign in will occur.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with information about the currently logged in Microsoft user</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="hideUI" class="tsd-anchor"></a> <h3> hideUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">hideUI<span class="tsd-signature-symbol">(</span>isActionCanceled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Hide the <a href="GoOneDrive.html#ui">ui</a> element associated with this instance of GoCloudStorage. Used in some UI element onclicks.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> isActionCanceled: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p>If action (save, delete, load) is canceled, resolve Promise (returned previously in <a href="GoOneDrive.html#showUI">showUI</a>) with a 'Canceled' notification. Default value is false.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="load" class="tsd-anchor"></a> <h3> load </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Load the contents of a saved diagram from MS OneDrive to diagram model.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid Microsoft OneDrive filepath to load diagram model data from. Path syntax is <code>/drive/root:/{path-to-file}/{filename}</code>; i.e. <code>/drive/root:/Documents/example.diagram</code></p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A token received by <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">OneDrive Filepicker</a> (passed from <a href="GoOneDrive.html#loadWithUI">loadWithUI</a>) to allow for its file to be loaded. If no token is given, use global <a href="GoOneDrive.html#oauthToken">oauthToken</a></p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the loaded file</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="loadWithUI" class="tsd-anchor"></a> <h3> load<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">load<wbr>WithUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Load diagram model data from a given OneDrive-specific file path into <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a> using the MS OneDrive filepicker.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the loaded file</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="remove" class="tsd-anchor"></a> <h3> remove </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Delete a diagram from a user's OneDrive at a given path.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid Microsoft OneDrive filepath to delete. Path syntax is <code>/drive/root:/{path-to-file}/{filename}</code>; i.e. <code>/drive/root:/Documents/example.diagram</code></p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A token received by OneDrive filepicker (passed from <a href="GoOneDrive.html#removeWithUI">removeWithUI</a>) to allow for its file to be deleted. If no token is given, use global <a href="GoOneDrive.html#oauthToken">oauthToken</a></p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the deleted file</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="removeWithUI" class="tsd-anchor"></a> <h3> remove<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">remove<wbr>WithUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Delete a diagram from a user's OneDrive using the <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">OneDrive Filepicker</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the deleted file</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="save" class="tsd-anchor"></a> <h3> save </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">save<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Save <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a>' model data to Microsoft OneDrive. If path is supplied save to that path. If no path is supplied but <a href="GoOneDrive.html#currentDiagramFile">currentDiagramFile</a> has non-null, valid properties, update saved diagram file content at the path in OneDrive corresponding to currentDiagramFile.path with current managedDiagrams' model data.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A valid MS OneDrive filepath to save current diagram model to. Path syntax is <code>/drive/root:/{path-to-file}/{filename}</code>; i.e. <code>/drive/root:/Documents/example.diagram</code></p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the saved file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="saveWithUI" class="tsd-anchor"></a> <h3> save<wbr>WithUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">save<wbr>WithUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Save the each <a href="GoOneDrive.html#managedDiagrams">managedDiagrams</a>' model data to a user's One Drive account, using <a href="https://dev.onedrive.com/sdk/js-v72/js-picker-overview.htm">One Drive FilePicker</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a Promise that resolves with a <a href="DiagramFile.html">DiagramFile</a> representing the saved file.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="showUI" class="tsd-anchor"></a> <h3> showUI </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">showUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Show the custom GoOneDrive save prompt <a href="GoOneDrive.html#ui">ui</a>.</p> </div> <h4 class="tsd-returns-title">Retu