vs-mobiletools-engineering-service2/watchos-api-diff.md Secret

## watchos-api-diff.md

      
    Raw
  

              watchos-api-diff.md
            
          
  title
  description
  author
  ms.author
  ms.date
  ms.topic
  ms.assetid
  ms.prod
  
  
  Xamarin.WatchOS SDK API diff: 16.1.1 vs 16.5.0
  List of API changes between Xamarin.WatchOS versions 16.1.1 and 16.5.0.
  spouliot
  sepoulio
  6/21/2023
  article
  759425c8-137c-2ca2-72a7-77910ea06963
  xamarin
  
  
Xamarin.WatchOS SDK API diff: 16.1.1 vs 16.5.0


Xamarin.WatchOS.dll
Namespace AVFoundation

Type Changed: AVFoundation.AVAudioSession

Obsoleted properties:
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategoryAmbient { get; }
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategoryMultiRoute { get; }
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategoryPlayAndRecord { get; }
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategoryPlayback { get; }
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategoryRecord { get; }
 [Obsolete ("Use 'AVAudioSessionCategory' enum values instead.")]
 public static Foundation.NSString CategorySoloAmbient { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeDefault { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeGameChat { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeMeasurement { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeMoviePlayback { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeSpokenAudio { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeVideoChat { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeVideoRecording { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString ModeVoiceChat { get; }
 [Obsolete ("Use 'AVAudioSessionMode' enum values instead.")]
 public static Foundation.NSString VoicePrompt { get; }
Added methods:
public Foundation.NSError SetActive (bool active, AVAudioSessionSetActiveOptions options);
public bool SetCategory (AVAudioSessionCategory category, AVAudioSessionCategoryOptions options, out Foundation.NSError outError);
public Foundation.NSError SetCategory (AVAudioSessionCategory category, AVAudioSessionMode mode, AVAudioSessionCategoryOptions options);
public Foundation.NSError SetCategory (AVAudioSessionCategory category, string mode, AVAudioSessionCategoryOptions options);
public bool SetCategory (AVAudioSessionCategory category, AVAudioSessionMode mode, AVAudioSessionCategoryOptions options, out Foundation.NSError outError);
public bool SetCategory (AVAudioSessionCategory category, string mode, AVAudioSessionCategoryOptions options, out Foundation.NSError outError);
public bool SetCategory (AVAudioSessionCategory category, AVAudioSessionMode mode, AVAudioSessionRouteSharingPolicy policy, AVAudioSessionCategoryOptions options, out Foundation.NSError outError);
public bool SetCategory (AVAudioSessionCategory category, string mode, AVAudioSessionRouteSharingPolicy policy, AVAudioSessionCategoryOptions options, out Foundation.NSError outError);
public bool SetMode (AVAudioSessionMode mode, out Foundation.NSError error);
Type Changed: AVFoundation.AVAudioSinkNode

Obsoleted constructors:
 [Obsolete ("Use the overload that takes a delegate that does not take a 'ref AudioBuffers' instead. Assigning a value to the 'inputData' parameter in the callback has no effect.")]
 public AVAudioSinkNode (AVAudioSinkNodeReceiverHandler receiverHandler);
Added constructors:
public AVAudioSinkNode (AVAudioSinkNodeReceiverHandler2 receiverHandler);
public AVAudioSinkNode (AVAudioSinkNodeReceiverHandlerRaw receiverHandler);
Type Changed: AVFoundation.AVMetadata

Obsoleted properties:
 [Obsolete ("Use 'AVMetadataFormat' enum values.")]
 public static Foundation.NSString FormatHlsMetadata { get; }
 [Obsolete ("Use 'AVMetadataFormat' enum values.")]
 public static Foundation.NSString FormatID3Metadata { get; }
 [Obsolete ("Use 'AVMetadataFormat' enum values.")]
 public static Foundation.NSString FormatQuickTimeUserData { get; }
 [Obsolete ("Use 'AVMetadataFormat' enum values.")]
 public static Foundation.NSString FormatiTunesMetadata { get; }
 [Obsolete ("Use 'AVMetadataFormat' enum values.")]
 public static Foundation.NSString KFormatISOUserData { get; }
Type Changed: AVFoundation.AVPlayer

Obsoleted properties:
 [Obsolete ("Use 'AVPlayerWaitingReason' enum instead.")]
 public static Foundation.NSString WaitingDuringInterstitialEventReason { get; }
 [Obsolete ("Use 'AVPlayerWaitingReason' enum instead.")]
 public static Foundation.NSString WaitingToMinimizeStallsReason { get; }
 [Obsolete ("Use 'AVPlayerWaitingReason' enum instead.")]
 public static Foundation.NSString WaitingWhileEvaluatingBufferingRateReason { get; }
 [Obsolete ("Use 'AVPlayerWaitingReason' enum instead.")]
 public static Foundation.NSString WaitingWithNoItemToPlayReason { get; }
New Type: AVFoundation.AVAudioSessionCategoryExtensions

public static class AVAudioSessionCategoryExtensions {
	// methods
	public static Foundation.NSString GetConstant (this AVAudioSessionCategory self);
	public static AVAudioSessionCategory GetValue (Foundation.NSString constant);
}
New Type: AVFoundation.AVAudioSessionMode

[Serializable]
public enum AVAudioSessionMode {
	Default = 0,
	GameChat = 4,
	Measurement = 3,
	MoviePlayback = 5,
	SpokenAudio = 7,
	VideoChat = 6,
	VideoRecording = 2,
	VoiceChat = 1,
	VoicePrompt = 8,
}
New Type: AVFoundation.AVAudioSessionModeExtensions

public static class AVAudioSessionModeExtensions {
	// methods
	public static Foundation.NSString GetConstant (this AVAudioSessionMode self);
	public static AVAudioSessionMode GetValue (Foundation.NSString constant);
}
New Type: AVFoundation.AVAudioSinkNodeReceiverHandler2

public sealed delegate AVAudioSinkNodeReceiverHandler2 : System.MulticastDelegate {
	// constructors
	public AVAudioSinkNodeReceiverHandler2 (object object, IntPtr method);
	// methods
	public virtual System.IAsyncResult BeginInvoke (AudioToolbox.AudioTimeStamp timestamp, uint frameCount, AudioToolbox.AudioBuffers inputData, System.AsyncCallback callback, object object);
	public virtual int EndInvoke (System.IAsyncResult result);
	public virtual int Invoke (AudioToolbox.AudioTimeStamp timestamp, uint frameCount, AudioToolbox.AudioBuffers inputData);
}
New Type: AVFoundation.AVAudioSinkNodeReceiverHandlerRaw

public sealed delegate AVAudioSinkNodeReceiverHandlerRaw : System.MulticastDelegate {
	// constructors
	public AVAudioSinkNodeReceiverHandlerRaw (object object, IntPtr method);
	// methods
	public virtual System.IAsyncResult BeginInvoke (IntPtr timestamp, uint frameCount, IntPtr inputData, System.AsyncCallback callback, object object);
	public virtual int EndInvoke (System.IAsyncResult result);
	public virtual int Invoke (IntPtr timestamp, uint frameCount, IntPtr inputData);
}
Namespace CoreBluetooth

Type Changed: CoreBluetooth.CBCentralManager

Obsoleted properties:
 [Obsolete ("Use 'CBConnectPeripheralOptions' instead.")]
 public static Foundation.NSString OptionNotifyOnConnectionKey { get; }
 [Obsolete ("Use 'CBConnectPeripheralOptions' instead.")]
 public static Foundation.NSString OptionNotifyOnDisconnectionKey { get; }
 [Obsolete ("Use 'CBConnectPeripheralOptions' instead.")]
 public static Foundation.NSString OptionNotifyOnNotificationKey { get; }
Namespace CoreFoundation

Type Changed: CoreFoundation.CFRunLoop

Added properties:
public string[] AllModes { get; }
public string CurrentMode { get; }
Added method:
public CFRunLoopExitReason RunInMode (string mode, double seconds, bool returnAfterSourceHandled);
Type Changed: CoreFoundation.CFSocket

Added properties:
public System.Net.IPEndPoint Address { get; }
public System.Net.IPEndPoint RemoteAddress { get; }
Added method:
public void Invalidate ();
Namespace CoreGraphics

Type Changed: CoreGraphics.CGImagePropertiesGps

Added properties:
public string LatitudeRef { get; set; }
public string LongitudeRef { get; set; }
Namespace Foundation

Type Changed: Foundation.NSAttributedString

Obsoleted methods:
 [Obsolete ("Use 'GetData' instead.")]
 public NSData GetDataFromRange (NSRange range, NSAttributedStringDocumentAttributes documentAttributes, ref NSError error);
 [Obsolete ("Use 'GetData' instead.")]
 public virtual NSData GetDataFromRange (NSRange range, NSDictionary attributes, ref NSError error);
 [Obsolete ("Use 'GetFileWrapper' instead.")]
 public NSFileWrapper GetFileWrapperFromRange (NSRange range, NSAttributedStringDocumentAttributes documentAttributes, ref NSError error);
 [Obsolete ("Use 'GetFileWrapper' instead.")]
 public virtual NSFileWrapper GetFileWrapperFromRange (NSRange range, NSDictionary attributes, ref NSError error);
Added methods:
public NSData GetData (NSRange range, NSAttributedStringDocumentAttributes options, out NSError error);
public NSData GetData (NSRange range, NSDictionary options, out NSError error);
public NSFileWrapper GetFileWrapper (NSRange range, NSAttributedStringDocumentAttributes options, out NSError error);
public NSFileWrapper GetFileWrapper (NSRange range, NSDictionary options, out NSError error);
Type Changed: Foundation.NSBundle

Obsoleted properties:
 [Obsolete ("Use the 'AllBundles' property instead.")]
 public static NSBundle[] _AllBundles { get; }
Added property:
public static NSBundle[] AllBundles { get; }
Type Changed: Foundation.NSItemProvider

Added methods:
public NSProgress LoadObject<T> (System.Action<T,Foundation.NSError> completionHandler);
public System.Threading.Tasks.Task<T> LoadObjectAsync<T> ();
public System.Threading.Tasks.Task<T> LoadObjectAsync<T> (out NSProgress result);
Type Changed: Foundation.NSKeyValueObservingOptions

Added value:
None = 0,
Type Changed: Foundation.NSOperatingSystemVersion

Added constructors:
public NSOperatingSystemVersion (nint major);
public NSOperatingSystemVersion (nint major, nint minor);
Added interfaces:
System.IComparable
System.IEquatable<NSOperatingSystemVersion>
Added methods:
public int CompareTo (NSOperatingSystemVersion otherVersion);
public virtual int CompareTo (object obj);
public virtual bool Equals (NSOperatingSystemVersion other);
public override bool Equals (object obj);
public override int GetHashCode ();
public static bool op_Equality (NSOperatingSystemVersion os1, NSOperatingSystemVersion os2);
public static bool op_Inequality (NSOperatingSystemVersion os1, NSOperatingSystemVersion os2);
Type Changed: Foundation.NSRunLoop

Obsoleted properties:
 [Obsolete ("Use the 'NSRunLoopMode' enum instead.")]
 public static NSString NSDefaultRunLoopMode { get; }
 [Obsolete ("Use the 'NSRunLoopMode' enum instead.")]
 public static NSString NSRunLoopCommonModes { get; }
Type Changed: Foundation.NSUrl

Added properties:
public static NSString FileIdentifierKey { get; }
public static NSString VolumeMountFromLocationKey { get; }
public static NSString VolumeSubtypeKey { get; }
public static NSString VolumeTypeNameKey { get; }
Added methods:
public static NSUrl CreateFileUrl (string path);
public static NSUrl CreateFileUrl (string path, bool isDir);
Type Changed: Foundation.NSValue

Added property:
public virtual CoreMedia.CMVideoDimensions CMVideoDimensionsValue { get; }
Added method:
public static NSValue FromCMVideoDimensions (CoreMedia.CMVideoDimensions value);
Namespace HealthKit

Type Changed: HealthKit.HKClinicalTypeIdentifier

Added value:
ClinicalNoteRecord = 8,
Type Changed: HealthKit.HKContactsPrescription

Added interfaces:
Foundation.INSCoding
Foundation.INSCopying
Foundation.INSSecureCoding
ObjCRuntime.INativeObject
System.IDisposable
Added methods:
public virtual Foundation.NSObject Copy (Foundation.NSZone zone);
public virtual void EncodeTo (Foundation.NSCoder encoder);
Type Changed: HealthKit.HKGlassesPrescription

Added interfaces:
Foundation.INSCoding
Foundation.INSCopying
Foundation.INSSecureCoding
ObjCRuntime.INativeObject
System.IDisposable
Added methods:
public virtual Foundation.NSObject Copy (Foundation.NSZone zone);
public virtual void EncodeTo (Foundation.NSCoder encoder);
Type Changed: HealthKit.HKMetadataKey

Added property:
public static Foundation.NSString HeadphoneGain { get; }
Type Changed: HealthKit.HKVisionPrescription

Added interfaces:
Foundation.INSCoding
Foundation.INSCopying
Foundation.INSSecureCoding
ObjCRuntime.INativeObject
System.IDisposable
Added methods:
public virtual Foundation.NSObject Copy (Foundation.NSZone zone);
public virtual void EncodeTo (Foundation.NSCoder encoder);
Type Changed: HealthKit.HKWorkoutActivity

Added constructor:
public HKWorkoutActivity (Foundation.NSCoder coder);
Added interfaces:
Foundation.INSCoding
Foundation.INSCopying
Foundation.INSSecureCoding
ObjCRuntime.INativeObject
System.IDisposable
Added methods:
public virtual Foundation.NSObject Copy (Foundation.NSZone zone);
public virtual void EncodeTo (Foundation.NSCoder encoder);
Namespace HomeKit

Type Changed: HomeKit.HMTimerTrigger

Added constructor:
public HMTimerTrigger (string name, Foundation.NSDate fireDate, Foundation.NSDateComponents recurrence);
Namespace ImageIO

Type Changed: ImageIO.CGImageProperties

Added property:
public static Foundation.NSString OpenExrCompression { get; }
Namespace Intents

Type Changed: Intents.INIntentIdentifier

Added values:
AnswerCall = 26,
HangUpCall = 27,
New Type: Intents.IINAnswerCallIntentHandling

public interface IINAnswerCallIntentHandling : ObjCRuntime.INativeObject, System.IDisposable {
	// methods
	public virtual void HandleAnswerCall (INAnswerCallIntent intent, System.Action<INAnswerCallIntentResponse> completion);
}
New Type: Intents.IINHangUpCallIntentHandling

public interface IINHangUpCallIntentHandling : ObjCRuntime.INativeObject, System.IDisposable {
	// methods
	public virtual void HandleHangUpCall (INHangUpCallIntent intent, System.Action<INHangUpCallIntentResponse> completion);
}
New Type: Intents.INAnswerCallIntent

public class INAnswerCallIntent : Intents.INIntent {
	// constructors
	public INAnswerCallIntent ();
	public INAnswerCallIntent (Foundation.NSCoder coder);
	protected INAnswerCallIntent (Foundation.NSObjectFlag t);
	protected INAnswerCallIntent (IntPtr handle);
	public INAnswerCallIntent (INCallAudioRoute audioRoute, string callIdentifier);
	// properties
	public virtual INCallAudioRoute AudioRoute { get; }
	public virtual string CallIdentifier { get; }
	public override IntPtr ClassHandle { get; }
}
New Type: Intents.INAnswerCallIntentHandling_Extensions

public static class INAnswerCallIntentHandling_Extensions {
	// methods
	public static void ConfirmAnswerCall (this IINAnswerCallIntentHandling This, INAnswerCallIntent intent, System.Action<INAnswerCallIntentResponse> completion);
}
New Type: Intents.INAnswerCallIntentResponse

public class INAnswerCallIntentResponse : Intents.INIntentResponse {
	// constructors
	public INAnswerCallIntentResponse (Foundation.NSCoder coder);
	protected INAnswerCallIntentResponse (Foundation.NSObjectFlag t);
	protected INAnswerCallIntentResponse (IntPtr handle);
	public INAnswerCallIntentResponse (INAnswerCallIntentResponseCode code, Foundation.NSUserActivity userActivity);
	// properties
	public virtual INCallRecord[] CallRecords { get; set; }
	public override IntPtr ClassHandle { get; }
	public virtual INAnswerCallIntentResponseCode Code { get; }
}
New Type: Intents.INAnswerCallIntentResponseCode

[Serializable]
public enum INAnswerCallIntentResponseCode {
	ContinueInApp = 2,
	Failure = 5,
	FailureRequiringAppLaunch = 6,
	InProgress = 3,
	Ready = 1,
	Success = 4,
	Unspecified = 0,
}
New Type: Intents.INHangUpCallIntent

public class INHangUpCallIntent : Intents.INIntent {
	// constructors
	public INHangUpCallIntent ();
	public INHangUpCallIntent (Foundation.NSCoder coder);
	protected INHangUpCallIntent (Foundation.NSObjectFlag t);
	protected INHangUpCallIntent (IntPtr handle);
	public INHangUpCallIntent (string callIdentifier);
	// properties
	public virtual string CallIdentifier { get; }
	public override IntPtr ClassHandle { get; }
}
New Type: Intents.INHangUpCallIntentHandling_Extensions

public static class INHangUpCallIntentHandling_Extensions {
	// methods
	public static void ConfirmHangUpCall (this IINHangUpCallIntentHandling This, INHangUpCallIntent intent, System.Action<INHangUpCallIntentResponse> completion);
}
New Type: Intents.INHangUpCallIntentResponse

public class INHangUpCallIntentResponse : Intents.INIntentResponse {
	// constructors
	public INHangUpCallIntentResponse (Foundation.NSCoder coder);
	protected INHangUpCallIntentResponse (Foundation.NSObjectFlag t);
	protected INHangUpCallIntentResponse (IntPtr handle);
	public INHangUpCallIntentResponse (INHangUpCallIntentResponseCode code, Foundation.NSUserActivity userActivity);
	// properties
	public override IntPtr ClassHandle { get; }
	public virtual INHangUpCallIntentResponseCode Code { get; }
}
New Type: Intents.INHangUpCallIntentResponseCode

[Serializable]
public enum INHangUpCallIntentResponseCode {
	Failure = 4,
	FailureNoCallToHangUp = 6,
	FailureRequiringAppLaunch = 5,
	InProgress = 2,
	Ready = 1,
	Success = 3,
	Unspecified = 0,
}
Namespace Network

Type Changed: Network.NWDataTransferReport

Obsoleted methods:
 [Obsolete ("Use the 'GetPathRadioType' property instead.")]
 public NWInterfaceRadioType get_path_radio_type (uint pathIndex);
Added method:
public NWInterfaceRadioType GetPathRadioType (uint pathIndex);
Type Changed: Network.NWQuicStreamType

Added value:
Datagram = 3,
Namespace ObjCRuntime

Type Changed: ObjCRuntime.BlockLiteral

Added interface:
System.IDisposable
Added property:
public object Context { get; }
Added method:
public virtual void Dispose ();
Type Changed: ObjCRuntime.Constants

Modified fields:
-public const string SdkVersion = "9.1";
+public const string SdkVersion = "9.4";
-public const string Version = "16.1.1";
+public const string Version = "16.5.0";
Namespace PassKit

Type Changed: PassKit.PKPaymentNetwork

Added property:
public static Foundation.NSString PKPaymentNetworkPostFinance { get; }
Namespace SceneKit

Type Changed: SceneKit.SCNHitTest

Obsoleted properties:
 [Obsolete ("Use 'SearchModeKey' instead.")]
 public static Foundation.NSString OptionSearchModeKey { get; }
Namespace System.Net.Http

Type Changed: System.Net.Http.NSUrlSessionHandler

Obsoleted properties:
 [Obsolete ("This property will be ignored in .NET 8.")]
 public bool BypassBackgroundSessionCheck { get; set; }
Namespace UIKit

Type Changed: UIKit.UIFont

Obsoleted properties:
 [Obsolete ("Use the 'XHeight' property instead.")]
 public virtual nfloat xHeight { get; }
Added property:
public virtual nfloat XHeight { get; }
New Type: UIKit.UIFontWeightConstants

public static class UIFontWeightConstants {
	// properties
	public static nfloat Black { get; }
	public static nfloat Bold { get; }
	public static nfloat Heavy { get; }
	public static nfloat Light { get; }
	public static nfloat Medium { get; }
	public static nfloat Regular { get; }
	public static nfloat Semibold { get; }
	public static nfloat Thin { get; }
	public static nfloat UltraLight { get; }
}
New Type: UIKit.UIFontWeightExtensions

public static class UIFontWeightExtensions {
	// methods
	public static nfloat GetWeight (this UIFontWeight weight);
}