Pandoro/com.tecknobit.pandoro.helpers/PandoroRequester

PandoroRequester

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

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)

Types

Link copied to clipboard
object Companion

Functions

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

Method to execute the request to accept a group invitation

Link copied to clipboard
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
fun addMembers(groupId: String, members: List<String>): JsonObject

Method to execute the request to add members to a group

Link copied to clipboard
fun changeMemberRole(groupId: String, memberId: String, role: <Error class: unknown class>): JsonObject

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

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

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

Link copied to clipboard
fun countCandidatesMember(membersToExclude: Int): JsonObject

Method to execute the request to count the candidates member available

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

Method to execute the request to decline a group invitation

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

Method to execute the request to delete a changelog

Link copied to clipboard
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
fun deleteGroup(groupId: String): JsonObject

Method to execute the request to delete a group

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

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

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

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

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

Method to execute the request to delete an update

Link copied to clipboard
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
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
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
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
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
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
fun getGroup(groupId: String): JsonObject

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

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

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

Link copied to clipboard
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
fun getNote(noteId: String): JsonObject

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

Link copied to clipboard
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
fun getOverview(): JsonObject

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

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

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

Link copied to clipboard
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
fun getUnreadChangelogsCount(): JsonObject

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

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

Method to execute the request to leave from a group

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

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

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

Method to execute the request to read a changelog

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

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

Link copied to clipboard
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 startUpdate(projectId: String, updateId: String): JsonObject

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

Link copied to clipboard
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
fun workOnGroup(groupId: String?, logo: 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
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
fun workOnProject(icon: 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