Package com.io7m.idstore.user_client.internal

# Interface IdUClientProtocolHandlerType

All Superinterfaces:
  `IdUClientUsersType`

All Known Implementing Classes:
  `IdUClientProtocolHandler1`, `IdUClientProtocolHandlerAbstract`, `IdUClientProtocolHandlerDisconnected`

public interface IdUClientProtocolHandlerType extends IdUClientUsersType
A versioned protocol handler.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `IdUNewHandler`
  `login(String user, String password, URI base, Map<String,String> metadata)`
  Attempt to log in.

  ### Methods inherited from interface com.io7m.idstore.user_client.api.IdUClientUsersType

  `userEmailAddBegin, userEmailAddDeny, userEmailAddPermit, userEmailRemoveBegin, userEmailRemoveDeny, userEmailRemovePermit, userPasswordUpdate, userRealNameUpdate, userSelf`

- ## Method Details

  - ### login

    IdUNewHandler login(String user, String password, URI base, Map<String,String> metadata) throws IdUClientException, InterruptedException
    Attempt to log in.
    Parameters:
      `user` - The user
      `password` - The password
      `base` - The base URI
      `metadata` - Optional metadata properties to include with the request
    Returns:
      A new protocol handler
    Throws:
      `IdUClientException` - On errors
      `InterruptedException` - On interruption