Ametista/com.tecknobit.ametista.helpers/AmetistaRequester

Ametista Requester

class AmetistaRequester(host: String, userId: String?, userToken: String?, debugMode: Boolean = false)

The AmetistaRequester class is useful to communicate with the Ametista's backend

Author

N7ghtm4r3 - Tecknobit

Parameters

host

: the host where is running the Nova's backend

userId

: the user identifier

userToken

: the user token

debugMode

: whether the requester is still in development and who is developing needs the log of the requester's workflow, if it is enabled all the details of the requests sent and the errors occurred will be printed in the console

Constructors

AmetistaRequester

constructor(host: String, userId: String?, userToken: String?, debugMode: Boolean = false)

Functions

addApplication

fun addApplication(icon: String, name: String, description: String): <Error class: unknown class>

Method to add a new AmetistaApplication to the system

addViewer

fun addViewer(name: String, surname: String, email: String): <Error class: unknown class>

Method to add a new com.tecknobit.ametistacore.models.AmetistaUser.Role.VIEWER in the system

adminSignIn

fun adminSignIn(adminCode: String, email: String, password: String): <Error class: unknown class>

Method to sign-in as an ADMIN

adminSignUp

fun adminSignUp(adminCode: String, name: String, surname: String, email: String, password: String, language: String): <Error class: unknown class>

Method to sign-up as an ADMIN

changeViewerPresetPassword

fun changeViewerPresetPassword(password: String): <Error class: unknown class>

Method to change the preset password by a com.tecknobit.ametistacore.models.AmetistaUser.Role.VIEWER

deleteApplication

fun deleteApplication(application: <Error class: unknown class>): <Error class: unknown class>

Method to delete an AmetistaApplication

editApplication

fun editApplication(application: <Error class: unknown class>, icon: String, name: String, description: String): <Error class: unknown class>

Method to edit an existing AmetistaApplication

getApplication

fun getApplication(applicationId: String): <Error class: unknown class>

Method to get an existing AmetistaApplication

getApplications

fun getApplications(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, name: String = "", platforms: List<<Error class: unknown class>> = emptyList()): <Error class: unknown class>

Method to get the applications list

getIssues

fun getIssues(applicationId: String, platform: <Error class: unknown class>, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, filters: HashSet<String> = HashSet()): <Error class: unknown class>

Method to get the issues list

getPerformanceData

fun getPerformanceData(applicationId: String, platform: <Error class: unknown class>, performanceDataFilters: <Error class: unknown class>): <Error class: unknown class>

Method to get the performance data of an AmetistaApplication

getSessionMembers

fun getSessionMembers(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE): <Error class: unknown class>

Method to get the members registered in the current session

getVersionSamples

fun getVersionSamples(applicationId: String, platform: <Error class: unknown class>, analyticType: <Error class: unknown class>): <Error class: unknown class>

Method to get the version samples for each analytic

removeMember

fun removeMember(member: <Error class: unknown class>): <Error class: unknown class>

Method to remove an com.tecknobit.ametistacore.models.AmetistaMember from the system

sendPaginatedRequest

fun <T> sendPaginatedRequest(request: AmetistaRequester.() -> <Error class: unknown class>, supplier: (<Error class: unknown class>) -> T, onSuccess: (<Error class: unknown class><T>) -> Unit, onFailure: (<Error class: unknown class>) -> Unit, onConnectionError: (<Error class: unknown class>) -> Unit? = null)

Method to execute and manage the paginated response of a request

viewerSignIn

fun viewerSignIn(serverSecret: String, email: String, password: String): <Error class: unknown class>