Skip to content

Latest commit

 

History

History

mangadex

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
api
api
 
 
internal
internal
 
 
storage
storage
 
 
README.md
README.md
 
 
api.rb
api.rb
 
 
artist.rb
artist.rb
 
 
at_home.rb
at_home.rb
 
 
auth.rb
auth.rb
 
 
author.rb
author.rb
 
 
chapter.rb
chapter.rb
 
 
chapter_read_marker.rb
chapter_read_marker.rb
 
 
content_rating.rb
content_rating.rb
 
 
cover_art.rb
cover_art.rb
 
 
custom_list.rb
custom_list.rb
 
 
internal.rb
internal.rb
 
 
manga.rb
manga.rb
 
 
mangadex_object.rb
mangadex_object.rb
 
 
rating.rb
rating.rb
 
 
relationship.rb
relationship.rb
 
 
report.rb
report.rb
 
 
report_reason.rb
report_reason.rb
 
 
scanlation_group.rb
scanlation_group.rb
 
 
sorbet.rb
sorbet.rb
 
 
statistic.rb
statistic.rb
 
 
storage.rb
storage.rb
 
 
tag.rb
tag.rb
 
 
thread.rb
thread.rb
 
 
types.rb
types.rb
 
 
upload.rb
upload.rb
 
 
user.rb
user.rb
 
 
utils.rb
utils.rb
 
 
version.rb
version.rb
 
 

README.md

Mangadex

This is documentation for the Mangadex module.

Directory

Sub-modules

Fetchable/Resources

Other classes

Fetchable/Resources

These refer to the resources that live on Mangadex, or general "namespace"-like concepts on which one can fetch information.

Mangadex::Artist

See Mangadex::Author

This is a sub-class of Mangadex::Author. It has the same attributes as an author.

Mangadex::Auth

All things authentication.

login

Mangadex::Auth.login(username, password)

Login with your username and password. Upon successful login, the user will be available in a context from Mangadex.context.user. This variable can be used anywhere in your application. More info here.

  • Returns Mangadex::Api::Response if request fails.
  • Returns true if user is logged in.
  • Returns false if the user was not successfully logged in.

check_token

Mangadex::Auth.check_token

Check the status of your token, whether you're authenticated or not.

  • Returns a hash with the token information.

logout

Mangadex::Auth.logout

Logs out the current user. Sets Mangadex::Api::Content.user to nil.

  • Returns Mangadex::Api::Response if request fails.
  • Returns true if request is considered successful.
  • Idempotent request.

refresh_token

Mangadex::Auth.refresh_token

Manually cause a token refresh.

Please note that simply calling Mangadex::Api::Content.user ensures that the token is valid. More info here.

  • Returns nil if user is not logged (ie: Mangadex::Api::Content.user is nil)
  • Returns true if the refresh is successful
  • Returns false if the refresh is not successful.