Class UploadSession

constructor

• new UploadSession(schem: FixedFullUploadSession): UploadSession

• Parameters

  • schem: FixedFullUploadSession

  Returns UploadSession

createdAt

groups

id

isCommitted

isDeleted

isProcessed

manga

pages

updatedAt

uploader

version

close

• close(): Promise<void>

• Closes this upload session and removes all associated uploaded files

  Returns Promise<void>

commit

• commit(chapterData: ChapterDraftSchema, pageOrder?: string[] | UploadSessionFile[]): Promise<void>

• Commit and publish this chapter to MangaDex.

  Parameters

  • chapterData: ChapterDraftSchema

  • Optional pageOrder: string[] | UploadSessionFile[]

    By default, the page order is decided by the 'pages' array of this upload session object. If this parameter is supplied an array, the order of elements in that array is used instead.

  Returns Promise<void>

deletePages

• deletePages(pages: string[] | UploadSessionFileSchema[]): Promise<void>

• Delete previously uploaded page image files by their ids

  Parameters

  • pages: string[] | UploadSessionFileSchema[]

  Returns Promise<void>

uploadPages

• uploadPages(files: Blob[]): Promise<void>

• Upload new page image files as blobs. The blobs should contain the binary image data, and although not necessary, it is recommended that the image MIME type is included as well. The resulting uploaded file data will be appended to this object's 'pages' property.

  Parameters

  • files: Blob[]

  Returns Promise<void>

Static begin

• begin(manga: string | Manga, groups?: string[] | Group[], cancelCurrentSession?: boolean): Promise<UploadSession>

• Begin a new upload session for a specified manga. At least one group must be specified

  Parameters

  • manga: string | Manga

  • groups: string[] | Group[] = []

  • cancelCurrentSession: boolean = false

    Stop any current upload session before creating this one

  Returns Promise<UploadSession>

Static beginChapterEdit

• beginChapterEdit(chapter: Chapter, cancelCurrentSession?: boolean): Promise<UploadSession>

• Start a new upload session for editing an existing chapter. The upload session will act the same as one for new chapter.

  Parameters

  • chapter: Chapter

  • cancelCurrentSession: boolean = false

    Stop any current upload session before creating this one

  Returns Promise<UploadSession>

Static cancelCurrentSession

• cancelCurrentSession(): Promise<void>

• Cancel the current user's current upload session if it exists

  Returns Promise<void>

Static getCurrentSession

• getCurrentSession(): Promise<UploadSession>

• Get the current upload session owned by the currently authenticated user

  Returns Promise<UploadSession>