Package com.flowable.core.idm.api

Interface UserAccount

    • Method Detail

      • getId

        String getId()
        The unique id for the user account.
        Returns:
        thd user account id

      • getUserId

        String getUserId()
        The id of the user that this account belongs to. It might be null if the account is not yet linked with a user (during onboarding for example).
        Returns:
        the id of the user that this account belongs to

      • getTenantId

        String getTenantId()
        The id of the tenant that this user account belongs to
        Returns:
        the tenant id

      • getName

        String getName()
        The name of the account. (e.g. WhatsApp for XY, etc)
        Returns:
        the name of the account

      • getType

        String getType()
        The type of the account. (e.g. Messenger)
        Returns:
        the type of the account

      • getSubType

        String getSubType()
        The sub type of the account. (e.g. WhatsApp, WeChat, Facebook, etc)
        Returns:
        the sub type of the account

      • getState

        String getState()
        The state of the user account
        Returns:
        the state

      • getSubState

        String getSubState()
        The sub state of the user account
        Returns:
        the sub state

      • getBusinessAccountId

        String getBusinessAccountId()
        The id of the business account id this user account is linked to (e.g. WhatsApp business number xyz or WeChat official account, etc).
        Returns:
        the business account id

      • getExternalUserId

        String getExternalUserId()
        The id of the user within the external system (e.g. the phone number if it is a WhatsApp account or the user-id for a facebook account, etc)
        Returns:
        external user id

      • getUserAccountDefinitionId

        String getUserAccountDefinitionId()
        The id of the user account definition for this user account
        Returns:
        the user account definition id

      • getCreatorId

        String getCreatorId()
        The id of the user that created this account
        Returns:
        the id of the creator

      • getCreationTime

        Date getCreationTime()
        The time of creation of this account
        Returns:
        the creation time of this account

      • getUpdaterId

        String getUpdaterId()
        The id of the user that last updated the account
        Returns:
        the id of the user that last updated the account

      • getUpdateTime

        Date getUpdateTime()
        The time of the last update of this account
        Returns:
        the last update time of this account

      • isActive

        default boolean isActive()
        Method to check if this user account has the state ACTIVE.
        Returns:
        true if this user account has the state ACTIVE, false otherwise