All Known Implementing Classes:: UserAccountBuilderImpl

public interface UserAccountBuilder

A builder for the user account that can be used to update or create an UserAccount

Author:: Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
`UserAccountBuilder`	`businessAccountId(java.lang.String businessAccountId)`	The id of the business account that the user account would be linked to (e.g.
`UserAccountBuilder`	`externalUserId(java.lang.String externalUserId)`	The id of the user within the external system (e.g.
`UserAccountBuilder`	`name(java.lang.String name)`	The name of the account (e.g.
`UserAccount`	`save()`	Performs the save of the user account
`UserAccountBuilder`	`state(java.lang.String state)`	The initial state of the created account.
`UserAccountBuilder`	`subState(java.lang.String subState)`	The initial sub state of the created account.
`UserAccountBuilder`	`subType(java.lang.String subType)`	The sub type of the account.
`UserAccountBuilder`	`tenantId(java.lang.String tenantId)`	The id of the tenant that this account belongs to
`UserAccountBuilder`	`type(java.lang.String type)`	Set the type of the account.
`UserAccountBuilder`	`userAccountDefinitionId(java.lang.String userAccountDefinitionId)`	The id of the `UserAccountDefinition` that should be used when creating the user account.
`UserAccountBuilder`	`userAccountDefinitionKey(java.lang.String userAccountDefinitionKey)`	The key of the `UserAccountDefinition` that should be used when creating the user account.
`UserAccountBuilder`	`userId(java.lang.String userId)`	The id of the user that this account belongs to

Method Details
- userId
  
  UserAccountBuilder userId(java.lang.String userId)
  
  The id of the user that this account belongs to
  
  Parameters:
  
  userId - the user id linked with the account
- tenantId
  
  UserAccountBuilder tenantId(java.lang.String tenantId)
  
  The id of the tenant that this account belongs to
  
  Parameters:
  
  tenantId - the tenant id for the account
- name
  
  UserAccountBuilder name(java.lang.String name)
  
  The name of the account (e.g. WhatsApp for XY, etc)
  
  Parameters:
  
  name - the name for the account
- type
  
  UserAccountBuilder type(java.lang.String type)
  
  Set the type of the account. (e.g. Messenger)
  
  Parameters:
  
  type - the type of the account
  
  See Also:
  
  for known types
- subType
  
  UserAccountBuilder subType(java.lang.String subType)
  
  The sub type of the account. (e.g. WhatsApp, WeChat, Facebook, etc)
  
  Parameters:
  
  subType - the sub type of the account
  
  See Also:
  
  for known sub types
- state
  
  UserAccountBuilder state(java.lang.String state)
  
  The initial state of the created account. In order to update the state of the account the UserAccountService.setStateAndSubState(String, String, String) should be used.
  
  Parameters:
  
  state - the initial state for the created account
- subState
  
  UserAccountBuilder subState(java.lang.String subState)
  
  The initial sub state of the created account. In order to update the state of the account the UserAccountService.setStateAndSubState(String, String, String) should be used.
  
  Parameters:
  
  subState - the initial state for the created account
- businessAccountId
  
  UserAccountBuilder businessAccountId(java.lang.String businessAccountId)
  
  The id of the business account that the user account would be linked to (e.g. WhatsApp business number xyz or WeChat official account, etc)
  
  Parameters:
  
  businessAccountId - the id of the business account
- externalUserId
  
  UserAccountBuilder externalUserId(java.lang.String externalUserId)
  
  The id of the user within the external system (e.g. the phone number for WhatsApp, the user-id for Facebook account, etc)
  
  Parameters:
  
  externalUserId - the id of the external user
- userAccountDefinitionId
  
  UserAccountBuilder userAccountDefinitionId(java.lang.String userAccountDefinitionId)
  
  The id of the UserAccountDefinition that should be used when creating the user account.
  
  Parameters:
  
  userAccountDefinitionId - the id of the user account definition
- userAccountDefinitionKey
  
  UserAccountBuilder userAccountDefinitionKey(java.lang.String userAccountDefinitionKey)
  
  The key of the UserAccountDefinition that should be used when creating the user account.
  
  Parameters:
  
  userAccountDefinitionKey - the key of the user account definition
- save
  
  UserAccount save()
  
  Performs the save of the user account
  
  Returns:
  
  the saved UserAccount

Interface UserAccountBuilder

Method Summary

Method Details