Package apple.carplay

Class CPMessageListItem

  • All Implemented Interfaces:
    CPListTemplateItem, NSObject

    public class CPMessageListItem
    extends NSObject
    implements CPListTemplateItem
    [@c] CPMessageListItem is a special variant of a list item for use in a @c CPListTemplate. Unlike @c CPListItem, your application will not receive a callback when the user selects a @c CPMessageListItem in your list template. Instead, Siri will be invoked using the parameters you specify in your message item and the user will continue a message compose, read, or reply flow through Siri. There are two modes of operation for @c CPMessageListItem: To represent an existing conversation with one or more recipients, use the @c CPMessageListItem initializer that accepts a conversation identifier. This identifier is not directly displayed to the user; rather, it should be a value meaningful to your app to identify the conversation. To represent a contact or person entity, use the @c CPMessageListItem initializer that accepts a full name and phone/email. When the user selects this item, Siri will perform a message compose flow. API-Since: 14.0
    • Constructor Detail

      • CPMessageListItem

        protected CPMessageListItem​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • allocWithZone

        public static CPMessageListItem allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                                   @NotNull java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                                   @NotNull java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                                 @NotNull java.lang.Object aTarget,
                                                                                 @NotNull
                                                                                 @NotNull org.moe.natj.objc.SEL aSelector,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        @NotNull
        public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        @NotNull
        public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()
      • conversationIdentifier

        @Nullable
        public @Nullable java.lang.String conversationIdentifier()
      • debugDescription_static

        public static java.lang.String debugDescription_static()
      • description_static

        public static java.lang.String description_static()
      • detailText

        @Nullable
        public @Nullable java.lang.String detailText()
      • hash_static

        public static long hash_static()
      • initWithConversationIdentifierTextLeadingConfigurationTrailingConfigurationDetailTextTrailingText

        public CPMessageListItem initWithConversationIdentifierTextLeadingConfigurationTrailingConfigurationDetailTextTrailingText​(@NotNull
                                                                                                                                   @NotNull java.lang.String conversationIdentifier,
                                                                                                                                   @NotNull
                                                                                                                                   @NotNull java.lang.String text,
                                                                                                                                   @NotNull
                                                                                                                                   @NotNull CPMessageListItemLeadingConfiguration leadingConfiguration,
                                                                                                                                   @Nullable
                                                                                                                                   @Nullable CPMessageListItemTrailingConfiguration trailingConfiguration,
                                                                                                                                   @Nullable
                                                                                                                                   @Nullable java.lang.String detailText,
                                                                                                                                   @Nullable
                                                                                                                                   @Nullable java.lang.String trailingText)
        Initialize a @c CPMessageListItem for use in a @c CPListTemplate. [@note] The maximum image size is CPMaximumMessageItemImageSize. If you supply a larger image, it will be scaled down to this size.
        Parameters:
        conversationIdentifier - A value meaningful to your app to identify this conversation. This identifier is not directly displayed to the user; rather, when the user selects this list item, SiriKit will pass this identifier back to your app for your own use.
        text - This is the main text label displayed to the user as well as spoken by Siri when the user selects this list item.
        leadingConfiguration - A set of configuration options for the leading side of the list item.
        trailingConfiguration - A set of configuration options for the trailing side of the list item.
        detailText - Any additional text displayed underneath the @c conversationName.
        trailingText - Any additional text displayed along the trailing side of the cell.
      • initWithFullNamePhoneOrEmailAddressLeadingConfigurationTrailingConfigurationDetailTextTrailingText

        public CPMessageListItem initWithFullNamePhoneOrEmailAddressLeadingConfigurationTrailingConfigurationDetailTextTrailingText​(@NotNull
                                                                                                                                    @NotNull java.lang.String fullName,
                                                                                                                                    @NotNull
                                                                                                                                    @NotNull java.lang.String phoneOrEmailAddress,
                                                                                                                                    @NotNull
                                                                                                                                    @NotNull CPMessageListItemLeadingConfiguration leadingConfiguration,
                                                                                                                                    @Nullable
                                                                                                                                    @Nullable CPMessageListItemTrailingConfiguration trailingConfiguration,
                                                                                                                                    @Nullable
                                                                                                                                    @Nullable java.lang.String detailText,
                                                                                                                                    @Nullable
                                                                                                                                    @Nullable java.lang.String trailingText)
        Initialize a @c CPMessageListItem for use in a @c CPListTemplate. [@note] The maximum image size is CPMaximumMessageItemImageSize. If you supply a larger image, it will be scaled down to this size.
        Parameters:
        fullName - The full name of the contact entity represented by this list item. This text will be displayed as the main text label in the cell and will be spoken by Siri.
        phoneOrEmailAddress - A phone or email address for this contact entity that can be used to compose a message.
        leadingConfiguration - A set of configuration options for the leading side of the list item.
        trailingConfiguration - A set of configuration options for the trailing side of the list item.
        detailText - Any additional text displayed underneath the @c conversationName.
        trailingText - Any additional text displayed along the trailing side of the cell.
      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)
      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)
      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)
      • keyPathsForValuesAffectingValueForKey

        @NotNull
        public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                             @NotNull java.lang.String key)
      • phoneOrEmailAddress

        @Nullable
        public @Nullable java.lang.String phoneOrEmailAddress()
      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)
      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)
      • setConversationIdentifier

        public void setConversationIdentifier​(@Nullable
                                              @Nullable java.lang.String value)
      • setDetailText

        public void setDetailText​(@Nullable
                                  @Nullable java.lang.String value)
      • setPhoneOrEmailAddress

        public void setPhoneOrEmailAddress​(@Nullable
                                           @Nullable java.lang.String value)
      • setText

        public void setText​(@Nullable
                            @Nullable java.lang.String value)
        To update the @c CPMessageListItem, assign to any of these properties. If displayed in a list template, the list item will be automatically reloaded.
      • setTrailingText

        public void setTrailingText​(@Nullable
                                    @Nullable java.lang.String value)
      • setUserInfo

        public void setUserInfo​(@Nullable
                                @Nullable java.lang.Object value)
        Description copied from interface: CPListTemplateItem
        Any custom user info related to this item.
        Specified by:
        setUserInfo in interface CPListTemplateItem
      • setVersion_static

        public static void setVersion_static​(long aVersion)
      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()
      • text

        @Nullable
        public @Nullable java.lang.String text()
        Description copied from interface: CPListTemplateItem
        The primary text shown in a cell displaying this list item.
        Specified by:
        text in interface CPListTemplateItem
      • trailingText

        @Nullable
        public @Nullable java.lang.String trailingText()
      • userInfo

        @Nullable
        public @Nullable java.lang.Object userInfo()
        Description copied from interface: CPListTemplateItem
        Any custom user info related to this item.
        Specified by:
        userInfo in interface CPListTemplateItem
      • version_static

        public static long version_static()
      • isEnabled

        public boolean isEnabled()
        Description copied from interface: CPListTemplateItem
        A Boolean value indicating whether the button is enabled. Set the value of this property to @c YES to enable the button or @c NO to disable it. The default value of this property is @c YES. API-Since: 15.0
        Specified by:
        isEnabled in interface CPListTemplateItem
      • setEnabled

        public void setEnabled​(boolean value)
        Description copied from interface: CPListTemplateItem
        A Boolean value indicating whether the button is enabled. Set the value of this property to @c YES to enable the button or @c NO to disable it. The default value of this property is @c YES. API-Since: 15.0
        Specified by:
        setEnabled in interface CPListTemplateItem
      • useStoredAccessor

        @Deprecated
        public static boolean useStoredAccessor()
        Deprecated.