Class Topic

    • Method Detail

      • topicName

        public final String topicName()

        The name of the topic.

        Returns:
        The name of the topic.
      • displayName

        public final String displayName()

        The name of the topic the contact will see.

        Returns:
        The name of the topic the contact will see.
      • description

        public final String description()

        A description of what the topic is about, which the contact will see.

        Returns:
        A description of what the topic is about, which the contact will see.
      • defaultSubscriptionStatus

        public final SubscriptionStatus defaultSubscriptionStatus()

        The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

        If the service returns an enum value that is not available in the current SDK version, defaultSubscriptionStatus will return SubscriptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultSubscriptionStatusAsString().

        Returns:
        The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
        See Also:
        SubscriptionStatus
      • defaultSubscriptionStatusAsString

        public final String defaultSubscriptionStatusAsString()

        The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

        If the service returns an enum value that is not available in the current SDK version, defaultSubscriptionStatus will return SubscriptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultSubscriptionStatusAsString().

        Returns:
        The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
        See Also:
        SubscriptionStatus
      • serializableBuilderClass

        public static Class<? extends Topic.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)