Interface Recipient.Visitor

  • All Implemented Interfaces:

    
    public interface Recipient.Visitor<T extends Object>
    
                        

    An interface that defines how to map each variant of Recipient to a value of type T.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract T visitUser(User user) A /concepts/users represents an individual in your system who can receive notifications through Knock.
      abstract T visitObject(Object object_) A custom /concepts/objects entity which belongs to a collection.
      T unknown(JsonValue json) Maps an unknown variant of Recipient to a value of type T.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • visitUser

         abstract T visitUser(User user)

        A /concepts/users represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.

      • visitObject

         abstract T visitObject(Object object_)

        A custom /concepts/objects entity which belongs to a collection.

      • unknown

         T unknown(JsonValue json)

        Maps an unknown variant of Recipient to a value of type T.

        An instance of Recipient can contain an unknown variant if it was deserialized from data that doesn't match any known variant. For example, if the SDK is on an older version than the API, then the API may respond with new variants that the SDK is unaware of.