com.apple.android.sdk.authentication

Class AuthIntentBuilder

java.lang.Object

com.apple.android.sdk.authentication.AuthIntentBuilder

public class AuthIntentBuilder
extends Object

Utility class to help create an Intent to start the music kit authentication flow.

Constructor Summary

Constructors

Constructor and Description
AuthIntentBuilder(Context context, String developerToken) Creates an instance of the AuthIntentBuilder.

Method Summary

Modifier and Type	Method and Description
Intent	build() Returns the intent which can be used to start the music kit authentication flow.
AuthIntentBuilder	setContextId(String contextId) Set the id of an album/playlist/song to give more context to the upsell that will display after deeplinking to Apple Music.
AuthIntentBuilder	setCustomParams(HashMap<String,String> params) Set dictionary with affiliate/campaign parameters if any to be passed to Apple Music.
AuthIntentBuilder	setHideStartScreen(boolean hideStartScreen) Set hideStartScreen to true to hide the authentication-flow-starting-activity and deeplink directly to Apple Music.
AuthIntentBuilder	setStartScreenMessage(String startScreenMessage) Sets the message to display in authentication-flow-starting-activity.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthIntentBuilder

public AuthIntentBuilder(Context context,
                         String developerToken)

Creates an instance of the AuthIntentBuilder.

Parameters:

context - Context

developerToken - String: the developer token

Method Detail

build

public Intent build()

Returns the intent which can be used to start the music kit authentication flow.

Returns:

Intent: the intent which can be used to start the authentication flow

setContextId

public AuthIntentBuilder setContextId(String contextId)

Set the id of an album/playlist/song to give more context to the upsell that will display after deeplinking to Apple Music. If a valid id is used, the artwork of the item will be displayed. If not set, a generic upsell will be used.

Parameters:

contextId - String: the id of the album, playlist, song etc to set the relevant context for the upsell.

Returns:

AuthIntentBuilder\: the current AuthIntentBuilder instance

setCustomParams

public AuthIntentBuilder setCustomParams(HashMap<String,String> params)

Set dictionary with affiliate/campaign parameters if any to be passed to Apple Music.

Parameters:

params - HashMap: dictionary of params to set

Returns:

AuthIntentBuilder: the current AuthIntentBuilder instance

setHideStartScreen

public AuthIntentBuilder setHideStartScreen(boolean hideStartScreen)

Set hideStartScreen to true to hide the authentication-flow-starting-activity and deeplink directly to Apple Music. The authentication-flow-starting-activity displays by default.

Parameters:

hideStartScreen - boolean: if set opts out of the connect prompt screen

Returns:

AuthIntentBuilder: the current AuthIntentBuilder instance

setStartScreenMessage

public AuthIntentBuilder setStartScreenMessage(String startScreenMessage)

Sets the message to display in authentication-flow-starting-activity. If not set, a default localized text will be used.

Parameters:

startScreenMessage - String: text to set the authentication-flow-starting-screen message to.

Returns:

AuthIntentBuilder: the current AuthIntentBuilder instance