Merge pull request #423 from jalopezcar/release_v2.1.0

Spotify iOS SDK v2.1.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Spotify iOS SDK v2.1.0
+What's New:
+- Expanded existing API with campaign parameter to allow consumers to specify details about where the auth flow was initiated
+
 ## Spotify iOS SDK v2.0.1
 
 What's New:

SpotifyiOS.framework/Headers/SPTSessionManager.h

@@ -44,26 +44,16 @@ typedef NSString * const SPTAuthorizationCode;
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
- Initiate the authorization process on iOS 11 and later.
+ Initiate the authorization process
 
  @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
  @param options Options bitmask that informs authorization behavior.
- See `SPTSessionManagerDelegate` for messages regarding changes in session state.
- */
-- (void)initiateSessionWithScope:(SPTScope)scope
-                         options:(SPTAuthorizationOptions)options NS_AVAILABLE_IOS(11_0);
-
-/**
- Initiate the authorization process on iOS versions < 11.
-
- @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
- @param options Options bitmask that informs authorization behavior.
- @param presentingViewController The `UIViewController` to present the login `SFSafariViewController` on
+ @param campaign The campaign identifier, to help attribute where the account linking was initiated from.
  See `SPTSessionManagerDelegate` for messages regarding changes in session state.
  */
 - (void)initiateSessionWithScope:(SPTScope)scope
                          options:(SPTAuthorizationOptions)options
-        presentingViewController: (UIViewController *)presentingViewController NS_DEPRECATED_IOS(9_0, 11_0);
+                        campaign:(nullable NSString *)campaign;
 
 /// Attempt to renew the access token, using the refresh token in the current `SPTSession` which must be valid.
 - (void)renewSession;

SpotifyiOS.framework/Versions/A/Headers/SPTSessionManager.h

@@ -44,26 +44,16 @@ typedef NSString * const SPTAuthorizationCode;
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
- Initiate the authorization process on iOS 11 and later.
+ Initiate the authorization process
 
  @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
  @param options Options bitmask that informs authorization behavior.
- See `SPTSessionManagerDelegate` for messages regarding changes in session state.
- */
-- (void)initiateSessionWithScope:(SPTScope)scope
-                         options:(SPTAuthorizationOptions)options NS_AVAILABLE_IOS(11_0);
-
-/**
- Initiate the authorization process on iOS versions < 11.
-
- @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
- @param options Options bitmask that informs authorization behavior.
- @param presentingViewController The `UIViewController` to present the login `SFSafariViewController` on
+ @param campaign The campaign identifier, to help attribute where the account linking was initiated from.
  See `SPTSessionManagerDelegate` for messages regarding changes in session state.
  */
 - (void)initiateSessionWithScope:(SPTScope)scope
                          options:(SPTAuthorizationOptions)options
-        presentingViewController: (UIViewController *)presentingViewController NS_DEPRECATED_IOS(9_0, 11_0);
+                        campaign:(nullable NSString *)campaign;
 
 /// Attempt to renew the access token, using the refresh token in the current `SPTSession` which must be valid.
 - (void)renewSession;

SpotifyiOS.framework/Versions/Current/Headers/SPTSessionManager.h

@@ -44,26 +44,16 @@ typedef NSString * const SPTAuthorizationCode;
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
- Initiate the authorization process on iOS 11 and later.
+ Initiate the authorization process
 
  @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
  @param options Options bitmask that informs authorization behavior.
- See `SPTSessionManagerDelegate` for messages regarding changes in session state.
- */
-- (void)initiateSessionWithScope:(SPTScope)scope
-                         options:(SPTAuthorizationOptions)options NS_AVAILABLE_IOS(11_0);
-
-/**
- Initiate the authorization process on iOS versions < 11.
-
- @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
- @param options Options bitmask that informs authorization behavior.
- @param presentingViewController The `UIViewController` to present the login `SFSafariViewController` on
+ @param campaign The campaign identifier, to help attribute where the account linking was initiated from.
  See `SPTSessionManagerDelegate` for messages regarding changes in session state.
  */
 - (void)initiateSessionWithScope:(SPTScope)scope
                          options:(SPTAuthorizationOptions)options
-        presentingViewController: (UIViewController *)presentingViewController NS_DEPRECATED_IOS(9_0, 11_0);
+                        campaign:(nullable NSString *)campaign;
 
 /// Attempt to renew the access token, using the refresh token in the current `SPTSession` which must be valid.
 - (void)renewSession;

SpotifyiOS.xcframework/Info.plist

@@ -8,32 +8,32 @@
 			<key>BinaryPath</key>
 			<string>SpotifyiOS.framework/SpotifyiOS</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>SpotifyiOS.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>SpotifyiOS.framework/SpotifyiOS</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>SpotifyiOS.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

SpotifyiOS.xcframework/ios-arm64/SpotifyiOS.framework/Headers/SPTSessionManager.h

@@ -44,26 +44,16 @@ typedef NSString * const SPTAuthorizationCode;
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
- Initiate the authorization process on iOS 11 and later.
+ Initiate the authorization process
 
  @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
  @param options Options bitmask that informs authorization behavior.
- See `SPTSessionManagerDelegate` for messages regarding changes in session state.
- */
-- (void)initiateSessionWithScope:(SPTScope)scope
-                         options:(SPTAuthorizationOptions)options NS_AVAILABLE_IOS(11_0);
-
-/**
- Initiate the authorization process on iOS versions < 11.
-
- @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
- @param options Options bitmask that informs authorization behavior.
- @param presentingViewController The `UIViewController` to present the login `SFSafariViewController` on
+ @param campaign The campaign identifier, to help attribute where the account linking was initiated from.
  See `SPTSessionManagerDelegate` for messages regarding changes in session state.
  */
 - (void)initiateSessionWithScope:(SPTScope)scope
                          options:(SPTAuthorizationOptions)options
-        presentingViewController: (UIViewController *)presentingViewController NS_DEPRECATED_IOS(9_0, 11_0);
+                        campaign:(nullable NSString *)campaign;
 
 /// Attempt to renew the access token, using the refresh token in the current `SPTSession` which must be valid.
 - (void)renewSession;

SpotifyiOS.xcframework/ios-arm64_x86_64-simulator/SpotifyiOS.framework/Headers/SPTSessionManager.h

@@ -44,26 +44,16 @@ typedef NSString * const SPTAuthorizationCode;
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
- Initiate the authorization process on iOS 11 and later.
+ Initiate the authorization process
 
  @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
  @param options Options bitmask that informs authorization behavior.
- See `SPTSessionManagerDelegate` for messages regarding changes in session state.
- */
-- (void)initiateSessionWithScope:(SPTScope)scope
-                         options:(SPTAuthorizationOptions)options NS_AVAILABLE_IOS(11_0);
-
-/**
- Initiate the authorization process on iOS versions < 11.
-
- @param scope The scope to request, e.g. `SPTPlaylistReadPrivateScope`|`SPTUserReadEmailScope` if you wish to request read access to private playlists, and read access to the user's email address.
- @param options Options bitmask that informs authorization behavior.
- @param presentingViewController The `UIViewController` to present the login `SFSafariViewController` on
+ @param campaign The campaign identifier, to help attribute where the account linking was initiated from.
  See `SPTSessionManagerDelegate` for messages regarding changes in session state.
  */
 - (void)initiateSessionWithScope:(SPTScope)scope
                          options:(SPTAuthorizationOptions)options
-        presentingViewController: (UIViewController *)presentingViewController NS_DEPRECATED_IOS(9_0, 11_0);
+                        campaign:(nullable NSString *)campaign;
 
 /// Attempt to renew the access token, using the refresh token in the current `SPTSession` which must be valid.
 - (void)renewSession;

SpotifyiOS.xcframework/ios-arm64_x86_64-simulator/SpotifyiOS.framework/_CodeSignature/CodeResources

@@ -114,7 +114,7 @@
 		</data>
 		<key>Headers/SPTSessionManager.h</key>
 		<data>
-		evF+aCKdg+ryTNUXk5Eik/6MNOk=
+		SBxEZidPSxu0kqTbIjqSsm5a77Y=
 		</data>
 		<key>Headers/SpotifyAppRemote.h</key>
 		<data>
@@ -126,7 +126,7 @@
 		</data>
 		<key>Info.plist</key>
 		<data>
-		/v/AhOv6QcQ/6v7/aN8A5Rxcjck=
+		dIQEPuwCF05rSz5+JYQt/ZYEQ/8=
 		</data>
 		<key>Modules/module.modulemap</key>
 		<data>
@@ -332,7 +332,7 @@
 		<dict>
 			<key>hash2</key>
 			<data>
-			p/WBdGNx2Obgjj9TAAjhS6QP/j80z8ShuFmr6uQdNZA=
+			Wldpc0wHvSO51aH3GNEzkjoNiJ6dahRIY18k3tOBxbY=
 			</data>
 		</dict>
 		<key>Headers/SpotifyAppRemote.h</key>

docs/html/Blocks/SPTAppRemoteCallback.html

@@ -112,7 +112,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTAppRemote.html

@@ -1300,7 +1300,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTAppRemoteConnectionParams.html

@@ -462,7 +462,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTConfiguration.html

@@ -538,7 +538,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTError.html

@@ -105,7 +105,7 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTSession.html

@@ -343,7 +343,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

docs/html/Classes/SPTSessionManager.html

@@ -76,9 +76,7 @@ <h1 id="library-title">
 
 		<option value="//api/name/initWithConfiguration:delegate:">- initWithConfiguration:delegate:</option>
 
-		<option value="//api/name/initiateSessionWithScope:options:">- initiateSessionWithScope:options:</option>
-
-		<option value="//api/name/initiateSessionWithScope:options:presentingViewController:">- initiateSessionWithScope:options:presentingViewController:</option>
+		<option value="//api/name/initiateSessionWithScope:options:campaign:">- initiateSessionWithScope:options:campaign:</option>
 
 		<option value="//api/name/renewSession">- renewSession</option>
 
@@ -303,67 +301,8 @@ <h4 class="method-subtitle">Declared In</h4>
 		</div>
 	</div>
 </div><div class="section-method">
-	<a name="//api/name/initiateSessionWithScope:options:" title="initiateSessionWithScope:options:"></a>
-	<h3 class="method-title"><code><a href="#//api/name/initiateSessionWithScope:options:">&ndash;&nbsp;initiateSessionWithScope:options:</a></code>
-</h3>
-
-	<div class="method-info">
-		<div class="pointy-thing"></div>
-
-		<div class="method-info-container">
-
-
-			<div class="method-subsection brief-description">
-				<p>Initiate the authorization process on iOS 11 and later.</p>
-			</div>
-
-
-
-			<div class="method-subsection method-declaration"><code>- (void)initiateSessionWithScope:(SPTScope)<em>scope</em> options:(SPTAuthorizationOptions)<em>options</em></code></div>
-
-
-
-			<div class="method-subsection arguments-section parameters">
-				<h4 class="method-subtitle parameter-title">Parameters</h4>
-				<table class="argument-def parameter-def">
-
-					<tr>
-						<th scope="row" class="argument-name"><code>scope</code></th>
-						<td><p>The scope to request, e.g. <code>SPTPlaylistReadPrivateScope</code>|<code>SPTUserReadEmailScope</code> if you wish to request read access to private playlists, and read access to the user&rsquo;s email address.</p></td>
-					</tr>
-
-					<tr>
-						<th scope="row" class="argument-name"><code>options</code></th>
-						<td><p>Options bitmask that informs authorization behavior.
-See <a href="../Protocols/SPTSessionManagerDelegate.html"><code>SPTSessionManagerDelegate</code></a> for messages regarding changes in <a href="#//api/name/session">session</a> state.</p></td>
-					</tr>
-
-				</table>
-			</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-			<div class="method-subsection declared-in-section">
-				<h4 class="method-subtitle">Declared In</h4>
-				<p><code class="declared-in-ref">SPTSessionManager.h</code></p>
-			</div>
-
-
-		</div>
-	</div>
-</div><div class="section-method">
-	<a name="//api/name/initiateSessionWithScope:options:presentingViewController:" title="initiateSessionWithScope:options:presentingViewController:"></a>
-	<h3 class="method-title"><code><a href="#//api/name/initiateSessionWithScope:options:presentingViewController:">&ndash;&nbsp;initiateSessionWithScope:options:presentingViewController:</a></code>
+	<a name="//api/name/initiateSessionWithScope:options:campaign:" title="initiateSessionWithScope:options:campaign:"></a>
+	<h3 class="method-title"><code><a href="#//api/name/initiateSessionWithScope:options:campaign:">&ndash;&nbsp;initiateSessionWithScope:options:campaign:</a></code>
 </h3>
 
 	<div class="method-info">
@@ -373,12 +312,12 @@ <h3 class="method-title"><code><a href="#//api/name/initiateSessionWithScope:opt
 
 
 			<div class="method-subsection brief-description">
-				<p>Initiate the authorization process on iOS versions &lt; 11.</p>
+				<p>Initiate the authorization process</p>
 			</div>
 
 
 
-			<div class="method-subsection method-declaration"><code>- (void)initiateSessionWithScope:(SPTScope)<em>scope</em> options:(SPTAuthorizationOptions)<em>options</em> presentingViewController:(UIViewController *)<em>presentingViewController</em></code></div>
+			<div class="method-subsection method-declaration"><code>- (void)initiateSessionWithScope:(SPTScope)<em>scope</em> options:(SPTAuthorizationOptions)<em>options</em> campaign:(nullable NSString *)<em>campaign</em></code></div>
 
 
 
@@ -397,8 +336,8 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
 					</tr>
 
 					<tr>
-						<th scope="row" class="argument-name"><code>presentingViewController</code></th>
-						<td><p>The <code>UIViewController</code> to present the login <code>SFSafariViewController</code> on
+						<th scope="row" class="argument-name"><code>campaign</code></th>
+						<td><p>The campaign identifier, to help attribute where the account linking was initiated from.
 See <a href="../Protocols/SPTSessionManagerDelegate.html"><code>SPTSessionManagerDelegate</code></a> for messages regarding changes in <a href="#//api/name/session">session</a> state.</p></td>
 					</tr>
 
@@ -612,7 +551,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-05-10</p>
+						<p class="copyright">Copyright &copy; 2024 Spotify. All rights reserved. Updated: 2024-06-07</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>