• Home
• io.datalbry.jetbrains
• jetbrains-client
• 0.0.3
• source code
• ProfilesClient.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.datalbry.jetbrains.space.client.profile.ProfilesClient.kt Maven / Gradle / Ivy

package io.datalbry.jetbrains.space.client.profile

import io.datalbry.jetbrains.space.models.profile.Profile
import io.datalbry.jetbrains.space.models.profile.ProfileIdentifier

/**
 * The ProfilesClient interface provides all needed endpoints to retrieve data about Profiles in your JetBrains Space
 */
interface ProfilesClient {

    /**
     * Given an identifier retrieves an Profile
     *
     * @param profileIdentifier: An Profile identifier
     * @return A Profile object
     */
    fun getProfile(profileIdentifier: ProfileIdentifier): Profile

    /**
     * Retrives all profile identifier from the JetBrains Space
     *
     * @return All profile identifiers in the given JetBrains Space in form of an iterator
     */
    fun getProfileIdentifier(): Iterator


}