Package se.swedenconnect.bankid.rpapi.support

Interface BankIDMessage

All Known Implementing Classes:
BankIDMessageImpl
public interface BankIDMessage
An abstraction for messages that are displayed for the user during a BankID operation.
Author:
Martin Lindström

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    BankIDMessage.ShortName
    Enumeration of the short names for the "Recommended User Messages" as defined in section 6 of the BankID Relying Party Guidelines.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getMessageCodes()
    Returns an ordered list containing the message code(s) for this message.
    BankIDMessage.ShortName
    getShortName()
    Returns the "short name" for the message to displayed.

  • Method Details

    • getShortName

      BankIDMessage.ShortName getShortName()
      Returns the "short name" for the message to displayed.

      See section 6 of the BankID Relying Party Guidelines.

      Returns:
      the message short name

    • getMessageCodes

      List<String> getMessageCodes()
      Returns an ordered list containing the message code(s) for this message.

      If more than one message code is returned, the idea is to display the message divided into parts, for example in separate p-tags.

      Returns:
      a (non-empty) list of message codes