UsersApi

public interface UsersApi implements WithApiKey
Content copied to clipboard

User related operations

Functions

deleteUnfollowUser
Link copied to clipboard
abstract Flow<DgfrCallState<Boolean>> deleteUnfollowUser(String id)
Content copied to clipboard

Unfollow an object given its ID Returns the number of followers left after the operation

deleteUser
Link copied to clipboard
abstract Flow<DgfrCallState<Boolean>> deleteUser(String user)
Content copied to clipboard

Delete a user given its identifier

getListUserFollowers
Link copied to clipboard
abstract Flow<DgfrCallState<FollowPage>> getListUserFollowers(String id, Integer page, Integer pageSize)
Content copied to clipboard

List all followers for a given object

getListUsers
Link copied to clipboard
abstract Flow<DgfrCallState<UserPage>> getListUsers(String q, List<String> facets, String organization, String datasets, String followers, String sort, Integer page, Integer pageSize)
Content copied to clipboard

List all users

getSuggestUsers
Link copied to clipboard
abstract Flow<DgfrCallState<List<UserSuggestion>>> getSuggestUsers(String q, Integer size)
Content copied to clipboard

Suggest users

getUser
Link copied to clipboard
abstract Flow<DgfrCallState<User>> getUser(String user)
Content copied to clipboard

Get a user given its identifier

getUserRoles
Link copied to clipboard
abstract Flow<DgfrCallState<List<UserRole>>> getUserRoles()
Content copied to clipboard

List all possible user roles

postCreateUser
Link copied to clipboard
abstract Flow<DgfrCallState<User>> postCreateUser(User payload)
Content copied to clipboard

Create a new object

postFollowUser
Link copied to clipboard
abstract Flow<DgfrCallState<Boolean>> postFollowUser(String id)
Content copied to clipboard

Follow a user given its ID

postUserAvatar
Link copied to clipboard
abstract Flow<DgfrCallState<UploadedImage>> postUserAvatar(String user, ByteArray file, String fileName, String contentType)
Content copied to clipboard

Upload a new avatar for a given user

putUpdateUser
Link copied to clipboard
abstract Flow<DgfrCallState<User>> putUpdateUser(String user, User payload)
Content copied to clipboard

Update a user given its identifier

setApiKey
Link copied to clipboard
abstract Unit setApiKey(String apiKey)
Content copied to clipboard

Inheritors

DgfrService
Link copied to clipboard