aboutsummaryrefslogtreecommitdiff
path: root/subsonic-site/src/main/webapp/api-updateShare.jsp
blob: 8523ef3017a18ed7442f87500dd7c9795a731d77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<h2 class="div"><a name="updateShare"></a>updateShare</h2>
<p>
    <code>http://your-server/rest/updateShare.view</code>
    <br>Since <a href="#versions">1.6.0</a>
</p>
<p>
    Updates the description and/or expiration date for an existing share.
</p>
<table width="100%" class="bottomspace">
    <tr>
        <th class="param-heading">Parameter</th>
        <th class="param-heading">Required</th>
        <th class="param-heading">Default</th>
        <th class="param-heading">Comment</th>
    </tr>
    <tr class="table-altrow">
        <td><code>id</code></td>
        <td>Yes</td>
        <td></td>
        <td>ID of the share to update.</td>
    </tr>
    <tr>
        <td><code>description</code></td>
        <td>No</td>
        <td></td>
        <td>A user-defined description that will be displayed to people visiting the shared media.</td>
    </tr>
    <tr class="table-altrow">
        <td><code>expires</code></td>
        <td>No</td>
        <td></td>
        <td>The time at which the share expires. Given as milliseconds since 1970, or zero to remove the expiration.</td>
    </tr>
</table>
<p>
    Returns an empty <code>&lt;subsonic-response&gt;</code> element on success.
</p>