Package apple.matter

Class MTRSetupPayload

  • All Implemented Interfaces:
    NSCoding, NSSecureCoding, NSObject
    public class MTRSetupPayload
extends NSObject
implements NSSecureCoding
    A setup payload that can be created from a numeric code or QR code and serialized to a numeric code or QR code, though serializing to QR code after creating from numeric code will not work, because some required information will be missing.

    • Constructor Detail

      • MTRSetupPayload

        protected MTRSetupPayload​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static MTRSetupPayload 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()

      • commissioningFlow

        public long commissioningFlow()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • discoveryCapabilities

        public long discoveryCapabilities()
        The value of discoveryCapabilities is made up of the various MTRDiscoveryCapabilities flags. If the discovery capabilities are not known, this will be set to MTRDiscoveryCapabilitiesUnknown. API-Since: 16.4

      • discriminator

        @NotNull
public @NotNull NSNumber discriminator()

      • generateRandomPIN

        public static long generateRandomPIN()
        Generate a random Matter-valid setup PIN.

      • generateRandomSetupPasscode

        @NotNull
public static @NotNull NSNumber generateRandomSetupPasscode()
        Generate a random Matter-valid setup passcode. API-Since: 16.2

      • getAllOptionalVendorData

        @Nullable
public @Nullable NSArray<? extends MTROptionalQRCodeInfo> getAllOptionalVendorData​(@Nullable
                                                                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

      • hasShortDiscriminator

        public boolean hasShortDiscriminator()
        If hasShortDiscriminator is true, the discriminator value contains just the high 4 bits of the full discriminator. For example, if hasShortDiscriminator is true and discriminator is 0xA, then the full discriminator can be anything in the range 0xA00 t0 0xAFF.

      • hash_static

        public static long hash_static()

      • init

        @Deprecated
public MTRSetupPayload init()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use initWithSetupPasscode or setupPayloadWithOnboardingPayload
        Overrides:
        init in class NSObject

      • initWithSetupPasscodeDiscriminator

        public MTRSetupPayload initWithSetupPasscodeDiscriminator​(@NotNull
                                                          @NotNull NSNumber setupPasscode,
                                                          @NotNull
                                                          @NotNull NSNumber discriminator)
        Initialize an MTRSetupPayload with the given passcode and discriminator. This will pre-set version, product id, and vendor id to 0. API-Since: 16.2

      • 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)

      • manualEntryCode

        @Nullable
public @Nullable java.lang.String manualEntryCode()
        Get 11 digit manual entry code from the setup payload.

      • new_objc

        @Deprecated
public static MTRSetupPayload new_objc()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use initWithSetupPasscode or setupPayloadWithOnboardingPayload

      • productID

        @NotNull
public @NotNull NSNumber productID()

      • qrCodeString

        @Nullable
public @Nullable java.lang.String qrCodeString​(@Nullable
                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Get a QR code from the setup payload. Returns nil on failure (e.g. if the setup payload does not have all the information a QR code needs). API-Since: 16.2

      • rendezvousInformation

        @Deprecated
@Nullable
public @Nullable NSNumber rendezvousInformation()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use discoveryCapabilities

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • serialNumber

        @Nullable
public @Nullable java.lang.String serialNumber()

      • setCommissioningFlow

        public void setCommissioningFlow​(long value)

      • setDiscoveryCapabilities

        public void setDiscoveryCapabilities​(long value)
        The value of discoveryCapabilities is made up of the various MTRDiscoveryCapabilities flags. If the discovery capabilities are not known, this will be set to MTRDiscoveryCapabilitiesUnknown. API-Since: 16.4

      • setDiscriminator

        public void setDiscriminator​(@NotNull
                             @NotNull NSNumber value)

      • setHasShortDiscriminator

        public void setHasShortDiscriminator​(boolean value)
        If hasShortDiscriminator is true, the discriminator value contains just the high 4 bits of the full discriminator. For example, if hasShortDiscriminator is true and discriminator is 0xA, then the full discriminator can be anything in the range 0xA00 t0 0xAFF.

      • setProductID

        public void setProductID​(@NotNull
                         @NotNull NSNumber value)

      • setRendezvousInformation

        @Deprecated
public void setRendezvousInformation​(@Nullable
                                     @Nullable NSNumber value)
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use discoveryCapabilities

      • setSerialNumber

        public void setSerialNumber​(@Nullable
                            @Nullable java.lang.String value)

      • setSetUpPINCode

        @Deprecated
public void setSetUpPINCode​(@NotNull
                            @NotNull NSNumber value)
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use setupPasscode

      • setSetupPasscode

        public void setSetupPasscode​(@NotNull
                             @NotNull NSNumber value)
        API-Since: 16.4

      • setUpPINCode

        @Deprecated
@NotNull
public @NotNull NSNumber setUpPINCode()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use setupPasscode

      • setVendorID

        public void setVendorID​(@NotNull
                        @NotNull NSNumber value)

      • setVersion

        public void setVersion​(@NotNull
                       @NotNull NSNumber value)

      • setupPasscode

        @NotNull
public @NotNull NSNumber setupPasscode()
        API-Since: 16.4

      • setupPayloadWithOnboardingPayloadError

        @Nullable
public static @Nullable MTRSetupPayload setupPayloadWithOnboardingPayloadError​(@NotNull
                                                                               @NotNull java.lang.String onboardingPayload,
                                                                               @Nullable
                                                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Create an MTRSetupPayload with the given onboarding payload. Will return nil on errors (e.g. if the onboarding payload cannot be parsed). API-Since: 16.2

      • superclass_static

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

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.

      • vendorID

        @NotNull
public @NotNull NSNumber vendorID()

      • version

        @NotNull
public @NotNull NSNumber version()