Package apple.mediasetup

Class MSSetupSession

  • All Implemented Interfaces:
    NSObject
    public class MSSetupSession
extends NSObject
    An object that manages the transfer of configuration information between your app, the system, your media service, and HomePod speakers. An `MSSetupSession` object guides the user through connecting HomePod speakers in their home to your media service. When your iOS app calls ``MSSetupSession/startWithError:``, the session displays a setup view in the window you provide in ``MSAuthenticationPresentationContext/presentationAnchor``. The session embeds your app icon and the ``MSServiceAccount/serviceName`` you provide into this setup view. ![A wireframe showing the setup view Media Setup displays to the user, with callouts indicating where your app’s icon and your media service’s name appear.](mssetupsession-1) After the user confirms the setup by tapping the “Use in Home” button, the system requests an OAuth 2.0 token from your authentication service and shares the token with HomePod speakers in the user’s home. API-Since: 14.0

    • Constructor Detail

      • MSSetupSession

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • account

        @NotNull
public @NotNull MSServiceAccount account()
        The streaming media service account for the session to configure.

      • allocWithZone

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

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithServiceAccount

        public MSSetupSession initWithServiceAccount​(@NotNull
                                             @NotNull MSServiceAccount serviceAccount)
        Creates a new session. - Parameters: - serviceAccount: The streaming media service account to set up on a HomePod. - Returns: Returns `true` if it successfully presents; otherwise, `false`. This method presents user with options to add a service to the home.

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

      • presentationContext

        @Nullable
public @Nullable MSAuthenticationPresentationContext presentationContext()
        A delegate that provides media setup display information to the system.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setPresentationContext_unsafe

        public void setPresentationContext_unsafe​(@Nullable
                                          @Nullable MSAuthenticationPresentationContext value)
        A delegate that provides media setup display information to the system.

      • setPresentationContext

        public void setPresentationContext​(@Nullable
                                   @Nullable MSAuthenticationPresentationContext value)
        A delegate that provides media setup display information to the system.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • startWithError

        public boolean startWithError​(@Nullable
                              @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Initiates the service configuration process. This method sends the account details of the streaming media service to the user’s HomePod speakers.

      • superclass_static

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

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.