1
0
mirror of https://github.com/RipMeApp/ripme.git synced 2025-08-20 04:31:55 +02:00

Added some documention for getAlbumsToQueue, pageContainsAlbums and hasQueueSupport

cyian-1756
2018-06-30 21:34:38 -04:00
parent 45ec07ef4d
commit 1489f26353

@@ -202,6 +202,25 @@ If this function returns true then ripme does not call addURLToDownload and does
For an example of a ripper which rips like this see the [8muses ripper](https://github.com/ripmeapp/ripme/blob/master/src/main/java/com/rarchives/ripme/ripper/rippers/EightmusesRipper.java)
#### boolean hasQueueSupport() // Optional!
Note: This has nothing to do with support for ripmes download Queue. This has to do with a ripper which adds new albums to ripmes download Queue. Rippers without this override can still have links for site they support added to the download Queue by the user.
This denotes whether or not a ripper has support for QuickQueuing (Adding new albums to ripmes download Queue as if a user had entered it into the rip textbox and then pressed rip)
#### boolean pageContainsAlbums(URL url) // Optional!
If this function returns true then ripme expects nothing on the paged to be ripped, but instead to add links from the page to ripmes download queue. If you over ride this you must also override hasQueueSupport and getAlbumsToQueue
#### List\<String\> getAlbumsToQueue(Document doc) // Optional!
Input: The Document returned by getFirstPage()
Returns: A list of urls that will be added to the download Queue to be ripped
This is very useful when you want your ripper to be able to support subalbums.
For an example of a ripper which uses these functions see the [Myhentaicomics ripper](https://github.com/RipMeApp/ripme/blob/master/src/main/java/com/rarchives/ripme/ripper/rippers/MyhentaicomicsRipper.java)
### Step 6: Test!
RipMe **automatically detects new rippers** without any other code changes required.