Pandoro/com.tecknobit.pandoro.helpers/PandoroRequester

PandoroRequester

open class PandoroRequester(host: String, userId: String? = null, userToken: String? = null, debugMode: Boolean = false) : EquinoxRequester

The PandoroRequester class is useful to communicate with the Pandoro's backend

Author

N7ghtm4r3 - Tecknobit

Parameters

host

The host where is running the Pandoro's backend

userId

The user identifier

userToken

The user token

Constructors

Link copied to clipboard
constructor(host: String, userId: String? = null, userToken: String? = null, debugMode: Boolean = false)

Functions

Link copied to clipboard
suspend fun acceptInvitation(groupId: String, changelogId: String): JsonObject

Method to execute the request to accept a group invitation

Link copied to clipboard
suspend fun addChangeNote(projectId: String, updateId: String, payload: JsonObject): JsonObject

Method to execute the request to add a new change note to an update

Link copied to clipboard
suspend fun addMembers(groupId: String, members: List<String>): JsonObject

Method to execute the request to add members to a group

Link copied to clipboard
fun attachInterceptorOnRequest(interceptor: () -> Unit)
Link copied to clipboard
open suspend fun changeEmail(newEmail: String): JsonObject
Link copied to clipboard
open override fun changeHost(host: String)
Link copied to clipboard
open suspend fun changeLanguage(newLanguage: String): JsonObject
Link copied to clipboard
suspend fun changeMemberRole(groupId: String, memberId: String, role: Role): JsonObject

Method to execute the request to change a role of a member of a group

Link copied to clipboard
suspend fun changeNoteStatus(noteId: String, completed: Boolean): JsonObject

Method to execute the request to mark a user's note as done

Link copied to clipboard
open suspend fun changePassword(newPassword: String): JsonObject
Link copied to clipboard
open suspend fun changeProfilePic(profilePicName: String, profilePicBytes: ByteArray): JsonObject
Link copied to clipboard
suspend fun countCandidatesMember(membersToExclude: Int): JsonObject

Method to execute the request to count the candidates member available

Link copied to clipboard
suspend fun declineInvitation(groupId: String, changelogId: String): JsonObject

Method to execute the request to decline a group invitation

Link copied to clipboard
open suspend fun deleteAccount(): JsonObject
Link copied to clipboard
suspend fun deleteChangelog(changelogId: String, groupId: String? = null): JsonObject

Method to execute the request to delete a changelog

Link copied to clipboard
suspend fun deleteChangeNote(projectId: String, updateId: String, changeNoteId: String): JsonObject

Method to execute the request to delete change note of an update

Link copied to clipboard
suspend fun deleteGroup(groupId: String): JsonObject

Method to execute the request to delete a group

Link copied to clipboard
suspend fun deleteNote(noteId: String): JsonObject

Method to execute the request to delete a user's note

Link copied to clipboard
suspend fun deleteProject(projectId: String): JsonObject

Method to execute the request to delete a project of the user

Link copied to clipboard
suspend fun deleteUpdate(projectId: String, updateId: String): JsonObject

Method to execute the request to delete an update

Link copied to clipboard
suspend fun editChangeNote(projectId: String, updateId: String, noteId: String, payload: JsonObject): JsonObject

Method to execute the request to edit an existing change note of an update

Link copied to clipboard
suspend fun editProjects(groupId: String, projects: List<String>): JsonObject

Method to execute the request to edit a projects list of a group

Link copied to clipboard
suspend fun getAuthoredGroups(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, nameFilter: String = ""): JsonObject

Method to execute the request to get the groups list of the user where him/her is the author

Link copied to clipboard
suspend fun getAuthoredProjects(): JsonObject

Method to execute the request to get the projects list of the user where him/her is the author

Link copied to clipboard
suspend fun getCandidateMembers(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, membersToExclude: List<String>): JsonObject

Method to execute the request to get the candidates member for a group

Link copied to clipboard
suspend fun getChangelogs(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE): JsonObject

Method to execute the request to get the changelogs list of the user

Link copied to clipboard
suspend fun getDynamicAccountData(): JsonObject
Link copied to clipboard
suspend fun getGroup(groupId: String): JsonObject

Method to execute the request to get a group of the user

Link copied to clipboard
suspend fun getGroups(    page: Int = DEFAULT_PAGE,     pageSize: Int = DEFAULT_PAGE_SIZE,     onlyAuthoredGroups: Boolean = false,     nameFilter: String = "",     roles: List<Role> = emptyList()): JsonObject

Method to execute the request to get the groups list of the user

Link copied to clipboard
suspend fun getInDevelopmentProjects(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, filters: String): JsonObject

Method to execute the request to get the projects list of the user

Link copied to clipboard
suspend fun getNote(noteId: String): JsonObject

Method to execute the request to get the notes list of the user

Link copied to clipboard
suspend fun getNotes(    page: Int = DEFAULT_PAGE,     pageSize: Int = DEFAULT_PAGE_SIZE,     selectToDoNotes: Boolean,     selectCompletedNotes: Boolean): JsonObject

Method to execute the request to get the notes list of the user

Link copied to clipboard
suspend fun getOverview(): JsonObject

Method to execute the request to get the current overview of the user

Link copied to clipboard
suspend fun getProject(projectId: String): JsonObject

Method to execute the request to get a project of the user

Link copied to clipboard
suspend fun getProjects(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, filters: String): JsonObject

Method to execute the request to get the projects list of the user

Link copied to clipboard
suspend fun getUnreadChangelogsCount(): JsonObject

Method to execute the request to get the changelogs list of the user

Link copied to clipboard
suspend fun leaveGroup(groupId: String): JsonObject

Method to execute the request to leave from a group

Link copied to clipboard
suspend fun publishUpdate(projectId: String, updateId: String): JsonObject

Method to execute the request to publish an existing update of a project

Link copied to clipboard
suspend fun readChangelog(changelogId: String): JsonObject

Method to execute the request to read a changelog

Link copied to clipboard
suspend fun removeMember(groupId: String, memberId: String): JsonObject

Method to execute the request to remove a member from a group

Link copied to clipboard
suspend fun scheduleUpdate(projectId: String, targetVersion: String, updateChangeNotes: List<String>): JsonObject

Method to execute the request to schedule a new update for a project

Link copied to clipboard
fun setUserCredentials(userId: String?, userToken: String?)
Link copied to clipboard
open suspend fun signIn(email: String, password: String, vararg custom: Any?): JsonObject
Link copied to clipboard
suspend fun signUp(    serverSecret: String,     name: String,     surname: String,     email: String,     password: String,     language: String,     vararg custom: Any?): JsonObject
Link copied to clipboard
suspend fun startUpdate(projectId: String, updateId: String): JsonObject

Method to execute the request to start an existing update of a project

Link copied to clipboard
suspend fun workOnChangeNoteStatus(projectId: String, updateId: String, changeNoteId: String, completed: Boolean): JsonObject

Wrapper method to execute the request to mark a change note as done

Link copied to clipboard
suspend fun workOnGroup(    groupId: String?,     logo: ByteArray?,     logoName: String?,     name: String,     description: String,     members: List<GroupMember>,     projects: List<String>): JsonObject

Method to execute the request to create a new group or edit an exiting group

Link copied to clipboard
suspend fun workOnNote(noteId: String?, projectId: String?, updateId: String?, contentNote: String): JsonObject

Wrapper method to execute the request to add or edit a note

Link copied to clipboard
suspend fun workOnProject(    icon: ByteArray?,     iconName: String?,     projectId: String? = null,     name: String,     projectDescription: String,     projectVersion: String,     groups: List<String>,     projectRepository: String = ""): JsonObject

Method to execute the request to add a new project or edit an exiting project