SPTAppRemoteConnectionParams Class Reference

Inherits from NSObject
Declared in SPTAppRemoteConnectionParams.h

Overview

The SPTAppRemoteconnectionParams represents connection parameters required in order to initiate a connection with the Spotify app.

  clientIdentifier

A unique identifier for the client.

@property (nonatomic, copy, readonly) NSString *clientIdentifier

Discussion

The client key is used for authentication, and must be obtained from the Spotify developer portal.

Declared In

SPTAppRemoteConnectionParams.h

  redirectURI

The redirect URI for Spotify to open the client app after authentication.

@property (nonatomic, copy, readonly) NSString *redirectURI

Declared In

SPTAppRemoteConnectionParams.h

  name

The name of the consumer application.

@property (nonatomic, copy, readonly) NSString *name

Declared In

SPTAppRemoteConnectionParams.h

  accessToken

The access token used to authorize the user with the Spotify app.

@property (nonatomic, copy, readwrite, nullable) NSString *accessToken

Declared In

SPTAppRemoteConnectionParams.h

  defaultImageSize

The desired size of received images. (0,0) acts as a wildcard and accepts any size.

@property (nonatomic, assign, readonly) struct CGSize defaultImageSize

Declared In

SPTAppRemoteConnectionParams.h

  imageFormat

The desired image format of received images.

@property (nonatomic, assign, readonly) SPTAppRemoteConnectionParamsImageFormat imageFormat

Declared In

SPTAppRemoteConnectionParams.h

– initWithClientIdentifier:redirectURI:name:accessToken:defaultImageSize:imageFormat:

Initialize a set of new connection parameters.

- (instancetype)initWithClientIdentifier:(NSString *)clientIdentifier redirectURI:(NSString *)redirectURI name:(NSString *)name accessToken:(nullable NSString *)accessToken defaultImageSize:(struct CGSize)defaultImageSize imageFormat:(SPTAppRemoteConnectionParamsImageFormat)imageFormat

Parameters

clientIdentifier

The unique client key obtained from the Spotify developers website.

redirectURI

The redirect URI for Spotify to open the client app after authentication.

name

The name of the consumer application.

accessToken

The access token obtained after authentication.

defaultImageSize

The desired size of received images. (0,0) acts as a wildcard and accepts any size.

imageFormat

The desired image format of received images.

Return Value

A set of connection parameters ready to be used when initiating a connection to the Spotify app.

Discussion

This is the designated initializer.

Declared In

SPTAppRemoteConnectionParams.h

  protocolVersion

Version of the protocol

@property (nonatomic, assign, readonly) NSInteger protocolVersion

Declared In

SPTAppRemoteConnectionParams.h

  roles

Roles

@property (nonatomic, copy, readonly) NSDictionary *roles

Declared In

SPTAppRemoteConnectionParams.h

  authenticationMethods

Authentication methods supported

@property (nonatomic, copy, readonly) NSArray *authenticationMethods

Declared In

SPTAppRemoteConnectionParams.h