Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-10-18 16:41:18 +02:00
Code Issues Projects Releases Wiki Activity

2020-09-17 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Added an 'RDUser::feedAuthorized()' method.
	* Added a 'SavePodcast' method to the Web API.
	* Added a 'GetPodcast' method to the Web API.
	* Added a 'DeletePodcast' method to the Web API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
2020-09-17 16:19:26 -04:00
parent 288b7a9826
commit 6516c20ff6
13 changed files with 559 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

200
docs/apis/web_api.xml
View File

@@ -831,6 +831,68 @@
</table>
</sect1>
<sect1>
<title>DeletePodcast</title>
<subtitle>Delete posted podcast audio from the audio store</subtitle>
<para>
Command Code: <code>RDXPORT_COMMAND_DELETE_PODCAST</code>
</para>
<para>
Required User Permissions: <code>Delete Podcast</code>, Feed Permission
</para>
<para>
A <computeroutput>404</computeroutput> error will be returned if the
requested podcast's parent feed is not authorized for the specified
Rivendell user in RDAdmin->ManageUsers->PodcastFeedPermissions.
</para>
<table xml:id="ex.delete_podcast
" frame="all">
<title>GetPodcast Call Fields</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="FIELD NAME" />
<colspec colname="MEANING" />
<colspec colname="REMARKS" />
<thead>
<row>
<entry>
FIELD NAME
</entry>
<entry>
MEANING
</entry>
<entry>
REMARKS
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
COMMAND
</entry>
<entry>
39
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
ID
</entry>
<entry>
ID of podcast item (integer)
</entry>
<entry>
Mandatory
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1>
<title>EditCart</title>
<subtitle>
@@ -1717,6 +1779,68 @@
</table>
</sect1>
<sect1>
<title>GetPodcast</title>
<subtitle>Get posted podcast audio</subtitle>
<para>
Command Code: <code>RDXPORT_COMMAND_GET_PODCAST</code>
</para>
<para>
Required User Permissions: <code>Edit Podcast</code>, Feed Permission
</para>
<para>
A <computeroutput>404</computeroutput> error will be returned if the
requested podcast's parent feed is not authorized for the specified
Rivendell user in RDAdmin->ManageUsers->PodcastFeedPermissions.
</para>
<table xml:id="ex.get_podcast
" frame="all">
<title>GetPodcast Call Fields</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="FIELD NAME" />
<colspec colname="MEANING" />
<colspec colname="REMARKS" />
<thead>
<row>
<entry>
FIELD NAME
</entry>
<entry>
MEANING
</entry>
<entry>
REMARKS
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
COMMAND
</entry>
<entry>
37
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
ID
</entry>
<entry>
ID of podcast item (integer)
</entry>
<entry>
Mandatory
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1>
<title>Import</title>
<subtitle>Import audio data into the audio store</subtitle>
@@ -3526,6 +3650,82 @@
</table>
</sect1>
<sect1>
<title>SavePodcast</title>
<subtitle>Save posted podcast audio</subtitle>
<para>
Command Code: <code>RDXPORT_COMMAND_SAVE_PODCAST</code>
</para>
<para>
Required User Permissions: <code>Create Podcast</code>, Feed Permission
</para>
<para>
A <computeroutput>404</computeroutput> error will be returned if the
requested podcast's parent feed is not authorized for the specified
Rivendell user in RDAdmin->ManageUsers->PodcastFeedPermissions.
</para>
<para>
NOTE: The method must be called with 'multipart/form-data' encoding.
</para>
<table xml:id="ex.save_podcast
" frame="all">
<title>SavePodcast Call Fields</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="FIELD NAME" />
<colspec colname="MEANING" />
<colspec colname="REMARKS" />
<thead>
<row>
<entry>
FIELD NAME
</entry>
<entry>
MEANING
</entry>
<entry>
REMARKS
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
COMMAND
</entry>
<entry>
38
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
ID
</entry>
<entry>
ID of podcast (integer)
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
FILENAME
</entry>
<entry>
Binary file data
</entry>
<entry>
Mandatory
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1>
<title>SaveString</title>
<subtitle>