Nextcloud PHP API (master)

Support

Table of Contents

Namespaces

CrashReport
Subscription
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
            <title>Nextcloud PHP API (master)</title>
    
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <base href="./">
    <link rel="icon" href="images/favicon.ico"/>
    <link rel="stylesheet" href="css/normalize.css">
    <link rel="stylesheet" href="css/base.css">
            <link rel="preconnect" href="https://fonts.gstatic.com">
        <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
        <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
        <link rel="stylesheet" href="css/template.css">
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
                <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
        <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
        <script src="js/template.js"></script>
        <script src="js/search.js"></script>
        <script defer src="js/searchIndex.js"></script>
    </head>
<body id="top">
    <header class="phpdocumentor-header phpdocumentor-section">
    <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Nextcloud PHP API (master)</a></h1>
    <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
    <label class="phpdocumentor-header__menu-icon" for="menu-button">
        <i class="fas fa-bars"></i>
    </label>
    <section data-search-form class="phpdocumentor-search">
    <label>
        <span class="visually-hidden">Search for</span>
        <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
            <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
            <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
        </svg>
        <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
    </label>
</section>

    <nav class="phpdocumentor-topnav">
    <ul class="phpdocumentor-topnav__menu">
        </ul>
</nav>
</header>

    <main class="phpdocumentor">
        <div class="phpdocumentor-section">
            <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
    Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
                    <section class="phpdocumentor-sidebar__category -namespaces">
            <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
                                    <h4 class="phpdocumentor-sidebar__root-namespace">
    <a class href='/namespaces/ocp'>OCP</a>
</h4>
    <ul class="phpdocumentor-list">
                    <li>
                <a class href='/namespaces/ocp-accounts'>Accounts</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-activity'>Activity</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-app'>App</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-appframework'>AppFramework</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-authentication'>Authentication</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-backgroundjob'>BackgroundJob</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-broadcast'>Broadcast</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-cache'>Cache</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-calendar'>Calendar</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-capabilities'>Capabilities</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-collaboration'>Collaboration</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-command'>Command</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-comments'>Comments</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-common'>Common</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-config'>Config</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-console'>Console</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-contacts'>Contacts</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-dashboard'>Dashboard</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-datacollector'>DataCollector</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-db'>DB</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-diagnostics'>Diagnostics</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-directediting'>DirectEditing</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-encryption'>Encryption</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-eventdispatcher'>EventDispatcher</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-exceptions'>Exceptions</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-federation'>Federation</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-files'>Files</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-files-fulltextsearch'>Files_FullTextSearch</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-filesmetadata'>FilesMetadata</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-fulltextsearch'>FullTextSearch</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-globalscale'>GlobalScale</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-group'>Group</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-http'>Http</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-l10n'>L10N</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-ldap'>LDAP</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-lock'>Lock</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-lockdown'>Lockdown</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-log'>Log</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-mail'>Mail</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-migration'>Migration</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-navigation'>Navigation</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-notification'>Notification</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-ocm'>OCM</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-ocs'>OCS</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-preview'>Preview</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-profile'>Profile</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-profiler'>Profiler</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-remote'>Remote</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-richobjectstrings'>RichObjectStrings</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-route'>Route</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-search'>Search</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-security'>Security</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-session'>Session</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-settings'>Settings</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-setupcheck'>SetupCheck</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-share'>Share</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-speechtotext'>SpeechToText</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-support'>Support</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-systemtag'>SystemTag</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-talk'>Talk</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-taskprocessing'>TaskProcessing</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-teams'>Teams</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-template'>Template</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-textprocessing'>TextProcessing</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-texttoimage'>TextToImage</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-translation'>Translation</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-user'>User</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-usermigration'>UserMigration</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-userstatus'>UserStatus</a>
                
            </li>
                    <li>
                <a class href='/namespaces/ocp-workflowengine'>WorkflowEngine</a>
                
            </li>
            </ul>

                        </section>
                <section class="phpdocumentor-sidebar__category -packages">
            <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
                                    <h4 class="phpdocumentor-sidebar__root-namespace">
    <a class href='/packages/application'>Application</a>
</h4>

                                    <h4 class="phpdocumentor-sidebar__root-namespace">
    <a class href='/packages/ocp'>OCP</a>
</h4>
    <ul class="phpdocumentor-list">
                    <li>
                <a class href='/packages/ocp-accounts'>Accounts</a>
                
            </li>
                    <li>
                <a class href='/packages/ocp-security'>Security</a>
                
            </li>
                    <li>
                <a class href='/packages/ocp-share'>Share</a>
                
            </li>
            </ul>

                                    <h4 class="phpdocumentor-sidebar__root-namespace">
    <a class href='/packages/oc'>OC</a>
</h4>
    <ul class="phpdocumentor-list">
                    <li>
                <a class href='/packages/oc-security'>Security</a>
                
            </li>
            </ul>

                        </section>
            
    <section class="phpdocumentor-sidebar__category -reports">
        <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
                <h3 class="phpdocumentor-sidebar__root-package"><a href='/reports/deprecated'>Deprecated</a></h3>
        <h3 class="phpdocumentor-sidebar__root-package"><a href='/reports/errors'>Errors</a></h3>
        <h3 class="phpdocumentor-sidebar__root-package"><a href='/reports/markers'>Markers</a></h3>
    </section>

    <section class="phpdocumentor-sidebar__category -indices">
        <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
        <h3 class="phpdocumentor-sidebar__root-package"><a href='/indices/files'>Files</a></h3>
    </section>
</aside>

            <div class="phpdocumentor-column -nine phpdocumentor-content">
                                        <section>
        <h2>Documentation</h2>

        
        
<h3 id="toc">
    Table of Contents
    <a class='headerlink' href='/namespaces/default#toc'><i class="fas fa-link"></i></a>

</h3>

<h4 id="packages">
    Packages
    <a class='headerlink' href='/namespaces/default#packages'><i class="fas fa-link"></i></a>

</h4>
<dl class="phpdocumentor-table-of-contents">
            <dt class="phpdocumentor-table-of-contents__entry -package"><a href='/packages/application'><abbr title="\Application">Application</abbr></a></dt>
            <dt class="phpdocumentor-table-of-contents__entry -package"><a href='/packages/ocp'><abbr title="\OCP">OCP</abbr></a></dt>
            <dt class="phpdocumentor-table-of-contents__entry -package"><a href='/packages/oc'><abbr title="\OC">OC</abbr></a></dt>
    </dl>

<h4 id="namespaces">
    Namespaces
    <a class='headerlink' href='/namespaces/default#namespaces'><i class="fas fa-link"></i></a>

</h4>
<dl class="phpdocumentor-table-of-contents">
            <dt class="phpdocumentor-table-of-contents__entry -namespace"><a href='/namespaces/ocp'><abbr title="\OCP">OCP</abbr></a></dt>
    </dl>










        

        
    </section>
                            </div>
            <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
    <section class="phpdocumentor-search-results__dialog">
        <header class="phpdocumentor-search-results__header">
            <h2 class="phpdocumentor-search-results__title">Search results</h2>
            <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
        </header>
        <section class="phpdocumentor-search-results__body">
            <ul class="phpdocumentor-search-results__entries"></ul>
        </section>
    </section>
</section>
        </div>
        <a class='phpdocumentor-back-to-top' href='/#top'><i class="fas fa-chevron-circle-up"></i></a>

    </main>

    <script>
        cssVars({});
    </script>
    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
On this page
  • Table Of Contents

Search results