Package net.worcade.client.api

Interface UserApi

All Superinterfaces:

ApiKeysApi, RemoteIdsApi

public interface UserApi
extends ApiKeysApi, RemoteIdsApi

Method Summary

Modifier and Type	Method	Description
Result<?>	addEmailAddress(String id, String... emails)
Result<?>	cancelAccount(String id, String password)
Result<?>	changePassword(String id, String currentPassword, String newPassword)
Result<?>	confirmApplicationTrust(String userId, String applicationId)
Result<?>	confirmEmailAddress(String id, String secret)
Result<?>	confirmJoinCompany(String id, String secret)
Result<?>	confirmPasswordReset(String id, String newPassword, String secret)
Result<? extends Reference>	create(UserModification subject)	Create a new User.
UserCreate	createBuilder()
Result<? extends User>	get(String id)
Result<? extends UserProfile>	getProfile(String id)
Result<?>	removeEmailAddress(String id, String... emails)
Result<?>	requestApplicationTrust(String userId, String applicationId)
Result<?>	requestEmailConfirm(String id, String email)
Result<?>	requestPasswordReset(String id)
Result<?>	requestPasswordResetByEmail(String email)
Result<?>	requestSubscription(String id)
Result<? extends Collection<? extends Reference>>	searchByEmail(String email)
Result<?>	unlinkApplication(String userId, String applicationId)
Result<?>	updateProfile(UserModification subject)

Methods inherited from interface net.worcade.client.api.mixin.ApiKeysApi

createApiKey, getApiKeys, removeApiKey

Methods inherited from interface net.worcade.client.api.mixin.RemoteIdsApi

addRemoteIds, removeRemoteIds, searchByRemoteId

Method Detail

createBuilder

UserCreate createBuilder()

get

Result<? extends User> get(String id)

getProfile

Result<? extends UserProfile> getProfile(String id)

create

Result<? extends Reference> create(UserModification subject)

Create a new User. Use the createBuilder() method for a new, empty template.

updateProfile

Result<?> updateProfile(UserModification subject)

cancelAccount

Result<?> cancelAccount(String id,
                        String password)

addEmailAddress

Result<?> addEmailAddress(String id,
                          String... emails)

removeEmailAddress

Result<?> removeEmailAddress(String id,
                             String... emails)

confirmEmailAddress

Result<?> confirmEmailAddress(String id,
                              String secret)

requestEmailConfirm

Result<?> requestEmailConfirm(String id,
                              String email)

searchByEmail

Result<? extends Collection<? extends Reference>> searchByEmail(String email)

changePassword

Result<?> changePassword(String id,
                         String currentPassword,
                         String newPassword)

requestPasswordReset

Result<?> requestPasswordReset(String id)

requestPasswordResetByEmail

Result<?> requestPasswordResetByEmail(String email)

confirmPasswordReset

Result<?> confirmPasswordReset(String id,
                               String newPassword,
                               String secret)

requestApplicationTrust

Result<?> requestApplicationTrust(String userId,
                                  String applicationId)

confirmApplicationTrust

Result<?> confirmApplicationTrust(String userId,
                                  String applicationId)

unlinkApplication

Result<?> unlinkApplication(String userId,
                            String applicationId)

confirmJoinCompany

Result<?> confirmJoinCompany(String id,
                             String secret)

requestSubscription

Result<?> requestSubscription(String id)