Refy/com.tecknobit.refy.helpers/RefyRequester

Refy Requester

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

The RefyRequester class is useful to communicate with Refy's backend

Author

N7ghtm4r3 - Tecknobit

Parameters

host

The host address where is running the 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

RefyRequester

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

Functions

attachInterceptorOnRequest

fun attachInterceptorOnRequest(interceptor: () -> Unit)

attachLinksWithCollection

suspend fun attachLinksWithCollection(collection: LinksCollection, links: List<String>): JsonObject

Method to attach links with the collection

changeCloseApplicationOnOpenLink

suspend fun changeCloseApplicationOnOpenLink(closeApplicationOnOpenLink: Boolean): JsonObject

Request to change the close application on open link preference

changeEmail

open suspend fun changeEmail(newEmail: String): JsonObject

changeHost

open override fun changeHost(host: String)

changeLanguage

open suspend fun changeLanguage(newLanguage: String): JsonObject

changeMemberRole

suspend fun changeMemberRole(teamId: String, member: TeamMember, role: TeamRole): JsonObject

Method to change the role of a member

changePassword

open suspend fun changePassword(newPassword: String): JsonObject

changeProfilePic

open suspend fun changeProfilePic(profilePicName: String, profilePicBytes: ByteArray): JsonObject

changeTagName

suspend fun changeTagName(tagName: String): JsonObject

Method to request the to change the tag name of the user

clearSession

open fun clearSession()

createCollection

suspend fun createCollection(color: String, title: String, description: String, links: List<String>): JsonObject

Method to create a collection

createCustomLink

suspend fun createCustomLink(title: String, description: String, resources: Map<String, String>, fields: Map<String, String>, hasUniqueAccess: Boolean = false, expiredTime: ExpiredTime = ExpiredTime.NO_EXPIRATION): JsonObject

Method to create a custom link

createLink

suspend fun createLink(referenceLink: String, description: String): JsonObject

Method to create a new link

createTeam

suspend fun createTeam(title: String, logoPicName: String, logoPicBytes: ByteArray, description: String, membersRaw: List<TeamMember>): JsonObject

Method to request to create a team

deleteAccount

open suspend fun deleteAccount(): JsonObject

deleteCollection

suspend fun deleteCollection(collection: LinksCollection): JsonObject

Method to delete a collection

deleteCustomLink

suspend fun deleteCustomLink(link: CustomRefyLink): JsonObject

Method to delete a custom link

deleteLink

suspend fun deleteLink(link: RefyLink): JsonObject

Method to delete a link

deleteTeam

suspend fun deleteTeam(team: Team): JsonObject

Method to delete a team

editCollection

suspend fun editCollection(collectionId: String, color: String, title: String, description: String, links: List<String>): JsonObject

Method to edit a collection

editCustomLink

suspend fun editCustomLink(linkId: String, title: String, description: String, resources: Map<String, String>, fields: Map<String, String>, hasUniqueAccess: Boolean = false, expiredTime: ExpiredTime = ExpiredTime.NO_EXPIRATION): JsonObject

Method to edit a custom link

editLink

suspend fun editLink(linkId: String, referenceLink: String, description: String): JsonObject

Method to edit a link

editTeam

suspend fun editTeam(teamId: String, title: String, logoPicName: String, logoPicBytes: ByteArray, description: String, membersRaw: List<TeamMember>): JsonObject

Method to request to update a team

getCollection

suspend fun getCollection(collectionId: String): JsonObject

Method to request a collection

getCollectionLinks

suspend fun getCollectionLinks(collectionId: String, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method request the links shared in the collection

getCollections

suspend fun getCollections(ownedOnly: Boolean = false, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method the collections of the user

getCollectionTeams

suspend fun getCollectionTeams(collectionId: String, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE): JsonObject

Method request the teams where the collection is shared

getCustomLink

suspend fun getCustomLink(linkId: String): JsonObject

Method to request a custom link

getCustomLinks

suspend fun getCustomLinks(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method the custom links of the user

getDynamicAccountData

suspend fun getDynamicAccountData(): JsonObject

getLink

suspend fun getLink(linkId: String): JsonObject

Method to request a custom link

getLinks

suspend fun getLinks(ownedOnly: Boolean = false, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method the links of the user

getPotentialMembers

suspend fun getPotentialMembers(page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE): JsonObject

Method the potential members to add in a team

getTeam

suspend fun getTeam(teamId: String): JsonObject

Method to request a team

getTeamCollections

suspend fun getTeamCollections(teamId: String, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method to request the collections shared with the team

getTeamLinks

suspend fun getTeamLinks(teamId: String, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method to request the links shared with the team

getTeams

suspend fun getTeams(ownedOnly: Boolean = false, page: Int = DEFAULT_PAGE, pageSize: Int = DEFAULT_PAGE_SIZE, keywords: String = ""): JsonObject

Method the teams where the user is a member

leave

suspend fun leave(teamId: String): JsonObject

Method to leave from a team

removeCollectionFromTeam

suspend fun removeCollectionFromTeam(teamId: String, collection: LinksCollection): JsonObject

Method to remove from a team a collection

removeLinkFromCollection

suspend fun removeLinkFromCollection(collectionId: String, link: RefyLink.RefyLinkImpl): JsonObject

Method to remove from a collection a link

removeLinkFromTeam

suspend fun removeLinkFromTeam(teamId: String, link: RefyLink.RefyLinkImpl): JsonObject

Method to remove from a team a link

removeMember

suspend fun removeMember(teamId: String, member: TeamMember): JsonObject

Method to remove a member from the team

removeTeamFromCollection

suspend fun removeTeamFromCollection(collectionId: String, team: Team): JsonObject

Method to remove from a collection a team

setUserCredentials

fun setUserCredentials(userId: String?, userToken: String?)

shareCollectionsWithTeam

suspend fun shareCollectionsWithTeam(team: Team, collections: List<String>): JsonObject

Method share collections with team

shareCollectionWithTeams

suspend fun shareCollectionWithTeams(collection: LinksCollection, teams: List<String>): JsonObject

Method to manage the teams where the collection is shared

shareLinksWithTeam

suspend fun shareLinksWithTeam(team: Team, links: List<String>): JsonObject

Method share links with team

shareLinkWithCollections

suspend fun shareLinkWithCollections(link: RefyLink.RefyLinkImpl, collections: List<String>): JsonObject

Method to manage the collections where the link is shared

shareLinkWithTeams

suspend fun shareLinkWithTeams(link: RefyLink.RefyLinkImpl, teams: List<String>): JsonObject

Method to manage the teams where the link is shared

signIn

open suspend fun signIn(email: String, password: String, language: String, vararg custom: Any?): JsonObject

signUp

suspend fun signUp(serverSecret: String, name: String, surname: String, email: String, password: String, language: String, vararg custom: Any?): JsonObject